Add code generation examples to protoc-gen-es README.md #207
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
timostamm
commented
Aug 25, 2022
|
|
||
| ```shell | ||
| npm install @bufbuild/protoc-gen-es | ||
| npm install --save-dev @bufbuild/protoc-gen-es | ||
| npm install @bufbuild/protobuf |
There was a problem hiding this comment.
With npm, it isn't necessary to install the runtime library explicitly. It is a peer dependency of the plugin, so npm will install it automatically. But yarn and pnpm don't, so it seems a bit clearer to add it in this example anyways.
Comment on lines
+44
to
+45
| We use peer dependencies to ensure that code generator and runtime library are | ||
| compatible with each other. Note that yarn and pnpm only emit a warning in this case. |
There was a problem hiding this comment.
Hoping this might help a bit with the situation regarding connectrpc/connect-es#239.
| "name": "your-package", | ||
| "version": "1.0.0", | ||
| "scripts": { | ||
| "generate": "buf generate" |
There was a problem hiding this comment.
Tested with pnpm, yarn, npm. They all add npm binaries to the $PATH.
smaye81
approved these changes
Aug 25, 2022
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Preview in GitHub: README.md