Merge branch 'main' into build_plugin_integration_tests

Author: glbrntt

Plugins/GRPCProtobufGenerator/BuildPluginConfig.swift

@@ -57,16 +57,16 @@ struct BuildPluginConfig: Codable {
     /// Whether imports should have explicit access levels.
     ///
     /// Defaults to `false`.
-    var useAccessLevelOnImports: Bool
+    var accessLevelOnImports: Bool
 
     static let defaults = Self(
       accessLevel: .internal,
-      useAccessLevelOnImports: false
+      accessLevelOnImports: false
     )
 
-    private init(accessLevel: GenerationConfig.AccessLevel, useAccessLevelOnImports: Bool) {
+    private init(accessLevel: GenerationConfig.AccessLevel, accessLevelOnImports: Bool) {
       self.accessLevel = accessLevel
-      self.useAccessLevelOnImports = useAccessLevelOnImports
+      self.accessLevelOnImports = accessLevelOnImports
     }
   }
 
@@ -159,7 +159,7 @@ extension BuildPluginConfig.GeneratedSource: Codable {
   // Codable conformance with defaults
   enum CodingKeys: String, CodingKey {
     case accessLevel
-    case useAccessLevelOnImports
+    case accessLevelOnImports
   }
 
   init(from decoder: any Decoder) throws {
@@ -168,9 +168,9 @@ extension BuildPluginConfig.GeneratedSource: Codable {
     self.accessLevel =
       try container.decodeIfPresent(GenerationConfig.AccessLevel.self, forKey: .accessLevel)
       ?? Self.defaults.accessLevel
-    self.useAccessLevelOnImports =
-      try container.decodeIfPresent(Bool.self, forKey: .useAccessLevelOnImports)
-      ?? Self.defaults.useAccessLevelOnImports
+    self.accessLevelOnImports =
+      try container.decodeIfPresent(Bool.self, forKey: .accessLevelOnImports)
+      ?? Self.defaults.accessLevelOnImports
   }
 }
 
@@ -199,7 +199,7 @@ extension GenerationConfig {
     // hard-code full-path to avoid collisions since this goes into a temporary directory anyway
     self.fileNaming = .fullPath
     self.visibility = buildPluginConfig.generatedSource.accessLevel
-    self.useAccessLevelOnImports = buildPluginConfig.generatedSource.useAccessLevelOnImports
+    self.accessLevelOnImports = buildPluginConfig.generatedSource.accessLevelOnImports
     // Generate absolute paths for the imports relative to the config file in which they are specified
     self.importPaths = buildPluginConfig.protoc.importPaths.map { relativePath in
       configFilePath.deletingLastPathComponent().absoluteStringNoScheme + "/" + relativePath

Plugins/PluginsShared/GenerationConfig.swift

@@ -52,7 +52,7 @@ struct GenerationConfig {
   /// The naming of output files with respect to the path of the source file.
   var fileNaming: FileNaming
   /// Whether imports should have explicit access levels.
-  var useAccessLevelOnImports: Bool
+  var accessLevelOnImports: Bool
 
   /// Specify the directory in which to search for imports.
   ///

Plugins/PluginsShared/PluginUtils.swift

@@ -65,7 +65,7 @@ func constructProtocGenSwiftArguments(
 
   protocArgs.append("--swift_opt=Visibility=\(config.visibility.rawValue)")
   protocArgs.append("--swift_opt=FileNaming=\(config.fileNaming.rawValue)")
-  protocArgs.append("--swift_opt=UseAccessLevelOnImports=\(config.useAccessLevelOnImports)")
+  protocArgs.append("--swift_opt=UseAccessLevelOnImports=\(config.accessLevelOnImports)")
   protocArgs.append(contentsOf: inputFiles.map { $0.absoluteStringNoScheme })
 
   return protocArgs
@@ -101,7 +101,7 @@ func constructProtocGenGRPCSwiftArguments(
   protocArgs.append("--grpc-swift_opt=Server=\(config.server)")
   protocArgs.append("--grpc-swift_opt=Client=\(config.client)")
   protocArgs.append("--grpc-swift_opt=FileNaming=\(config.fileNaming.rawValue)")
-  protocArgs.append("--grpc-swift_opt=UseAccessLevelOnImports=\(config.useAccessLevelOnImports)")
+  protocArgs.append("--grpc-swift_opt=UseAccessLevelOnImports=\(config.accessLevelOnImports)")
   protocArgs.append(contentsOf: inputFiles.map { $0.absoluteStringNoScheme })
 
   return protocArgs

Sources/GRPCProtobuf/Documentation.docc/Articles/Installing-protoc.md

@@ -0,0 +1,59 @@
+# Installing protoc
+
+Learn how to install `protoc`, the Protocol Buffers compiler.
+
+## Overview
+
+The Protocol Buffers compiler is a command line tool for generating source code from `.proto`
+files and is required to generate gRPC stubs and messages. You can learn more about it on the
+[Protocol Buffers website](https://protobuf.dev/).
+
+You can install `protoc` in a number of ways including:
+
+1. Via a package manager,
+2. By downloading the binary.
+
+### Install via a package manager
+
+Using a package manager is the easiest way to install `protoc`.
+
+On macOS you can use [Homebrew](https://brew.sh):
+
+```sh
+brew install protobuf
+```
+
+On Ubuntu and Debian you can use `apt`:
+
+```sh
+apt update && apt install -y protobuf-compiler
+```
+
+On Fedora you can use `dnf`:
+
+```sh
+dnf install -y protobuf-compiler
+```
+
+### Installing a pre-built binary
+
+If you're unable to use a package manager to install `protoc` then you may be able
+to download a pre-built binary from the [Protocol Buffers GitHub
+repository](https://github.com/protocolbuffers/protobuf).
+
+First, find and download the appropriate binary for your system from the
+ [releases](https://github.com/protocolbuffers/protobuf/releases) page.
+
+Next, unzip the artifact to a directory called `protoc`:
+
+```sh
+unzip /path/to/downloaded/protoc-{VERSION}-{OS}.zip -d protoc
+```
+
+Finally, move `protoc/bin/protoc` to somewhere in your `$PATH` such as `/usr/local/bin`:
+
+```sh
+mv protoc/bin/protoc /usr/local/bin
+```
+
+You can now remove the `protoc` directory.

Sources/GRPCProtobuf/Documentation.docc/Documentation.md

@@ -4,13 +4,19 @@ A package integrating Swift Protobuf with gRPC Swift.
 
 ## Overview
 
-This package provides two products:
+This package provides three products:
 - ``GRPCProtobuf``, a module providing runtime serialization and deserialization components for
   [SwiftProtobuf](https://github.com/apple/swift-protobuf).
 - `protoc-gen-grpc-swift`, an executable which is a plugin for `protoc`, the Protocol Buffers
   compiler. An article describing how to generate gRPC Swift stubs using it is available with the
   `grpc-swift` documentation on the [Swift Package
   Index](https://swiftpackageindex.com/grpc/grpc-swift/documentation).
+- `GRPCProtobufGenerator`, a Swift Package build plugin for generating stubs as part of the build
+  process.
+
+## Essentials
+
+- <doc:Installing-protoc>
 
 ## Topics