git-hooks-setup

Git フックの設定

目次

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

概要

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

使用する場面

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

クイックスタート

最小限の動作例：

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

# Install Husky
npm install husky --save-dev

# Initialize Husky
npx husky install

# Create pre-commit hook
npx husky add .husky/pre-commit "npm run lint"

# Create commit-msg hook
npx husky add .husky/commit-msg 'npx --no -- commitlint --edit "$1"'

# Create pre-push hook
npx husky add .husky/pre-push "npm run test"

# Create post-merge hook
npx husky add .husky/post-merge "npm install"

リファレンスガイド

詳細な実装については、references/ ディレクトリを参照してください。

ガイド	内容
Husky のインストールと設定	Husky のインストールと設定
コミット前フック（Node.js）	コミット前フック（Node.js）
コミットメッセージの検証	コミットメッセージの検証
Commitlint の設定	Commitlint の設定、プッシュ前フック（包括版）
Pre-commit フレームワーク（Python）	Pre-commit フレームワーク（Python）
シークレット検出フック	シークレット検出フック、package.json での Husky の設定

ベストプラクティス

✅ 推奨事項

• コミット前のリンティングとフォーマットを適用する
• コミットメッセージの形式を検証する
• コミット前にシークレットをスキャンする
• プッシュ前にテストを実行する
• フックをスキップする場合は --no-verify を使用する（まれなケースに限る）
• フックの要件を README に記載する
• 一貫性のあるフック設定を使用する
• フックを高速に保つ（5 秒未満）
• 役立つエラーメッセージを表示する
• 明確な警告を表示したうえで、開発者がフックを回避できるようにする

❌ 禁止事項

• --no-verify を使ってチェックをスキップする
• コミット対象のファイルにシークレットを保存する
• 一貫性のない実装を使用する
• フックのエラーを無視する
• コミット前にテストスイート全体を実行する