README
¶
rules_proto (v4)
Bazel starlark rules for building protocol buffers +/- gRPC ✨.
 |
 |
 |
 |
| bazel | gazelle | protobuf | grpc |
@build_stack_rules_proto provides:
- Rules for driving the
protoctool within a bazel workspace. - A gazelle extension that
generates rules based on the content of your
.protofiles. - Example setups for a variety of languages.
MODULE.bazel
bazel_dep(name = "build_stack_rules_proto", version = "4.x.x")
NOTE:
build_stack_rules_protois still in the submission process to the bcr. Until merged, a git_override or other override is needed to consume this repository.
See https://registry.bazel.build/search?q=build_stack_rules_proto for latest version.
NOTE: Version 4.x.x no longer supports
WORKSPACE, please use the latest 3.x.x release for workspace compatibility.
Docs
| Description | Link |
|---|---|
| Documentation about the core ruleset | CORE_RULES.md |
| Available Toolchains | TOOLCHAINS.md |
| Guide to setting up the gazelle extension | GAZELLE.md |
| Writing custom gazelle logic | STARLARK.md |
| Examples | example/README.md |
| Preconfigured plugins | PLUGINS.md |
| Preconfigured rules | RULES.md |
| A history of this repository | HISTORY.md |
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
examplegen
command
|
|
|
gazelle
command
Command gazelle is a BUILD file generator for Go projects.
|
Command gazelle is a BUILD file generator for Go projects. |
|
gazelle/internal/wspace
Package wspace provides functions to locate and modify a bazel WORKSPACE file.
|
Package wspace provides functions to locate and modify a bazel WORKSPACE file. |
|
gencopy
command
gencopy is a utility program that copies bazel outputs back into the workspace source tree.
|
gencopy is a utility program that copies bazel outputs back into the workspace source tree. |
|
example
|
|
|
language
|
|
|
pkg
|
|
|
plugin/builtin
plugin package contains proto_plugin implementations that come "built-in" with the gazelle protoc extension.
|
plugin package contains proto_plugin implementations that come "built-in" with the gazelle protoc extension. |
|
plugintest
plugintest provides utilities for black-box testing of protoc.Plugin implementations.
|
plugintest provides utilities for black-box testing of protoc.Plugin implementations. |
Click to show internal directories.
Click to hide internal directories.