Webpack loader to translate .proto definitions to ProtoBuf.js modules
npm install protobufjs-loader
Webpack loader to translate
protobuf definitions to
protobuf.js
modules. Equivalent to running your definitions through the pbjs
CLI.
This allows you to use the light or minimal protobuf.js distributions
without an explicit compile step in your build pipeline.
``sh`
npm install --save-dev protobufjs-loader
`javascript
// webpack.config.js
module.exports = {
// ...
module: {
rules: [
{
test: /\.proto$/,
use: {
loader: 'protobufjs-loader',
options: {
/* Import paths provided to pbjs.
*
* default: webpack import paths (i.e. config.resolve.modules)
*/
paths: ['/path/to/definitions'],
/* Additional command line arguments passed to pbjs.
*
* default: []
*/
pbjsArgs: ['--no-encode'],
/* Enable Typescript declaration file generation via pbts.
*
* Declaration files will be written every time the loader runs.
* By default, they'll be saved in the same directory as the
* protobuf file being processed, using the same filename with a
* .d.ts extension.
*
* This only works if you're using the 'static-module' target
* for pbjs (i.e. the default target).
*
* The value here can be a config object or a boolean; set it to
* true to enable pbts with default configuration.
*
* default: false
*/
pbts: {
/* Additional command line arguments passed to pbts.
*/
args: ['--no-comments'],
/* Optional function which receives the path to a protobuf file,
* and returns the output path (or a promise resolving to the
* output path) for the associated Typescript declaration file.
*
* If this is null (i.e. by default), declaration files will be
* saved to ${protobufFile}.d.ts./custom/location/${require('path').basename(
*
* The loader won't create any directories on the filesystem. If
* writing to a nonstandard location, you should ensure that it
* exists and is writable.
*
* default: null
*/
output: (protobufFile) =>
protobufFile
)}.d.ts,
},
/* Set the "target" flag to pbjs.
*
* default: 'static-module'
*/
target: 'json-module',
},
},
},
],
},
};
`
`javascript
// myModule.js
/* replaces e.g.:
*
* const protobuf = require('protobufjs/light');
* const jsonDescriptor = require('json!my/compiled/protobuf.js');
* const Root = protobuf.Root.fromJSON(jsonDescriptor);
*/
const Root = require('my/protobuf.proto');
``