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

protoc-gen-improbable-eng-grpc-web Hello World #368

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

protoc-gen-improbable-eng-grpc-web Hello World #368

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 16 additions & 0 deletions client/protoc-gen-improbable-grpc-web/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# @improbable-eng/protoc-gen-improbable-grpc-web
protoc-plugin for generating @improbable-eng/grpc-web service clients.

## Usage
This plugin should be used in conjunction with the [protoc-js plugin](https://developers.google.com/protocol-buffers/docs/reference/javascript-generated) with the following caveats:
1. The output directory must be consistent between both plugins (ie: `js_out` and `improbable-grpc-web_out`).
2. You must use `import_style=commonjs,binary` in your protoc-js plugin configuration.

```bash
OUT_DIR="generated"
protoc \
--plugin=protoc-gen-improbable-grpc-web=./bin/protoc-gen-improbable-grpc-web \
--js_out=import_style=commonjs,binary:${OUT_DIR} \
--improbable-grpc-web_out=${OUT_DIR} \
./proto/some.proto
```
3 changes: 3 additions & 0 deletions client/protoc-gen-improbable-grpc-web/bin/protoc-gen-improbable-grpc-web
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#!/usr/bin/env node

require('../lib/index');
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the purpose of this file?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

15 changes: 15 additions & 0 deletions client/protoc-gen-improbable-grpc-web/generate-protos.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
#!/bin/bash

SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd -P)"
PROTOBUF_DIR=${PROTOBUF_DIR-${SCRIPT_DIR}/proto}
PROTOGEN_DIR=generated/_proto
GENERATION_DIR=${GENERATION_DIR-${SCRIPT_DIR}/${PROTOGEN_DIR}}

mkdir -p ${GENERATION_DIR} 2> /dev/null
PROTO_SOURCES=$(npx glob-cli2 './proto/**/*.proto')
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😱

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, fair, this script was hacky AF! Your suggestion of prototool is a good one.


protoc \
--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}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have you considered something like https://github.com/uber/prototool to simplify this?

Loading