protoc-gen-improbable-eng-grpc-web Hello World #368
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
Proof of concept protoc-plugin for generating service clients for use with @improbable-eng/grpc-web. ## Why? See conversation in improbable-eng/ts-protoc-gen#145 ## Design Choices 1. This package uses [protoc-plugin](https://github.com/konsumer/node-protoc-plugin) which provides the ability to [extract comments from the source proto](https://github.com/konsumer/node-protoc-plugin#findcommentbypath) and in-line them into the generated code; this was a much requested feature on ts-protoc-gen 2. [ts-morph](https://dsherret.github.io/ts-morph/) is used to build TypeScript source code in-line; this is then compiled into TypeScript definition files (`.d.ts`) and JavaScript source files. This is great as it reduces the number of code-paths required. ## What's left to do? Loads, off the top of my head: 1. Generate service clients, at present we are only generating classes required to use directly against grpc-web ("Raw!") 2. Add unit/integration test coverage! 3. Add support for in-lined documentation from source protos.
jonny-improbable
requested review from
MarcusLongmuir,
easyCZ and
johanbrandhorst
| @@ -0,0 +1,3 @@ | |||
| #!/usr/bin/env node | |||
|
|
|||
| require('../lib/index'); | |||
There was a problem hiding this comment.
What is the purpose of this file?
There was a problem hiding this comment.
It's how node/npm manages binaries. This file will be automagically chmod +x'd when you npm install allowing the end user to invoke it like a binary. You can also invoke these bins via npm scripts (defined inside the package.json) or via the npx command.
| GENERATION_DIR=${GENERATION_DIR-${SCRIPT_DIR}/${PROTOGEN_DIR}} | ||
|
|
||
| mkdir -p ${GENERATION_DIR} 2> /dev/null | ||
| PROTO_SOURCES=$(npx glob-cli2 './proto/**/*.proto') |
There was a problem hiding this comment.
Yeah, fair, this script was hacky AF! Your suggestion of prototool is a good one.
| --plugin=protoc-gen-improbable-grpc-web=./bin/protoc-gen-improbable-grpc-web \ | ||
| --js_out=import_style=commonjs,binary:${GENERATION_DIR} \ | ||
| --improbable-grpc-web_out=service=true:${GENERATION_DIR} \ | ||
| ${PROTO_SOURCES} |
There was a problem hiding this comment.
Have you considered something like https://github.com/uber/prototool to simplify this?
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.
Hello World protoc-plugin for generating service clients for use with @improbable-eng/grpc-web.
Why?
See conversation in improbable-eng/ts-protoc-gen#145
Design Choices
This package uses protoc-plugin which provides the ability to extract comments from the source proto and in-line them into the generated code; this was a much requested feature on ts-protoc-gen
ts-morph is used to build TypeScript source code in-line; this is then compiled into TypeScript definition files (
.d.ts) and JavaScript source files. This is great as it reduces the number of code-paths required.What's left to do?
Loads, off the top of my head: