Scala¶

Rules for generating Scala protobuf and gRPC .jar files and libraries using ScalaPB. Libraries are created with scala_library from rules_scala

Rules¶
Rule	Description
scala_proto_compile	Generates a Scala protobuf `.jar` file
scala_grpc_compile	Generates Scala protobuf and gRPC `.jar` file
scala_proto_library	Generates a Scala protobuf library using `scala_library` from `rules_scala`
scala_grpc_library	Generates a Scala protobuf and gRPC library using `scala_library` from `rules_scala`

Installation¶

The Scala module can be installed by adding the following lines to your MODULE.bazel file, replacing the version number placeholder with the desired version:

bazel_dep(name = "rules_proto_grpc_scala", version = "<version number here>")

scala_proto_compile¶

Generates a Scala protobuf .jar file

Example¶

Full example project can be found here

`BUILD.bazel`¶

load("@rules_proto_grpc_scala//:defs.bzl", "scala_proto_compile")

scala_proto_compile(
    name = "person_scala_proto",
    protos = ["@rules_proto_grpc_example_protos//:person_proto"],
)

scala_proto_compile(
    name = "place_scala_proto",
    protos = ["@rules_proto_grpc_example_protos//:place_proto"],
)

scala_proto_compile(
    name = "thing_scala_proto",
    protos = ["@rules_proto_grpc_example_protos//:thing_proto"],
)

Attributes¶

Attributes for scala_proto_compile¶
Name	Type	Mandatory	Default	Description
`protos`	`label_list`	true		List of labels that provide the `ProtoInfo` provider (such as `proto_library` from `@protobuf`)
`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 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
`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 command line arguments to pass directly to protoc, not as plugin options
`extra_protoc_files`	`label_list`	false	`[]`	List of labels that provide extra files to be available during protoc execution
`output_mode`	`string`	false	`PREFIXED`	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¶

@rules_proto_grpc_scala//:proto_plugin

scala_grpc_compile¶

Generates Scala protobuf and gRPC .jar file

Example¶

Full example project can be found here

`BUILD.bazel`¶

load("@rules_proto_grpc_scala//:defs.bzl", "scala_grpc_compile")

scala_grpc_compile(
    name = "thing_scala_grpc",
    protos = ["@rules_proto_grpc_example_protos//:thing_proto"],
)

scala_grpc_compile(
    name = "greeter_scala_grpc",
    protos = ["@rules_proto_grpc_example_protos//:greeter_grpc"],
)

Attributes¶

Attributes for scala_grpc_compile¶
Name	Type	Mandatory	Default	Description
`protos`	`label_list`	true		List of labels that provide the `ProtoInfo` provider (such as `proto_library` from `@protobuf`)
`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 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
`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 command line arguments to pass directly to protoc, not as plugin options
`extra_protoc_files`	`label_list`	false	`[]`	List of labels that provide extra files to be available during protoc execution
`output_mode`	`string`	false	`PREFIXED`	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¶

@rules_proto_grpc_scala//:grpc_plugin

scala_proto_library¶

Generates a Scala protobuf library using scala_library from rules_scala

Example¶

Full example project can be found here

`BUILD.bazel`¶

load("@rules_proto_grpc_scala//:defs.bzl", "scala_proto_library")

scala_proto_library(
    name = "person_scala_proto",
    protos = ["@rules_proto_grpc_example_protos//:person_proto"],
    deps = ["place_scala_proto"],
)

scala_proto_library(
    name = "place_scala_proto",
    protos = ["@rules_proto_grpc_example_protos//:place_proto"],
    deps = ["thing_scala_proto"],
)

scala_proto_library(
    name = "thing_scala_proto",
    protos = ["@rules_proto_grpc_example_protos//:thing_proto"],
)

Attributes¶

Attributes for scala_proto_library¶
Name	Type	Mandatory	Default	Description
`protos`	`label_list`	true		List of labels that provide the `ProtoInfo` provider (such as `proto_library` from `@protobuf`)
`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 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
`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 command line arguments to pass directly to protoc, not as plugin options
`extra_protoc_files`	`label_list`	false	`[]`	List of labels that provide extra files to be available during protoc execution
`output_mode`	`string`	false	`PREFIXED`	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
`deps`	`label_list`	false	`[]`	List of labels to pass as deps attr to underlying lang_library rule
`exports`	`label_list`	false	`[]`	List of labels to pass as exports attr to underlying lang_library rule

scala_grpc_library¶

Generates a Scala protobuf and gRPC library using scala_library from rules_scala

Example¶

Full example project can be found here

`BUILD.bazel`¶

load("@rules_proto_grpc_scala//:defs.bzl", "scala_grpc_library")

scala_grpc_library(
    name = "thing_scala_grpc",
    protos = ["@rules_proto_grpc_example_protos//:thing_proto"],
)

scala_grpc_library(
    name = "greeter_scala_grpc",
    protos = ["@rules_proto_grpc_example_protos//:greeter_grpc"],
    deps = ["thing_scala_grpc"],
)

Attributes¶

Attributes for scala_grpc_library¶
Name	Type	Mandatory	Default	Description
`protos`	`label_list`	true		List of labels that provide the `ProtoInfo` provider (such as `proto_library` from `@protobuf`)
`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 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
`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 command line arguments to pass directly to protoc, not as plugin options
`extra_protoc_files`	`label_list`	false	`[]`	List of labels that provide extra files to be available during protoc execution
`output_mode`	`string`	false	`PREFIXED`	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
`deps`	`label_list`	false	`[]`	List of labels to pass as deps attr to underlying lang_library rule
`exports`	`label_list`	false	`[]`	List of labels to pass as exports attr to underlying lang_library rule

Scala¶

Installation¶

scala_proto_compile¶

Example¶

BUILD.bazel¶

Attributes¶

Plugins¶

scala_grpc_compile¶

Example¶

BUILD.bazel¶

Attributes¶

Plugins¶

scala_proto_library¶

Example¶

BUILD.bazel¶

Attributes¶

scala_grpc_library¶

Example¶

BUILD.bazel¶

Attributes¶

`BUILD.bazel`¶

`BUILD.bazel`¶

`BUILD.bazel`¶

`BUILD.bazel`¶