craftech-io / pre-commit

A collection of pre-commit hooks used by Craftech

Pre-commit hooks

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).

General Usage

In each of your repos, add a file called .pre-commit-config.yaml with the following contents:

repos:
  - repo: https://github.com/craftech-io/pre-commit
    rev: <VERSION> # Get the latest from: https://github.com/craftech-io/pre-commit/releases
    hooks:
      - id: terraform-fmt

Next, have every developer:

1. Install pre-commit. E.g. brew install pre-commit.
2. 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.

Running Against All Files At Once

Example: Formatting all files

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

License

This code is released under the Apache 2.0 License. Please see LICENSE for more details.