JavaScript¶

Rules for generating JavaScript protobuf, gRPC-node and gRPC-Web .js and .d.ts files using standard Protocol Buffers and gRPC.

Note: You must add the required dependencies to your package.json file:

"dependencies": {
  "@grpc/grpc-js": "1.2.6",
  "google-protobuf": "3.15.3",
  "grpc-tools": "1.10.0",
  "grpc-web": "1.2.1",
  "ts-protoc-gen": "0.14.0"
}

Rules¶
Rule	Description
js_proto_compile	Generates JavaScript protobuf `.js` and `.d.ts` files
js_grpc_node_compile	Generates JavaScript protobuf and gRPC-node `.js` and `.d.ts` files
js_grpc_web_compile	Generates JavaScript protobuf and gRPC-Web `.js` and `.d.ts` files
js_proto_library	Generates a JavaScript protobuf library using `js_library` from `rules_nodejs`
js_grpc_node_library	Generates a Node.js protobuf + gRPC-node library using `js_library` from `rules_nodejs`
js_grpc_web_library	Generates a JavaScript protobuf + gRPC-Web library using `js_library` from `rules_nodejs`

js_proto_compile¶

Generates JavaScript protobuf .js and .d.ts files

Example¶

Full example project can be found here

`WORKSPACE`¶

load("@rules_proto_grpc//js:repositories.bzl", rules_proto_grpc_js_repos = "js_repos")

rules_proto_grpc_js_repos()

load("@build_bazel_rules_nodejs//:index.bzl", "yarn_install")

yarn_install(
    name = "npm",
    package_json = "@rules_proto_grpc//js:requirements/package.json",  # This should be changed to your local package.json which should contain the dependencies required
    yarn_lock = "@rules_proto_grpc//js:requirements/yarn.lock",
)

`BUILD.bazel`¶

load("@rules_proto_grpc//js:defs.bzl", "js_proto_compile")

js_proto_compile(
    name = "person_js_proto",
    protos = ["@rules_proto_grpc//example/proto:person_proto"],
)

js_proto_compile(
    name = "place_js_proto",
    protos = ["@rules_proto_grpc//example/proto:place_proto"],
)

js_proto_compile(
    name = "thing_js_proto",
    protos = ["@rules_proto_grpc//example/proto:thing_proto"],
)

Attributes¶

Attributes for js_proto_compile¶
Name	Type	Mandatory	Default	Description
`protos`	`label_list`	true		List of labels that provide the `ProtoInfo` provider (such as `proto_library` from `rules_proto`)
`options`	`string_list_dict`	false	`[]`	Extra options to pass to plugins, as a dict of plugin label -> list of strings. The key * can be used exclusively to apply to all plugins
`verbose`	`int`	false	`0`	The verbosity level. Supported values and results are 1: show command, 2: show command and sandbox after running protoc, 3: show command and sandbox before and after running protoc, 4. show env, command, expected outputs and sandbox before and after running protoc
`prefix_path`	`string`	false	`""`	Path to prefix to the generated files in the output directory
`extra_protoc_args`	`string_list`	false	`[]`	A list of extra args to pass directly to protoc, not as plugin options

Plugins¶

@rules_proto_grpc//js:js_plugin
@rules_proto_grpc//js:ts_plugin

js_grpc_node_compile¶

Generates JavaScript protobuf and gRPC-node .js and .d.ts files

Example¶

Full example project can be found here

`WORKSPACE`¶

load("@rules_proto_grpc//js:repositories.bzl", rules_proto_grpc_js_repos = "js_repos")

rules_proto_grpc_js_repos()

load("@build_bazel_rules_nodejs//:index.bzl", "yarn_install")

yarn_install(
    name = "npm",
    package_json = "@rules_proto_grpc//js:requirements/package.json",  # This should be changed to your local package.json which should contain the dependencies required
    yarn_lock = "@rules_proto_grpc//js:requirements/yarn.lock",
)

`BUILD.bazel`¶

load("@rules_proto_grpc//js:defs.bzl", "js_grpc_node_compile")

js_grpc_node_compile(
    name = "thing_js_grpc",
    protos = ["@rules_proto_grpc//example/proto:thing_proto"],
)

js_grpc_node_compile(
    name = "greeter_js_grpc",
    protos = ["@rules_proto_grpc//example/proto:greeter_grpc"],
)

Attributes¶

Attributes for js_grpc_node_compile¶
Name	Type	Mandatory	Default	Description
`protos`	`label_list`	true		List of labels that provide the `ProtoInfo` provider (such as `proto_library` from `rules_proto`)
`options`	`string_list_dict`	false	`[]`	Extra options to pass to plugins, as a dict of plugin label -> list of strings. The key * can be used exclusively to apply to all plugins
`verbose`	`int`	false	`0`	The verbosity level. Supported values and results are 1: show command, 2: show command and sandbox after running protoc, 3: show command and sandbox before and after running protoc, 4. show env, command, expected outputs and sandbox before and after running protoc
`prefix_path`	`string`	false	`""`	Path to prefix to the generated files in the output directory
`extra_protoc_args`	`string_list`	false	`[]`	A list of extra args to pass directly to protoc, not as plugin options

Plugins¶

@rules_proto_grpc//js:js_plugin
@rules_proto_grpc//js:ts_plugin
@rules_proto_grpc//js:grpc_node_plugin
@rules_proto_grpc//js:grpc_node_ts_plugin

js_grpc_web_compile¶

Generates JavaScript protobuf and gRPC-Web .js and .d.ts files

Example¶

Full example project can be found here

`WORKSPACE`¶

load("@rules_proto_grpc//js:repositories.bzl", rules_proto_grpc_js_repos = "js_repos")

rules_proto_grpc_js_repos()

load("@build_bazel_rules_nodejs//:index.bzl", "yarn_install")

yarn_install(
    name = "npm",
    package_json = "@rules_proto_grpc//js:requirements/package.json",  # This should be changed to your local package.json which should contain the dependencies required
    yarn_lock = "@rules_proto_grpc//js:requirements/yarn.lock",
)

`BUILD.bazel`¶

load("@rules_proto_grpc//js:defs.bzl", "js_grpc_web_compile")

js_grpc_web_compile(
    name = "thing_js_grpc",
    protos = ["@rules_proto_grpc//example/proto:thing_proto"],
)

js_grpc_web_compile(
    name = "greeter_js_grpc",
    protos = ["@rules_proto_grpc//example/proto:greeter_grpc"],
)

Attributes¶

Attributes for js_grpc_web_compile¶
Name	Type	Mandatory	Default	Description
`protos`	`label_list`	true		List of labels that provide the `ProtoInfo` provider (such as `proto_library` from `rules_proto`)
`options`	`string_list_dict`	false	`[]`	Extra options to pass to plugins, as a dict of plugin label -> list of strings. The key * can be used exclusively to apply to all plugins
`verbose`	`int`	false	`0`	The verbosity level. Supported values and results are 1: show command, 2: show command and sandbox after running protoc, 3: show command and sandbox before and after running protoc, 4. show env, command, expected outputs and sandbox before and after running protoc
`prefix_path`	`string`	false	`""`	Path to prefix to the generated files in the output directory
`extra_protoc_args`	`string_list`	false	`[]`	A list of extra args to pass directly to protoc, not as plugin options

Plugins¶

@rules_proto_grpc//js:js_plugin
@rules_proto_grpc//js:ts_plugin
@rules_proto_grpc//js:grpc_web_js_plugin

js_proto_library¶

Generates a JavaScript protobuf library using js_library from rules_nodejs

Example¶

Full example project can be found here

`WORKSPACE`¶

load("@rules_proto_grpc//js:repositories.bzl", rules_proto_grpc_js_repos = "js_repos")

rules_proto_grpc_js_repos()

load("@build_bazel_rules_nodejs//:index.bzl", "yarn_install")

yarn_install(
    name = "npm",
    package_json = "@rules_proto_grpc//js:requirements/package.json",  # This should be changed to your local package.json which should contain the dependencies required
    yarn_lock = "@rules_proto_grpc//js:requirements/yarn.lock",
)

`BUILD.bazel`¶

load("@rules_proto_grpc//js:defs.bzl", "js_proto_library")

js_proto_library(
    name = "person_js_proto",
    protos = ["@rules_proto_grpc//example/proto:person_proto"],
    deps = ["place_js_proto"],
)

js_proto_library(
    name = "place_js_proto",
    protos = ["@rules_proto_grpc//example/proto:place_proto"],
    deps = ["thing_js_proto"],
)

js_proto_library(
    name = "thing_js_proto",
    protos = ["@rules_proto_grpc//example/proto:thing_proto"],
)

Attributes¶

Attributes for js_proto_library¶
Name	Type	Mandatory	Default	Description
`protos`	`label_list`	true		List of labels that provide the `ProtoInfo` provider (such as `proto_library` from `rules_proto`)
`options`	`string_list_dict`	false	`[]`	Extra options to pass to plugins, as a dict of plugin label -> list of strings. The key * can be used exclusively to apply to all plugins
`verbose`	`int`	false	`0`	The verbosity level. Supported values and results are 1: show command, 2: show command and sandbox after running protoc, 3: show command and sandbox before and after running protoc, 4. show env, command, expected outputs and sandbox before and after running protoc
`prefix_path`	`string`	false	`""`	Path to prefix to the generated files in the output directory
`extra_protoc_args`	`string_list`	false	`[]`	A list of extra args to pass directly to protoc, not as plugin options
`deps`	`label_list`	false	`[]`	List of labels to pass as deps attr to underlying lang_library rule
`deps_repo`	`string`	false	`@npm`	The repository to load the dependencies from, if you don’t use `@npm`

js_grpc_node_library¶

Generates a Node.js protobuf + gRPC-node library using js_library from rules_nodejs

Example¶

Full example project can be found here

`WORKSPACE`¶

load("@rules_proto_grpc//js:repositories.bzl", rules_proto_grpc_js_repos = "js_repos")

rules_proto_grpc_js_repos()

load("@build_bazel_rules_nodejs//:index.bzl", "yarn_install")

yarn_install(
    name = "npm",
    package_json = "@rules_proto_grpc//js:requirements/package.json",  # This should be changed to your local package.json which should contain the dependencies required
    yarn_lock = "@rules_proto_grpc//js:requirements/yarn.lock",
)

`BUILD.bazel`¶

load("@rules_proto_grpc//js:defs.bzl", "js_grpc_node_library")

js_grpc_node_library(
    name = "thing_js_grpc",
    protos = ["@rules_proto_grpc//example/proto:thing_proto"],
)

js_grpc_node_library(
    name = "greeter_js_grpc",
    protos = ["@rules_proto_grpc//example/proto:greeter_grpc"],
    deps = ["thing_js_grpc"],
)

Attributes¶

Attributes for js_grpc_node_library¶
Name	Type	Mandatory	Default	Description
`protos`	`label_list`	true		List of labels that provide the `ProtoInfo` provider (such as `proto_library` from `rules_proto`)
`options`	`string_list_dict`	false	`[]`	Extra options to pass to plugins, as a dict of plugin label -> list of strings. The key * can be used exclusively to apply to all plugins
`verbose`	`int`	false	`0`	The verbosity level. Supported values and results are 1: show command, 2: show command and sandbox after running protoc, 3: show command and sandbox before and after running protoc, 4. show env, command, expected outputs and sandbox before and after running protoc
`prefix_path`	`string`	false	`""`	Path to prefix to the generated files in the output directory
`extra_protoc_args`	`string_list`	false	`[]`	A list of extra args to pass directly to protoc, not as plugin options
`deps`	`label_list`	false	`[]`	List of labels to pass as deps attr to underlying lang_library rule
`deps_repo`	`string`	false	`@npm`	The repository to load the dependencies from, if you don’t use `@npm`

js_grpc_web_library¶

Generates a JavaScript protobuf + gRPC-Web library using js_library from rules_nodejs

Example¶

Full example project can be found here

`WORKSPACE`¶

load("@rules_proto_grpc//js:repositories.bzl", rules_proto_grpc_js_repos = "js_repos")

rules_proto_grpc_js_repos()

load("@build_bazel_rules_nodejs//:index.bzl", "yarn_install")

yarn_install(
    name = "npm",
    package_json = "@rules_proto_grpc//js:requirements/package.json",  # This should be changed to your local package.json which should contain the dependencies required
    yarn_lock = "@rules_proto_grpc//js:requirements/yarn.lock",
)

`BUILD.bazel`¶

load("@rules_proto_grpc//js:defs.bzl", "js_grpc_web_library")

js_grpc_web_library(
    name = "thing_js_grpc",
    protos = ["@rules_proto_grpc//example/proto:thing_proto"],
)

js_grpc_web_library(
    name = "greeter_js_grpc",
    protos = ["@rules_proto_grpc//example/proto:greeter_grpc"],
    deps = ["thing_js_grpc"],
)

Attributes¶

Attributes for js_grpc_web_library¶
Name	Type	Mandatory	Default	Description
`protos`	`label_list`	true		List of labels that provide the `ProtoInfo` provider (such as `proto_library` from `rules_proto`)
`options`	`string_list_dict`	false	`[]`	Extra options to pass to plugins, as a dict of plugin label -> list of strings. The key * can be used exclusively to apply to all plugins
`verbose`	`int`	false	`0`	The verbosity level. Supported values and results are 1: show command, 2: show command and sandbox after running protoc, 3: show command and sandbox before and after running protoc, 4. show env, command, expected outputs and sandbox before and after running protoc
`prefix_path`	`string`	false	`""`	Path to prefix to the generated files in the output directory
`extra_protoc_args`	`string_list`	false	`[]`	A list of extra args to pass directly to protoc, not as plugin options
`deps`	`label_list`	false	`[]`	List of labels to pass as deps attr to underlying lang_library rule
`deps_repo`	`string`	false	`@npm`	The repository to load the dependencies from, if you don’t use `@npm`

JavaScript¶

js_proto_compile¶

Example¶

WORKSPACE¶

BUILD.bazel¶

Attributes¶

Plugins¶

js_grpc_node_compile¶

Example¶

WORKSPACE¶

BUILD.bazel¶

Attributes¶

Plugins¶

js_grpc_web_compile¶

Example¶

WORKSPACE¶

BUILD.bazel¶

Attributes¶

Plugins¶

js_proto_library¶

Example¶

WORKSPACE¶

BUILD.bazel¶

Attributes¶

js_grpc_node_library¶

Example¶

WORKSPACE¶

BUILD.bazel¶

Attributes¶

js_grpc_web_library¶

Example¶

WORKSPACE¶

BUILD.bazel¶

Attributes¶

`WORKSPACE`¶

`BUILD.bazel`¶

`WORKSPACE`¶

`BUILD.bazel`¶

`WORKSPACE`¶

`BUILD.bazel`¶

`WORKSPACE`¶

`BUILD.bazel`¶

`WORKSPACE`¶

`BUILD.bazel`¶

`WORKSPACE`¶

`BUILD.bazel`¶