04. pre-commit フック

pre-commit とは

pre-commit は Python 製のフック管理フレームワークです。.pre-commit-config.yaml を置いて 1 度セットアップすれば、git commit を実行するたびに登録したチェックが自動で走り、失敗すれば commit が中断されます。

Terraform 用の標準的なフック集が antonbabenko/pre-commit-terraform です。fmt / validate / tflint / trivy / checkov / terraform-docs など、CI でも使う有名どころが揃っています。

インストール

1. pre-commit 本体

# Windows (winget)
winget install pre-commit

# macOS / Linux (Homebrew)
brew install pre-commit

# どこでも (pip)
pip install pre-commit

2. リポジトリで有効化

cd my-infra
pre-commit install
# .git/hooks/pre-commit が作られ、以後 git commit のたびに走る

.pre-commit-config.yaml

リポジトリ直下に置きます。下が Terraform プロジェクトの実用的な最小セットです。

repos:
  - repo: https://github.com/antonbabenko/pre-commit-terraform
    rev: v1.96.1   # 定期的に最新タグに更新
    hooks:
      - id: terraform_fmt
      - id: terraform_validate
      - id: terraform_tflint
        args:
          - --args=--config=__GIT_WORKING_DIR__/.tflint.hcl
      - id: terraform_trivy

  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v5.0.0
    hooks:
      - id: trailing-whitespace
      - id: end-of-file-fixer
      - id: check-yaml
      - id: check-merge-conflict

主要フックの役割

手元で走らせる

# 全ファイルに対して一括で
pre-commit run --all-files

# 直前のステージング分だけ（commit 時と同じ動作）
pre-commit run

# 1 つだけ
pre-commit run terraform_fmt --all-files

# フック自体のバージョン更新
pre-commit autoupdate

失敗例と直し方

$ git commit -m "feat: add s3"
terraform_fmt..........................................................Failed
- hook id: terraform_fmt
- files were modified by this hook

# fmt が自動で書き換えてくれているので、もう一度 add → commit
$ git add . && git commit -m "feat: add s3"