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.

Installation

npm install --save-dev protobufjs-loader

Usage

// 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.
             * They'll be saved in the same directory as the protobuf file
             * being processed, 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'],
            },

            /* Set the "target" flag to pbjs.
             *
             * default: 'static-module'
             */
            target: 'json-module',
          },
        },
      },
    ],
  },
};

// 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');

Contributing

Contributions are greatly appreciated.

PR conventions

The project uses semantic-release, meaning that a new release will be published whenever functional changes are pushed to the master branch.

To support this, PR titles must follow the Conventional Commits Spec, e.g. fix: some fix (for a patch version release) or feat: some feature (for a minor version release).

(Note that PRs will generally be squashed rather than merged directly, so it's the PR title, rather than individual commit messages, which must follow this spec.)

CI Validations

PRs need to pass the following checks before they can be merged:

npm run check # Validates typings.
npm run lint  # Validates code style.
npm run test  # Validates functionality.

If you have linting errors, you may be able to fix them automatically using:

npm run fix