@protobuf-ts/protoc
v2.9.4
Published
Installs the protocol buffer compiler "protoc" for you.
Downloads
917,650
Maintainers
Readme
@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 @protobuf-ts/protoc
# with yarn:
yarn add @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": "3.11.0"
}
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:
--proto_path
that points to theinclude/
directory of the downloaded release (skipped when found on$PATH
)--plugin
argument for all plugins found innode_modules/.bin/
--proto_path
argument fornode_modules/@protobuf-ts/plugin