Node.js rules

Rules for generating Node.js protobuf and gRPC .js files using standard Protocol Buffers and gRPC.

Rule	Description
nodejs_proto_compile	Generates Node.js protobuf `.js` artifacts
nodejs_grpc_compile	Generates Node.js protobuf+gRPC `.js` artifacts
nodejs_proto_library	Generates a Node.js protobuf library using `js_library` from `rules_nodejs`
nodejs_grpc_library	Generates a Node.js protobuf+gRPC library using `js_library` from `rules_nodejs`

`nodejs_proto_compile`

Generates Node.js protobuf .js artifacts

`WORKSPACE`

load("@rules_proto_grpc//nodejs:repositories.bzl", rules_proto_grpc_nodejs_repos = "nodejs_repos")

rules_proto_grpc_nodejs_repos()

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

yarn_install(
    name = "nodejs_modules",
    package_json = "@rules_proto_grpc//nodejs:requirements/package.json",
    yarn_lock = "@rules_proto_grpc//nodejs:requirements/yarn.lock",
)

`BUILD.bazel`

load("@rules_proto_grpc//nodejs:defs.bzl", "nodejs_proto_compile")

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

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

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

Attributes

Name	Type	Mandatory	Default	Description
`protos`	`list<ProtoInfo>`	true	`[]`	List of labels that provide a `ProtoInfo` (such as `rules_proto` `proto_library`)
`options`	`dict<string, list(string)>`	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`	`list<string>`	false	`[]`	A list of extra args to pass directly to protoc, not as plugin options

Plugins

@rules_proto_grpc//nodejs:nodejs_plugin

`nodejs_grpc_compile`

Generates Node.js protobuf+gRPC .js artifacts

`WORKSPACE`

load("@rules_proto_grpc//nodejs:repositories.bzl", rules_proto_grpc_nodejs_repos = "nodejs_repos")

rules_proto_grpc_nodejs_repos()

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

yarn_install(
    name = "nodejs_modules",
    package_json = "@rules_proto_grpc//nodejs:requirements/package.json",
    yarn_lock = "@rules_proto_grpc//nodejs:requirements/yarn.lock",
)

`BUILD.bazel`

load("@rules_proto_grpc//nodejs:defs.bzl", "nodejs_grpc_compile")

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

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

Attributes

Name	Type	Mandatory	Default	Description
`protos`	`list<ProtoInfo>`	true	`[]`	List of labels that provide a `ProtoInfo` (such as `rules_proto` `proto_library`)
`options`	`dict<string, list(string)>`	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`	`list<string>`	false	`[]`	A list of extra args to pass directly to protoc, not as plugin options

Plugins

@rules_proto_grpc//nodejs:nodejs_plugin
@rules_proto_grpc//nodejs:grpc_nodejs_plugin

`nodejs_proto_library`

Generates a Node.js protobuf library using js_library from rules_nodejs

`WORKSPACE`

load("@rules_proto_grpc//nodejs:repositories.bzl", rules_proto_grpc_nodejs_repos = "nodejs_repos")

rules_proto_grpc_nodejs_repos()

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

yarn_install(
    name = "nodejs_modules",
    package_json = "@rules_proto_grpc//nodejs:requirements/package.json",
    yarn_lock = "@rules_proto_grpc//nodejs:requirements/yarn.lock",
)

`BUILD.bazel`

load("@rules_proto_grpc//nodejs:defs.bzl", "nodejs_proto_library")

nodejs_proto_library(
    name = "person_nodejs_proto",
    protos = ["@rules_proto_grpc//example/proto:person_proto"],
    deps = ["place_nodejs_proto"],
)

nodejs_proto_library(
    name = "place_nodejs_proto",
    protos = ["@rules_proto_grpc//example/proto:place_proto"],
    deps = ["thing_nodejs_proto"],
)

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

Attributes

Name	Type	Mandatory	Default	Description
`protos`	`list<ProtoInfo>`	true	`[]`	List of labels that provide a `ProtoInfo` (such as `rules_proto` `proto_library`)
`options`	`dict<string, list(string)>`	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`	`list<string>`	false	`[]`	A list of extra args to pass directly to protoc, not as plugin options
`deps`	`list<Label/string>`	false	`[]`	List of labels to pass as deps attr to underlying lang_library rule

`nodejs_grpc_library`

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

`WORKSPACE`

load("@rules_proto_grpc//nodejs:repositories.bzl", rules_proto_grpc_nodejs_repos = "nodejs_repos")

rules_proto_grpc_nodejs_repos()

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

yarn_install(
    name = "nodejs_modules",
    package_json = "@rules_proto_grpc//nodejs:requirements/package.json",
    yarn_lock = "@rules_proto_grpc//nodejs:requirements/yarn.lock",
)

`BUILD.bazel`

load("@rules_proto_grpc//nodejs:defs.bzl", "nodejs_grpc_library")

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

nodejs_grpc_library(
    name = "greeter_nodejs_grpc",
    protos = ["@rules_proto_grpc//example/proto:greeter_grpc"],
    deps = ["thing_nodejs_grpc"],
)

Attributes

Name	Type	Mandatory	Default	Description
`protos`	`list<ProtoInfo>`	true	`[]`	List of labels that provide a `ProtoInfo` (such as `rules_proto` `proto_library`)
`options`	`dict<string, list(string)>`	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`	`list<string>`	false	`[]`	A list of extra args to pass directly to protoc, not as plugin options
`deps`	`list<Label/string>`	false	`[]`	List of labels to pass as deps attr to underlying lang_library rule