Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add ProtoPathModuleMappings to the plugin options list #797

Merged
merged 2 commits into from
May 14, 2020
Merged

docs: add ProtoPathModuleMappings to the plugin options list #797

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e7d83d8
docs: add `ProtoPathModuleMappings` to the plugin options list
jagobagascon May 14, 2020
533ddd7
Update docs/plugin.md
glbrntt May 14, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions docs/plugin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +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)
glbrntt marked this conversation as resolved.
Show resolved Hide resolved

To pass extra parameters to the plugin, use a comma-separated parameter list
separated from the output directory by a colon. Alternatively use the
Expand Down