Skip to content

README.md

Latest commit

 

History

History
64 lines (40 loc) · 1.49 KB

README.md

File metadata and controls

64 lines (40 loc) · 1.49 KB

@oneadvisory/protobuf-ts-protoc

Installs the protocol buffer compiler "protoc" for you.

Installation (not necessary if you use the protobuf-ts plugin):

# with npm:
npm install @oneadvisory/protobuf-ts-protoc

# with yarn:
yarn add @oneadvisory/protobuf-ts-protoc

Now you can run protoc as usual, you just have to prefix your command with npx or yarn:

# with npm:
npx protoc --version 

# with yarn:
yarn protoc --version

If you do not already have protoc in your $PATH, this will automatically download the latest release of protoc for your platform from the github release page, then run the executable with your arguments.

Yarn berry

This package is not compatible with Yarn berry. Please use node-protoc.

Installing a specific version

Add the following to your package json:

"config": {
   "protocVersion": "29.2"
}

Prevent using protoc from $PATH

Add a protocVersion to your package json, see above.

Added arguments

The script passes all given arguments to protoc and adds the following arguments:

  1. --proto_path that points to the include/ directory of the downloaded release (skipped when found on $PATH)
  2. --plugin argument for all plugins found in node_modules/.bin/
  3. --proto_path argument for node_modules/@oneadvisory/protobuf-ts-plugin