From e7d83d881c07048f9ef46396a8463bd28d6e5229 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jagoba=20Gasco=CC=81n?= Date: Thu, 14 May 2020 12:59:32 +0200 Subject: [PATCH 1/2] docs: add `ProtoPathModuleMappings` to the plugin options list --- docs/plugin.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/plugin.md b/docs/plugin.md index e66c1591a..46443a965 100644 --- a/docs/plugin.md +++ b/docs/plugin.md @@ -26,14 +26,14 @@ when invoking `protoc`. The table below lists the options available to the `protoc-gen-grpc-swift` plugin: -| Flag | Values | Default | Description -|:---------------------|:------------------------------------------|:-----------|:---------------------------------------------------------------------------------------------------------------------- -| `Visibility` | `Internal`/`Public` | `Internal` | ACL of generated code -| `Server` | `true`/`false` | `true` | Whether to generate server code -| `Client` | `true`/`false` | `true` | Whether to generate client code -| `FileNaming` | `FullPath`/`PathToUnderscores`/`DropPath` | `FullPath` | How to handle the naming of generated sources, see [documentation][swift-protobuf-filenaming] -| `ExtraModuleImports` | `String` | | Extra module to import in generated code. This parameter may be included multiple times to import more than one module - +| Flag | Values | Default | Description +|:--------------------------|:------------------------------------------|:-----------|:---------------------------------------------------------------------------------------------------------------------- +| `Visibility` | `Internal`/`Public` | `Internal` | ACL of generated code +| `Server` | `true`/`false` | `true` | Whether to generate server code +| `Client` | `true`/`false` | `true` | Whether to generate client code +| `FileNaming` | `FullPath`/`PathToUnderscores`/`DropPath` | `FullPath` | How to handle the naming of generated sources, see [documentation][swift-protobuf-filenaming] +| `ExtraModuleImports` | `String` | | Extra module to import in generated code. This parameter may be included multiple times to import more than one module +| `ProtoPathModuleMappings` | `String` | | The path of the file that contains the module mappings for the generated code, see [swift-protobuf documentation](https://github.com/apple/swift-protobuf/blob/master/Documentation/PLUGIN.md#generation-option-protopathmodulemappings---swift-module-names-for-proto-paths) To pass extra parameters to the plugin, use a comma-separated parameter list separated from the output directory by a colon. Alternatively use the `--grpc-swift_opt` flag. From 533ddd7dd916fb3287f0d13eb19c71b64d550045 Mon Sep 17 00:00:00 2001 From: George Barnett Date: Thu, 14 May 2020 13:17:58 +0100 Subject: [PATCH 2/2] Update docs/plugin.md --- docs/plugin.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/plugin.md b/docs/plugin.md index 46443a965..a02c64686 100644 --- a/docs/plugin.md +++ b/docs/plugin.md @@ -34,6 +34,7 @@ plugin: | `FileNaming` | `FullPath`/`PathToUnderscores`/`DropPath` | `FullPath` | How to handle the naming of generated sources, see [documentation][swift-protobuf-filenaming] | `ExtraModuleImports` | `String` | | Extra module to import in generated code. This parameter may be included multiple times to import more than one module | `ProtoPathModuleMappings` | `String` | | The path of the file that contains the module mappings for the generated code, see [swift-protobuf documentation](https://github.com/apple/swift-protobuf/blob/master/Documentation/PLUGIN.md#generation-option-protopathmodulemappings---swift-module-names-for-proto-paths) + To pass extra parameters to the plugin, use a comma-separated parameter list separated from the output directory by a colon. Alternatively use the `--grpc-swift_opt` flag.