protoc-gen-aip-lint

module
v0.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 10, 2026 License: MIT

README

protoc-gen-aip-lint

CI Release License Go protoc

A protoc plugin that runs the Google API Linter on your Protocol Buffer files. It checks .proto files against the AIP style guidelines and reports problems in multiple output formats.

Features

  • Lint .proto files against the full set of AIP rules
  • One rule of its own: an update mask's field_mask.in matches the resource's writable fields (see Custom Rules)
  • Multiple output formats: YAML, JSON, GitHub Actions annotations, and summary table
  • Configurable via the standard api-linter YAML configuration file
  • Works with protoc, buf, or any protoc-compatible toolchain
  • CI-friendly set-exit-status option for gating builds on lint failures

Installation

go install github.com/protoc-contrib/protoc-gen-aip-lint/cmd/protoc-gen-aip-lint@latest

Usage

With buf

Add the plugin to your buf.gen.yaml:

version: v2
plugins:
  - protoc_builtin: cpp
    out: gen/proto/cpp
  - local: protoc-gen-aip-lint
    out: .
    opt:
      - output-format=github
      - set-exit-status

Then run:

buf generate
With protoc
protoc \
  --aip-lint_out=. \
  --aip-lint_opt=output-format=github,set-exit-status \
  -I proto/ \
  proto/example/v1/example.proto

Plugin Options

Options are passed via --aip-lint_opt (protoc) or opt (buf). Multiple options are comma-separated.

Option Description
config Path to the api-linter YAML configuration file
ignore-comment-disables Ignore inline disable comments for strict AIP enforcement
output-format Output format: yaml (default), json, github, or summary
output-path Output file path (defaults to stderr; stdout is reserved for protoc)
set-exit-status Exit with non-zero status when lint problems are found

Output Formats

YAML (default)
- filepath: example.proto
  problems:
    - message: "Field must be in lower_snake_case."
      rule_id: "core::0140::lower-snake"
JSON
[
  {
    "file_path": "example.proto",
    "problems": [
      {
        "message": "Field must be in lower_snake_case.",
        "rule_id": "core::0140::lower-snake"
      }
    ]
  }
]
GitHub Actions

Emits ::error workflow commands that appear as inline annotations on pull request diffs:

::error file=example.proto,line=10,col=3::core::0140::lower-snake: Field must be in lower_snake_case.
Summary

A human-readable table with problem counts per rule:

RULE                                      COUNT
----------------------------------------  -----
core::0123::resource-pattern              1
core::0140::lower-snake                   3
----------------------------------------  -----
Total (2 files)                           4

Custom Rules

Alongside api-linter's rules, the plugin runs its own, under a protoc-contrib:: namespace so they are never mistaken for upstream ones. Disable one like any other rule.

protoc-contrib::0134::update-mask-writable-fields

On an AIP-134 Update*Request, the (buf.validate.field).field_mask.in allow-list on update_mask must list exactly the updated resource's writable fields: every top-level field not annotated OUTPUT_ONLY, IDENTIFIER or IMMUTABLE.

google.protobuf.FieldMask update_mask = 2 [
  (buf.validate.field).field_mask = {in: ["display_name", "description"]}
];

The list restates what google.api.field_behavior already says, and nothing else keeps the two in step. A writable field missing from it is one no client can update; a listed field that is not writable is one a client can overwrite. Each is reported separately, naming the field. Order does not matter, and the full-replacement wildcard * may be listed.

A nested path such as author.name is checked segment by segment: each must be a field of the message it indexes and writable, and each but the last a singular message — a mask cannot index into a scalar, a repeated field or a map. So author.create_time is reported when Author.create_time is OUTPUT_ONLY, however writable author is.

This is deliberately stricter than AIP-161, which has a server ignore an OUTPUT_ONLY path in a mask rather than reject it. Here field_mask.in rejects one — a client learns its write went nowhere instead of seeing it silently dropped — and this rule keeps OUTPUT_ONLY paths out of the list.

A request whose update_mask has no field_mask.in is not checked. The resource is the request field typed after it (book in UpdateBookRequest), or else its only message field besides update_mask. The option is read through the buf/validate/validate.proto the schema imports, so any protovalidate version works.

Configuration

Create an api-linter configuration file to enable or disable specific rules:

---
- disabled_rules:
    - core::0140::lower-snake
- enabled_rules:
    - core::0123::resource-pattern

Pass the config file path as a plugin option:

protoc \
  --aip-lint_out=. \
  --aip-lint_opt=config=api-linter.yaml \
  proto/example/v1/example.proto

See the api-linter configuration docs for the full configuration format.

CI Integration

Use output-format=github with set-exit-status to get inline annotations and fail the build when problems are found:

- name: Lint Protos
  run: |
    buf generate --template buf.gen.lint.yaml

Where buf.gen.lint.yaml contains:

version: v2
plugins:
  - local: protoc-gen-aip-lint
    out: .
    opt:
      - output-format=github
      - set-exit-status

Contributing

Contributions are welcome! Please open an issue or pull request.

To set up a development environment with Nix:

nix develop
go test ./...

License

MIT

Directories

Path Synopsis
cmd
internal
linter
Package linter wraps the Google API Linter (api-linter/v2) for use as a protoc plugin.
Package linter wraps the Google API Linter (api-linter/v2) for use as a protoc plugin.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL