From 24c5424be5b220d8d4575e4262ee5d6ad9417959 Mon Sep 17 00:00:00 2001 From: Josh Haberman Date: Fri, 19 Feb 2016 11:46:03 -0800 Subject: Added a bit more to README.md, and allowed custom PROTOC var in tests. --- js/README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) (limited to 'js/README.md') diff --git a/js/README.md b/js/README.md index 2c33fb79..15d48c87 100644 --- a/js/README.md +++ b/js/README.md @@ -43,6 +43,10 @@ Once you have `protoc` compiled, you can run the tests by typing: $ npm install $ npm test + # If your protoc is somewhere else than ../src/protoc, instead do this. + # But make sure your protoc is the same version as this (or compatible)! + $ PROTOC=/usr/local/bin/protoc npm test + This will run two separate copies of the tests: one that uses Closure Compiler style imports and one that uses CommonJS imports. You can see all the CommonJS files in `commonjs_out/`. @@ -113,6 +117,26 @@ statements like: var message = new messages.MyMessage(); +The `--js_out` flag +------------------- + +The syntax of the `--js_out` flag is: + + --js_out=[OPTIONS:]output_dir + +Where `OPTIONS` are separated by commas. Options are either `opt=val` or +just `opt` (for options that don't take a value). The available options +are specified and documented in the `GeneratorOptions` struct in +[src/google/protobuf/compiler/js/js_generator.h](https://github.com/google/protobuf/blob/master/src/google/protobuf/compiler/js/js_generator.h#L53). + +Some examples: + +- `--js_out=library=myprotos_lib.js,binary:.`: this contains the options + `library=myprotos.lib.js` and `binary` and outputs to the current directory. + The `import_style` option is left to the default, which is `closure`. +- `--js_out=import_style=commonjs,binary:protos`: this contains the options + `import_style=commonjs` and `binary` and outputs to the directory `protos`. + API === -- cgit v1.2.3