Skip to content

Latest commit

 

History

History
46 lines (31 loc) · 1.49 KB

README.md

File metadata and controls

46 lines (31 loc) · 1.49 KB
Raw

Proto2TypeScript

This tool generate TypeScript definitions for your Protocol Buffers models, when you use the excellent ProtoBuf.js library.

Usage

# Install the dependencies
npm install --production

# Parse and convert the proto file to json using pbjs (from ProtoBuf.js)
node_modules/protobufjs/bin/pbjs model.proto > model.json

# Convert the model to TypeScript definitions
node command.js --file model.json > model.d.ts

Options

Options:
  -f, --file              The JSON file                                       [required]
  -c, --camelCaseGetSet   Generate getter and setters in camel case notation  [default: true]
  -u, --underscoreGetSet  Generate getter and setters in underscore notation  [default: false]
  -p, --properties        Generate properties                                 [default: true]
  -t, --templateDir       Template directory                                  [default: __dirname]

Why ?

Because intelligent code completion is cool :-)

Requirements

It is a Node.js project. The sourcecode is written in TypeScript, but the JavaScript output is present in the repository.

If you want to run the tests, you need bash, mocha and typescript.

Acknowledgements

This code is developed in context of the BRIDGE project.

Licence

The source code of this tool is licenced under the MIT License.