Google API Linter

What it does

Configuration

Rules can be configured with CLI flags, a configuration file, or comments in proto files.checked 4 Oct 2001

Contributions

The project accepts contributions, and its contributing guide identifies writing a new lint rule as a common contribution.checked 4 Oct 2001

Corrections

When able, the linter suggests fixes for common mistakes and inconsistencies.checked 4 Oct 2001

Coverage limit

The documentation says some AIP guidance cannot be expressed as lint rules, and some expressible rules may not yet be written.checked 4 Oct 2001

Installation

The documentation instructs users to install the CLI with Go install into the local Go binary directory.checked 4 Oct 2001

Intended users

The tool is for developers working with APIs defined in protocol buffers and API standards.checked 4 Oct 2001

License

The software and its documentation are licensed under Apache 2.0.checked 4 Oct 2001

Output formats

The CLI supports YAML, JSON, GitHub, and summary table output, with YAML as the default.checked 4 Oct 2001

Purpose

The linter checks protocol buffer API surfaces for compliance with Google API standards documented in API Improvement Proposals.checked 4 Oct 2001

Rule groups

Rules are grouped by AIP block, with core and client library rules enabled by default and Cloud rules disabled by default.checked 4 Oct 2001

Rule requirements

Each linter rule must correspond to an AIP that mandates the behavior.checked 4 Oct 2001

Support

The project documentation links to GitHub to file an issue and view the source repository.checked 4 Oct 2001

Versioning

The project says it does not follow semantic versioning because adding or correcting rules can make previously clean files report problems.checked 4 Oct 2001