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.4.4",
"google-protobuf": "3.19.1",
"grpc-tools": "1.11.2",
"grpc-web": "1.3.0",
"ts-protoc-gen": "0.15.0"
}
Rule |
Description |
---|---|
Generates JavaScript protobuf |
|
Generates JavaScript protobuf and gRPC-node |
|
Generates JavaScript protobuf and gRPC-Web |
|
Generates a JavaScript protobuf library using |
|
Generates a Node.js protobuf + gRPC-node library using |
|
Generates a JavaScript protobuf + gRPC-Web library using |
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¶
Name |
Type |
Mandatory |
Default |
Description |
---|---|---|---|---|
|
|
true |
List of labels that provide the |
|
|
|
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 |
|
|
false |
|
The verbosity level. Supported values and results are 0: Show nothing, 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 |
|
|
false |
|
Path to prefix to the generated files in the output directory |
|
|
false |
|
A list of extra args to pass directly to protoc, not as plugin options |
|
|
false |
|
List of labels that provide extra files to be available during protoc execution |
|
|
false |
|
The output mode for the target. PREFIXED (the default) will output to a directory named by the target within the current package root, NO_PREFIX will output directly to the current package. Using NO_PREFIX may lead to conflicting writes |
Plugins¶
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¶
Name |
Type |
Mandatory |
Default |
Description |
---|---|---|---|---|
|
|
true |
List of labels that provide the |
|
|
|
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 |
|
|
false |
|
The verbosity level. Supported values and results are 0: Show nothing, 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 |
|
|
false |
|
Path to prefix to the generated files in the output directory |
|
|
false |
|
A list of extra args to pass directly to protoc, not as plugin options |
|
|
false |
|
List of labels that provide extra files to be available during protoc execution |
|
|
false |
|
The output mode for the target. PREFIXED (the default) will output to a directory named by the target within the current package root, NO_PREFIX will output directly to the current package. Using NO_PREFIX may lead to conflicting writes |
Plugins¶
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¶
Name |
Type |
Mandatory |
Default |
Description |
---|---|---|---|---|
|
|
true |
List of labels that provide the |
|
|
|
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 |
|
|
false |
|
The verbosity level. Supported values and results are 0: Show nothing, 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 |
|
|
false |
|
Path to prefix to the generated files in the output directory |
|
|
false |
|
A list of extra args to pass directly to protoc, not as plugin options |
|
|
false |
|
List of labels that provide extra files to be available during protoc execution |
|
|
false |
|
The output mode for the target. PREFIXED (the default) will output to a directory named by the target within the current package root, NO_PREFIX will output directly to the current package. Using NO_PREFIX may lead to conflicting writes |
Plugins¶
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¶
Name |
Type |
Mandatory |
Default |
Description |
---|---|---|---|---|
|
|
true |
List of labels that provide the |
|
|
|
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 |
|
|
false |
|
The verbosity level. Supported values and results are 0: Show nothing, 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 |
|
|
false |
|
Path to prefix to the generated files in the output directory |
|
|
false |
|
A list of extra args to pass directly to protoc, not as plugin options |
|
|
false |
|
List of labels that provide extra files to be available during protoc execution |
|
|
false |
|
The output mode for the target. PREFIXED (the default) will output to a directory named by the target within the current package root, NO_PREFIX will output directly to the current package. Using NO_PREFIX may lead to conflicting writes |
|
|
false |
|
List of labels to pass as deps attr to underlying lang_library rule |
|
|
false |
The package name to use for the library. If unprovided, the target name is used. |
|
|
|
false |
|
The repository to load the dependencies from, if you don’t use |
|
|
false |
|
Use the legacy <name>_pb path segment from the generated library require path. |
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¶
Name |
Type |
Mandatory |
Default |
Description |
---|---|---|---|---|
|
|
true |
List of labels that provide the |
|
|
|
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 |
|
|
false |
|
The verbosity level. Supported values and results are 0: Show nothing, 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 |
|
|
false |
|
Path to prefix to the generated files in the output directory |
|
|
false |
|
A list of extra args to pass directly to protoc, not as plugin options |
|
|
false |
|
List of labels that provide extra files to be available during protoc execution |
|
|
false |
|
The output mode for the target. PREFIXED (the default) will output to a directory named by the target within the current package root, NO_PREFIX will output directly to the current package. Using NO_PREFIX may lead to conflicting writes |
|
|
false |
|
List of labels to pass as deps attr to underlying lang_library rule |
|
|
false |
The package name to use for the library. If unprovided, the target name is used. |
|
|
|
false |
|
The repository to load the dependencies from, if you don’t use |
|
|
false |
|
Use the legacy <name>_pb path segment from the generated library require path. |
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¶
Name |
Type |
Mandatory |
Default |
Description |
---|---|---|---|---|
|
|
true |
List of labels that provide the |
|
|
|
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 |
|
|
false |
|
The verbosity level. Supported values and results are 0: Show nothing, 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 |
|
|
false |
|
Path to prefix to the generated files in the output directory |
|
|
false |
|
A list of extra args to pass directly to protoc, not as plugin options |
|
|
false |
|
List of labels that provide extra files to be available during protoc execution |
|
|
false |
|
The output mode for the target. PREFIXED (the default) will output to a directory named by the target within the current package root, NO_PREFIX will output directly to the current package. Using NO_PREFIX may lead to conflicting writes |
|
|
false |
|
List of labels to pass as deps attr to underlying lang_library rule |
|
|
false |
The package name to use for the library. If unprovided, the target name is used. |
|
|
|
false |
|
The repository to load the dependencies from, if you don’t use |
|
|
false |
|
Use the legacy <name>_pb path segment from the generated library require path. |