Add note about bundled protos not needing import SwiftProtobuf.

apple · Dec 11, 2023 · 917c687 · 917c687
1 parent 4ac8a2e
commit 917c687
Show file tree

Hide file tree

Showing 34 changed files with 36 additions and 3 deletions.
diff --git a/Reference/SwiftProtobuf/google/protobuf/any.pb.swift b/Reference/SwiftProtobuf/google/protobuf/any.pb.swift
@@ -38,6 +38,7 @@
 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 import Foundation
+// 'import SwiftProtobuf' suppressed, this proto file is meant to be bundled in the runtime.
 
 // If the compiler emits an error on this type, it is because this file
 // was generated by a version of the `protoc` Swift plug-in that is

diff --git a/Reference/SwiftProtobuf/google/protobuf/api.pb.swift b/Reference/SwiftProtobuf/google/protobuf/api.pb.swift
@@ -38,6 +38,7 @@
 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 import Foundation
+// 'import SwiftProtobuf' suppressed, this proto file is meant to be bundled in the runtime.
 
 // If the compiler emits an error on this type, it is because this file
 // was generated by a version of the `protoc` Swift plug-in that is

diff --git a/Reference/SwiftProtobuf/google/protobuf/descriptor.pb.swift b/Reference/SwiftProtobuf/google/protobuf/descriptor.pb.swift
@@ -46,6 +46,7 @@
 // without any other information (e.g. without reading its imports).
 
 import Foundation
+// 'import SwiftProtobuf' suppressed, this proto file is meant to be bundled in the runtime.
 
 // If the compiler emits an error on this type, it is because this file
 // was generated by a version of the `protoc` Swift plug-in that is

diff --git a/Reference/SwiftProtobuf/google/protobuf/duration.pb.swift b/Reference/SwiftProtobuf/google/protobuf/duration.pb.swift
@@ -38,6 +38,7 @@
 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 import Foundation
+// 'import SwiftProtobuf' suppressed, this proto file is meant to be bundled in the runtime.
 
 // If the compiler emits an error on this type, it is because this file
 // was generated by a version of the `protoc` Swift plug-in that is

diff --git a/Reference/SwiftProtobuf/google/protobuf/empty.pb.swift b/Reference/SwiftProtobuf/google/protobuf/empty.pb.swift
@@ -38,6 +38,7 @@
 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 import Foundation
+// 'import SwiftProtobuf' suppressed, this proto file is meant to be bundled in the runtime.
 
 // If the compiler emits an error on this type, it is because this file
 // was generated by a version of the `protoc` Swift plug-in that is

diff --git a/Reference/SwiftProtobuf/google/protobuf/field_mask.pb.swift b/Reference/SwiftProtobuf/google/protobuf/field_mask.pb.swift
@@ -38,6 +38,7 @@
 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 import Foundation
+// 'import SwiftProtobuf' suppressed, this proto file is meant to be bundled in the runtime.
 
 // If the compiler emits an error on this type, it is because this file
 // was generated by a version of the `protoc` Swift plug-in that is

diff --git a/Reference/SwiftProtobuf/google/protobuf/source_context.pb.swift b/Reference/SwiftProtobuf/google/protobuf/source_context.pb.swift
@@ -38,6 +38,7 @@
 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 import Foundation
+// 'import SwiftProtobuf' suppressed, this proto file is meant to be bundled in the runtime.
 
 // If the compiler emits an error on this type, it is because this file
 // was generated by a version of the `protoc` Swift plug-in that is

diff --git a/Reference/SwiftProtobuf/google/protobuf/struct.pb.swift b/Reference/SwiftProtobuf/google/protobuf/struct.pb.swift
@@ -38,6 +38,7 @@
 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 import Foundation
+// 'import SwiftProtobuf' suppressed, this proto file is meant to be bundled in the runtime.
 
 // If the compiler emits an error on this type, it is because this file
 // was generated by a version of the `protoc` Swift plug-in that is

diff --git a/Reference/SwiftProtobuf/google/protobuf/timestamp.pb.swift b/Reference/SwiftProtobuf/google/protobuf/timestamp.pb.swift
@@ -38,6 +38,7 @@
 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 import Foundation
+// 'import SwiftProtobuf' suppressed, this proto file is meant to be bundled in the runtime.
 
 // If the compiler emits an error on this type, it is because this file
 // was generated by a version of the `protoc` Swift plug-in that is

diff --git a/Reference/SwiftProtobuf/google/protobuf/type.pb.swift b/Reference/SwiftProtobuf/google/protobuf/type.pb.swift
@@ -38,6 +38,7 @@
 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 import Foundation
+// 'import SwiftProtobuf' suppressed, this proto file is meant to be bundled in the runtime.
 
 // If the compiler emits an error on this type, it is because this file
 // was generated by a version of the `protoc` Swift plug-in that is

diff --git a/Reference/SwiftProtobuf/google/protobuf/wrappers.pb.swift b/Reference/SwiftProtobuf/google/protobuf/wrappers.pb.swift
@@ -48,6 +48,7 @@
 // individual entries of a map or fields of a oneof can already detect presence.
 
 import Foundation
+// 'import SwiftProtobuf' suppressed, this proto file is meant to be bundled in the runtime.
 
 // If the compiler emits an error on this type, it is because this file
 // was generated by a version of the `protoc` Swift plug-in that is

diff --git a/Reference/upstream/google/protobuf/any.pb.swift b/Reference/upstream/google/protobuf/any.pb.swift
@@ -38,6 +38,7 @@
 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 import Foundation
+// 'import SwiftProtobuf' suppressed, this proto file is meant to be bundled in the runtime.
 
 // If the compiler emits an error on this type, it is because this file
 // was generated by a version of the `protoc` Swift plug-in that is

diff --git a/Reference/upstream/google/protobuf/api.pb.swift b/Reference/upstream/google/protobuf/api.pb.swift
@@ -38,6 +38,7 @@
 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 import Foundation
+// 'import SwiftProtobuf' suppressed, this proto file is meant to be bundled in the runtime.
 
 // If the compiler emits an error on this type, it is because this file
 // was generated by a version of the `protoc` Swift plug-in that is

diff --git a/Reference/upstream/google/protobuf/descriptor.pb.swift b/Reference/upstream/google/protobuf/descriptor.pb.swift
@@ -46,6 +46,7 @@
 // without any other information (e.g. without reading its imports).
 
 import Foundation
+// 'import SwiftProtobuf' suppressed, this proto file is meant to be bundled in the runtime.
 
 // If the compiler emits an error on this type, it is because this file
 // was generated by a version of the `protoc` Swift plug-in that is

diff --git a/Reference/upstream/google/protobuf/duration.pb.swift b/Reference/upstream/google/protobuf/duration.pb.swift
@@ -38,6 +38,7 @@
 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 import Foundation
+// 'import SwiftProtobuf' suppressed, this proto file is meant to be bundled in the runtime.
 
 // If the compiler emits an error on this type, it is because this file
 // was generated by a version of the `protoc` Swift plug-in that is

diff --git a/Reference/upstream/google/protobuf/empty.pb.swift b/Reference/upstream/google/protobuf/empty.pb.swift
@@ -38,6 +38,7 @@
 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 import Foundation
+// 'import SwiftProtobuf' suppressed, this proto file is meant to be bundled in the runtime.
 
 // If the compiler emits an error on this type, it is because this file
 // was generated by a version of the `protoc` Swift plug-in that is

diff --git a/Reference/upstream/google/protobuf/field_mask.pb.swift b/Reference/upstream/google/protobuf/field_mask.pb.swift
@@ -38,6 +38,7 @@
 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 import Foundation
+// 'import SwiftProtobuf' suppressed, this proto file is meant to be bundled in the runtime.
 
 // If the compiler emits an error on this type, it is because this file
 // was generated by a version of the `protoc` Swift plug-in that is

diff --git a/Reference/upstream/google/protobuf/source_context.pb.swift b/Reference/upstream/google/protobuf/source_context.pb.swift
@@ -38,6 +38,7 @@
 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 import Foundation
+// 'import SwiftProtobuf' suppressed, this proto file is meant to be bundled in the runtime.
 
 // If the compiler emits an error on this type, it is because this file
 // was generated by a version of the `protoc` Swift plug-in that is

diff --git a/Reference/upstream/google/protobuf/struct.pb.swift b/Reference/upstream/google/protobuf/struct.pb.swift
@@ -38,6 +38,7 @@
 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 import Foundation
+// 'import SwiftProtobuf' suppressed, this proto file is meant to be bundled in the runtime.
 
 // If the compiler emits an error on this type, it is because this file
 // was generated by a version of the `protoc` Swift plug-in that is

diff --git a/Reference/upstream/google/protobuf/timestamp.pb.swift b/Reference/upstream/google/protobuf/timestamp.pb.swift
@@ -38,6 +38,7 @@
 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 import Foundation
+// 'import SwiftProtobuf' suppressed, this proto file is meant to be bundled in the runtime.
 
 // If the compiler emits an error on this type, it is because this file
 // was generated by a version of the `protoc` Swift plug-in that is

diff --git a/Reference/upstream/google/protobuf/type.pb.swift b/Reference/upstream/google/protobuf/type.pb.swift
@@ -38,6 +38,7 @@
 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 import Foundation
+// 'import SwiftProtobuf' suppressed, this proto file is meant to be bundled in the runtime.
 
 // If the compiler emits an error on this type, it is because this file
 // was generated by a version of the `protoc` Swift plug-in that is

diff --git a/Reference/upstream/google/protobuf/wrappers.pb.swift b/Reference/upstream/google/protobuf/wrappers.pb.swift
@@ -48,6 +48,7 @@
 // individual entries of a map or fields of a oneof can already detect presence.
 
 import Foundation
+// 'import SwiftProtobuf' suppressed, this proto file is meant to be bundled in the runtime.
 
 // If the compiler emits an error on this type, it is because this file
 // was generated by a version of the `protoc` Swift plug-in that is

diff --git a/Sources/SwiftProtobuf/any.pb.swift b/Sources/SwiftProtobuf/any.pb.swift
@@ -38,6 +38,7 @@
 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 import Foundation
+// 'import SwiftProtobuf' suppressed, this proto file is meant to be bundled in the runtime.
 
 // If the compiler emits an error on this type, it is because this file
 // was generated by a version of the `protoc` Swift plug-in that is

diff --git a/Sources/SwiftProtobuf/api.pb.swift b/Sources/SwiftProtobuf/api.pb.swift
@@ -38,6 +38,7 @@
 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 import Foundation
+// 'import SwiftProtobuf' suppressed, this proto file is meant to be bundled in the runtime.
 
 // If the compiler emits an error on this type, it is because this file
 // was generated by a version of the `protoc` Swift plug-in that is

diff --git a/Sources/SwiftProtobuf/descriptor.pb.swift b/Sources/SwiftProtobuf/descriptor.pb.swift
@@ -46,6 +46,7 @@
 // without any other information (e.g. without reading its imports).
 
 import Foundation
+// 'import SwiftProtobuf' suppressed, this proto file is meant to be bundled in the runtime.
 
 // If the compiler emits an error on this type, it is because this file
 // was generated by a version of the `protoc` Swift plug-in that is

diff --git a/Sources/SwiftProtobuf/duration.pb.swift b/Sources/SwiftProtobuf/duration.pb.swift
@@ -38,6 +38,7 @@
 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 import Foundation
+// 'import SwiftProtobuf' suppressed, this proto file is meant to be bundled in the runtime.
 
 // If the compiler emits an error on this type, it is because this file
 // was generated by a version of the `protoc` Swift plug-in that is

diff --git a/Sources/SwiftProtobuf/empty.pb.swift b/Sources/SwiftProtobuf/empty.pb.swift
@@ -38,6 +38,7 @@
 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 import Foundation
+// 'import SwiftProtobuf' suppressed, this proto file is meant to be bundled in the runtime.
 
 // If the compiler emits an error on this type, it is because this file
 // was generated by a version of the `protoc` Swift plug-in that is

diff --git a/Sources/SwiftProtobuf/field_mask.pb.swift b/Sources/SwiftProtobuf/field_mask.pb.swift
@@ -38,6 +38,7 @@
 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 import Foundation
+// 'import SwiftProtobuf' suppressed, this proto file is meant to be bundled in the runtime.
 
 // If the compiler emits an error on this type, it is because this file
 // was generated by a version of the `protoc` Swift plug-in that is

diff --git a/Sources/SwiftProtobuf/source_context.pb.swift b/Sources/SwiftProtobuf/source_context.pb.swift
@@ -38,6 +38,7 @@
 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 import Foundation
+// 'import SwiftProtobuf' suppressed, this proto file is meant to be bundled in the runtime.
 
 // If the compiler emits an error on this type, it is because this file
 // was generated by a version of the `protoc` Swift plug-in that is

diff --git a/Sources/SwiftProtobuf/struct.pb.swift b/Sources/SwiftProtobuf/struct.pb.swift
@@ -38,6 +38,7 @@
 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 import Foundation
+// 'import SwiftProtobuf' suppressed, this proto file is meant to be bundled in the runtime.
 
 // If the compiler emits an error on this type, it is because this file
 // was generated by a version of the `protoc` Swift plug-in that is

diff --git a/Sources/SwiftProtobuf/timestamp.pb.swift b/Sources/SwiftProtobuf/timestamp.pb.swift
@@ -38,6 +38,7 @@
 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 import Foundation
+// 'import SwiftProtobuf' suppressed, this proto file is meant to be bundled in the runtime.
 
 // If the compiler emits an error on this type, it is because this file
 // was generated by a version of the `protoc` Swift plug-in that is

diff --git a/Sources/SwiftProtobuf/type.pb.swift b/Sources/SwiftProtobuf/type.pb.swift
@@ -38,6 +38,7 @@
 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 import Foundation
+// 'import SwiftProtobuf' suppressed, this proto file is meant to be bundled in the runtime.
 
 // If the compiler emits an error on this type, it is because this file
 // was generated by a version of the `protoc` Swift plug-in that is

diff --git a/Sources/SwiftProtobuf/wrappers.pb.swift b/Sources/SwiftProtobuf/wrappers.pb.swift
@@ -48,6 +48,7 @@
 // individual entries of a map or fields of a oneof can already detect presence.
 
 import Foundation
+// 'import SwiftProtobuf' suppressed, this proto file is meant to be bundled in the runtime.
 
 // If the compiler emits an error on this type, it is because this file
 // was generated by a version of the `protoc` Swift plug-in that is

diff --git a/Sources/protoc-gen-swift/FileGenerator.swift b/Sources/protoc-gen-swift/FileGenerator.swift
@@ -109,9 +109,9 @@ class FileGenerator {
                 return ""
             }
         }()
-        if !fileDescriptor.isBundledProto {
-            // The well known types ship with the runtime, everything else needs
-            // to import the runtime.
+        if fileDescriptor.isBundledProto {
+            p.print("// 'import \(namer.swiftProtobufModuleName)' suppressed, this proto file is meant to be bundled in the runtime.")
+        } else {
             p.print("\(visibilityAnnotation)import \(namer.swiftProtobufModuleName)")
         }
         if let neededImports = generatorOptions.protoToModuleMappings.neededModules(forFile: fileDescriptor) {