Git Hooks セットアップ

目次

• 概要
• 使用場面
• クイックスタート
• リファレンスガイド
• ベストプラクティス

概要

Git フックを設定して、コード品質基準を実施し、自動チェックを実行し、問題のあるコミットが共有リポジトリにプッシュされるのを防止します。

使用場面

• コミット前のコード品質チェック
• コミットメッセージの検証
• コミットへのシークレット混入防止
• プッシュ前のテスト実行
• コードフォーマット強制
• リント設定
• チーム全体の標準実装

クイックスタート

最小限の動作例:

#!/bin/bash
# setup-husky.sh

# Husky をインストール
npm install husky --save-dev

# Husky を初期化
npx husky install

# pre-commit フックを作成
npx husky add .husky/pre-commit "npm run lint"

# commit-msg フックを作成
npx husky add .husky/commit-msg 'npx --no -- commitlint --edit "$1"'

# pre-push フックを作成
npx husky add .husky/pre-push "npm run test"

# post-merge フックを作成
npx husky add .husky/post-merge "npm install"

リファレンスガイド

references/ ディレクトリの詳細な実装例:

ガイド	内容
Husky インストールと設定	Husky インストールと設定
Pre-commit フック (Node.js)	Pre-commit フック (Node.js)
コミットメッセージ検証	コミットメッセージ検証
Commitlint 設定	Commitlint 設定、Pre-push フック (包括的)
Pre-commit フレームワーク (Python)	Pre-commit フレームワーク (Python)
シークレット検出フック	シークレット検出フック、package.json 内の Husky

ベストプラクティス

✅ DO

• コミット前のリントとフォーマット強制
• コミットメッセージ形式の検証
• コミット前のシークレットスキャン
• プッシュ前のテスト実行
• --no-verify でのフックスキップのみ (稀)
• README にフック要件を記載
• フック設定を統一
• フックを高速化 (< 5秒)
• 有用なエラーメッセージを提供
• 明確な警告を示した上で開発者によるスキップを許可

❌ DON'T

• --no-verify でのチェックスキップ
• コミットされたファイルにシークレットを保存
• 実装に矛盾がある状態
• フックエラーを無視
• pre-commit でフルテストスイートを実行