This repo defines Git pre-commit hooks intended for use with pre-commit. The currently supported hooks are:
- terraform-fmt: Automatically run
terraform fmt
on all Terraform code (*.tf
files). - shellcheck: Run
shellcheck
to lint files that contain a bash shebang - gofmt: Automatically run
gofmt
on all Goland code (*.go
files). - golint: Automatically run
golint
on all Golang code (*.go
files)
In each of your repos, add a file called .pre-commit-config.yml
with the following contents:
repos:
- repo: https://github.com/gruntwork-io/pre-commit
rev: <VERSION> # Get the latest from: https://github.com/gruntwork-io/pre-commit/releases
hooks:
- id: terraform-fmt
- id: shellcheck
- id: gofmt
- id: golint
Next, have every developer:
- Install pre-commit. E.g.
brew install pre-commit
. - Run
pre-commit install
in the repo.
That’s it! Now every time you commit a code change (.tf
file), the hooks in the hooks:
config will execute.
If you'd like to format all of your code at once (rather than one file at a time), you can run:
pre-commit run terraform-fmt --all-files
If you'd like to enforce all your hooks, you can configure your CI build to fail if the code doesn't pass checks by adding the following to your build scripts:
pip install pre-commit
pre-commit install
pre-commit run --all-files
If all the hooks pass, the last command will exit with an exit code of 0. If any of the hooks make changes (e.g., because files are not formatted), the last command will exit with a code of 1, causing the build to fail.
This code is released under the Apache 2.0 License. Please see LICENSE and NOTICE for more details.
Copyright © 2018 Gruntwork, Inc.