chore: add a pre-commit hook config (#774)

This matches the Bazel recommendation from https://github.com/bazel-contrib/rules-template
for configuring an optional, client-side automation for formatting BUILD/bzl files before sending a PR.

It has been found to save a bunch of time for contributors who otherwise trip over the server-side
CI check and have to do an extra iteration to get their PR green.

I imagine Googlers are already relying on some Piper feature to do the equivalent when they work on this code,
so they haven't noticed the deficiency.
This commit is contained in:
Alex Eagle 2023-11-06 10:21:34 -08:00 committed by GitHub
parent 5664e0ed1b
commit a2250d999f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 0 deletions

12
.pre-commit-config.yaml Normal file
View File

@ -0,0 +1,12 @@
# Optional local setup for a git pre-commit hook to automatically format/lint.
# This avoids sending a red PR and having to find the buildifier output on the CI results page.
# See https://pre-commit.com for more information on installing pre-commit.
# See https://pre-commit.com/hooks.html for more hooks.
repos:
# Check formatting and lint for starlark code
- repo: https://github.com/keith/pre-commit-buildifier
rev: 6.3.3
hooks:
- id: buildifier
- id: buildifier-lint