pre-commitフックで実現する、チーム開発の品質自動化

開発者であれば、「タイポ修正」や「リンター適用」といったコミットメッセージを一度は書いた経験があるでしょう。このような些細なミスは、コードレビューの過程で不要な時間を消費させ、チーム全体の生産性を低下させる原因となります。もし、これらのミスをコミットする前に自動的に修正できるとしたらどうでしょうか？まさにこの点で、Gitフック、特にpre-commitフックが強力な解決策として登場します。

この記事では、Gitフックの基本概念から始め、チーム単位のプロジェクトでコード品質を一貫して維持し、開発ワークフローを革新的に改善できるpre-commitフレームワークの設定と活用法を詳しく解説します。

Gitフックとは何か？

Gitフックとは、Gitの特定のイベント（例：コミット、プッシュ）が発生した際に自動的に実行されるスクリプトです。これにより、開発者は特定の条件が満たされない場合にコミットを中止させたり、コミットメッセージのフォーマットを強制したり、テストを自動実行したりするなど、様々な自動化タスクを実行できます。

Gitフックのスクリプトは、すべてのGitリポジトリの.git/hooks/ディレクトリ内に配置されています。git initで新しいリポジトリを作成すると、このディレクトリ内に様々なサンプル（.sample拡張子）が生成されているのを確認できます。

$ ls .git/hooks/
applypatch-msg.sample         pre-commit.sample           pre-rebase.sample
commit-msg.sample             pre-merge-commit.sample     pre-receive.sample
fsmonitor-watchman.sample     pre-push.sample             update.sample
post-update.sample            prepare-commit-msg.sample

これらのサンプルファイルの一つから.sampleという拡張子を削除し、実行権限を付与することで、そのフックが有効になります。例えば、pre-commit.sampleファイルの名前をpre-commitに変更して実行権限を与えると、git commitコマンドを実行する直前にそのスクリプトが実行されるようになります。

最も強力なフック：pre-commit

数あるフックの中でも、pre-commitは最も広く使われ、強力なフックの一つです。コミットが実際に作成される直前に実行されるため、コード品質に関連するほぼすべてのチェックをこの段階で実行できます。

• コードスタイルチェック（リンティング）：コードがチームのコーディング規約に従っているか確認します。
• コードフォーマット：定められたルールに従ってコードスタイルを自動的に修正します。
• 秘密鍵や機密情報の漏洩防止：コミットに誤って含まれたAPIキーやパスワードを検出します。
• デバッグ用コードの混入防止：console.logやdebuggerのようなコードがコミットされるのを防ぎます。
• ユニットテストの実行：コミットしようとしているコードが既存のテストをパスするかを素早く確認します。

従来のGitフック方式の限界

.git/hooks/ディレクトリに直接シェルスクリプトを作成する方法はシンプルですが、チームプロジェクトではいくつかの致命的な欠点があります。

1. バージョン管理ができない：.gitディレクトリはGitの追跡対象ではないため、フックスクリプトをチームメンバーと共有し、バージョンを管理することが非常に困難です。
2. 設定が煩雑：新しいチームメンバーがプロジェクトに参加するたびに、手動でフックスクリプトを設定し、実行権限を付与する必要があります。
3. 多様な言語環境への対応の難しさ：Python、JavaScript、Javaなど複数の言語を使用するプロジェクトでは、各言語に適したリンターやフォーマッターを設定・管理することが複雑になります。

これらの問題を解決するために登場したのが、pre-commitフレームワークです。

pre-commitフレームワークによるスマートな管理

pre-commitはPythonで作成されたGitフック管理フレームワークです。このフレームワークは、.pre-commit-config.yamlという設定ファイルを通じてフックを定義・管理します。このファイルはプロジェクトのルートに配置され、バージョン管理が可能なため、チームメンバー全員が同じフック設定を共有できます。

1. インストールと初期設定

まず、pre-commitをインストールします。Pythonのパッケージマネージャーであるpipを使用するのが一般的です。

# pipを使用してインストール
pip install pre-commit

# Homebrew (macOS)を使用してインストール
brew install pre-commit

インストールが完了したら、プロジェクトのルートディレクトリに.pre-commit-config.yamlファイルを作成します。このファイルに、使用するフックを定義します。

以下は基本的な設定ファイルの例です。

# .pre-commit-config.yaml
repos:
-   repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.6.0 # 常に最新の安定版を使用することを推奨します
    hooks:
    -   id: trailing-whitespace # ファイル末尾の空白を削除
    -   id: end-of-file-fixer # ファイルの末尾に改行を追加
    -   id: check-yaml # YAMLファイルの構文をチェック
    -   id: check-added-large-files # 大容量ファイルが追加されるのを防止

設定ファイルの作成が終わったら、次のコマンドを実行してGitフックを.git/hooks/pre-commitにインストールします。この作業は、プロジェクトを最初にクローンしたときに一度だけ実行すれば十分です。

pre-commit install

これで、git commitを試みると、pre-commitがステージングされたファイルに対して設定済みのフックを自動的に実行します。

2. 様々な言語向けのフックを追加する

pre-commitの真の強力さは、多様な言語やツールを容易に統合できる点にあります。例えば、Pythonプロジェクトではblack（フォーマッター）とruff（リンター）、JavaScriptプロジェクトではprettier（フォーマッター）とeslint（リンター）を追加できます。

Pythonプロジェクトの例 (black, ruff)

# .pre-commit-config.yaml
repos:
-   repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.6.0
    hooks:
    -   id: trailing-whitespace
    -   id: end-of-file-fixer
-   repo: https://github.com/psf/black
    rev: 24.4.2
    hooks:
    -   id: black
-   repo: https://github.com/astral-sh/ruff-pre-commit
    rev: v0.4.4
    hooks:
    -   id: ruff
        args: [--fix] # 自動修正可能なエラーは修正する
    -   id: ruff-format

JavaScript/TypeScriptプロジェクトの例 (prettier, eslint)

# .pre-commit-config.yaml
repos:
-   repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.6.0
    hooks:
    -   id: trailing-whitespace
    -   id: end-of-file-fixer
-   repo: https://github.com/prettier/prettier
    rev: 3.2.5
    hooks:
    -   id: prettier
        # 追加の引数を渡して特定のファイルタイプにのみ適用可能
        # types: [javascript, typescript, css, markdown]
-   repo: local # ローカルにインストールされたeslintを使用する場合
    hooks:
    -   id: eslint
        name: eslint
        entry: npx eslint --fix
        language: node
        types: [javascript, typescript]
        # 初回実行速度向上のため、常に実行するように設定
        always_run: true
        # ステージングされたファイルのみを引数として渡す
        pass_filenames: false

repo: localを使用すると、package.jsonに記載されたバージョンのツールを使用できるため、チームメンバー間のツールバージョンの不一致問題を解決できます。

3. 実際のワークフロー

これで全ての設定が完了しました。開発者がコードを修正した後にコミットを試みると、何が起こるでしょうか？

1. 開発者がファイルを修正し、git add .コマンドでステージングします。
2. git commit -m "機能追加"コマンドを実行します。
3. pre-commitが自動的に起動し、.pre-commit-config.yamlに定義されたフックをステージングされたファイルに対して順次実行します。
4. 成功シナリオ：すべてのフックが正常にパスすると、コミットが通常通り完了します。

   $ git commit -m "新機能の追加"
   Trim Trailing Whitespace........................................Passed
   Fix End of Files................................................Passed
   Check Yaml......................................................Passed
   black...........................................................Passed
   ruff............................................................Passed
   [feature/new-logic 1a2b3c4] 新機能の追加
    2 files changed, 15 insertions(+)
   

5. 失敗シナリオ：一つ以上のフックが失敗した場合（例：リンティングエラーが発見された）、pre-commitは該当のエラーを出力し、コミットを中断します。

   $ git commit -m "バグ修正"
   Trim Trailing Whitespace........................................Passed
   Fix End of Files................................................Passed
   black...........................................................Failed
   - hook id: black
   - files were modified by this hook
   
   reformatted my_bad_file.py
   
   All done! ✨ 🍰 ✨
   1 file reformatted.
   

   この場合、blackやprettierのように自動修正機能を持つフックはファイルを直接修正します。開発者は修正されたファイルを再度ステージング（git add my_bad_file.py）し、再びコミットを試みるだけです。このプロセスにより、「リンター修正」のような雑然としたコミットを残すことなく、常にクリーンなコードを維持できます。

結論：なぜpre-commitを導入すべきか？

pre-commitフレームワークを導入することは、単なるツールの追加を超え、開発文化そのものを改善する効果的な方法です。

• 一貫したコード品質：すべてのチームメンバーが同じルールに従ってコードを記述・チェックするため、プロジェクト全体のコード品質が向上します。
• レビュー時間の短縮：コードレビュアーはスタイルや些細なエラーではなく、ビジネスロジックにより集中できます。
• 自動化されたワークフロー：開発者はリンティングやフォーマットといった反復的な作業を気にすることなく、開発に専念できます。
• ミスの防止：機密情報やデバッグ用コードがリポジトリにコミットされるのを事前に防ぎ、セキュリティを強化します。

最初は設定を追加し、チームメンバーに使い方を案内する少しの努力が必要かもしれません。しかし、この小さな投資は、長期的にはチームの生産性を最大化し、より堅牢で保守しやすいコードを作る礎となるでしょう。今すぐあなたのプロジェクトにpre-commitを導入し、自動化されたコード品質管理の力を体験してみてください。