Gitコミット時に自動チェック！HuskyでESLint・PHPStan・ユニットテストを効率化する方法

Last updated at 2025-01-05Posted at 2025-01-05

概要

Gitフックを活用して、ESLint、PHPStan、ユニットテストを自動的に実行することで、手動作業を減らし、コード品質を保つ方法を解説します。本記事では、Huskyを使った設定手順を紹介し、効率的なチーム開発を実現します。コミット前に自動でチェックを行い、エラーを未然に防ぐフローを構築します。

目的

この記事の目的は、Gitコミット時に静的解析やテストを自動実行し、コード品質を確保する仕組みを構築することです。これにより、以下を実現します：

コミット時のエラー防止
- ESLint（JavaScript/TypeScriptの静的解析）、PHPStan（PHPの静的解析）、ユニットテストをコミット時に自動実行し、不備があればコミットを防止します。
- チーム全体でコード品質を統一し、コードレビューや修正の負担を軽減します。
静的解析とテストのルール遵守
- 開発者が静的解析ツールやテストを意図的に無視するのを防ぎ、ルールの徹底を図ります。
効率的なチーム開発の実現
- 自動チェックの仕組みを導入することで、手動でのチェックが不要になり、効率的な開発フローを確立します。

前提条件

この記事を進めるにあたり、以下の条件を満たしていることを確認してください：

静的解析ツールが設定済みであること
- 前回の記事を参考に、以下のツールをプロジェクトに導入済みであること：
  - PHPStan（またはLarastan）
  - ESLint
  - TypeScript
ユニットテストが設定済みであること
- Laravelのテストフレームワークを使用してユニットテストが実行できる環境が整っていること。
前回までの設定が完了していること
- 以下のシリーズ記事を参考にし、PHPプロジェクトや環境構築が済んでいること：
- Laravel + Vue3 チーム開発を効率化！統一環境構築と品質向上の完全ガイド
- DockerでPHP 8.4/Nginx + Node 22 + MySQL環境を構築する方法
- Laravel 11 + Inertia.js + Vue 3 + TypeScriptでモダンなフルスタック環境を構築
- Laravel 11 + Vue 3プロジェクトにSassとBootstrap 5を導入する方法
- Laravelでテストコード込みのサービス・リポジトリパターンを実装する方法
- DevContainerを使いVSCodeでPHPStan・ESLint・TypeScriptを統合して静的解析をエラー検知する方法

この記事では、これらの前提条件を基に、Huskyを活用して効率的なコードチェックの仕組みを導入する方法を解説します！

具体的な手順

この記事では、Huskyを導入し、コミット時にESLint、PHPStan、ユニットテストの自動チェックを行う手順を解説します。

Huskyのインストール

開発コンテナのターミナルで以下のコマンドを実行し、Huskyをインストールします：開発コンテナのターミナルにて

$ npm install husky --save-dev

package.jsonの修正

`package.json`

prepareスクリプトにhusky installを追加します。これにより、Huskyの初期設定が行われます。

package.json

{
~~~省略~~~
    "scripts": {
        "build": "vite build",
        "dev": "vite",
        "type-check": "vue-tsc --noEmit",
        "prepare": "husky install"
    },
~~~省略~~~
}

pre-commit作成

以下のコマンドを実行して、Huskyのpre-commitフックを作成します：

$ npx husky add .husky/pre-commit "npm test"

pre-commitの修正

`.husky/pre-commit`

コミット時に以下を自動実行する設定を追記します：

ESLint/TypeScriptのチェック（ステージされたファイルのみ）
PHPStanの静的解析（ステージされたPHPファイルのみ）
PHPUnitでのユニットテスト実行（全テストを実行）

以下は、最終的な.husky/pre-commitの内容です：

pre-commit

#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

export PATH="$HOME/.nvm/versions/node/v22.12.0/bin:$PATH"
npx lint-staged
LINT_STAGED_STATUS=$?

# ステージされた PHP ファイルを取得
STAGED_FILES=$(git diff --cached --name-only --diff-filter=d | awk '/\.php$/')

# Larastan（PHPStan）の静的解析
if [ -n "$STAGED_FILES" ]; then
    echo "Running PHPStan on staged files..."
    vendor/bin/phpstan analyse $STAGED_FILES
    LARASTAN_STATUS=$?
else
    echo "No PHP files staged for PHPStan check."
    LARASTAN_STATUS=0
fi

# PHPUnit のユニットテスト実行
php artisan test
PHPUNIT_STATUS=$?

# 結果を判定
if [ $LINT_STAGED_STATUS -ne 0 ] || [ $LARASTAN_STATUS -ne 0 ] || [ $PHPUNIT_STATUS -ne 0 ]; then
    echo "❌ Pre-commit checks failed. Fix the issues before committing."
    exit 1
fi

echo "✅ All checks passed. Proceeding with commit."

この手順に従うことで、Gitコミット時にコードの品質を自動的にチェックし、チーム全体で一貫性のあるコードベースを維持することが可能になります！

確認

Huskyのpre-commitフックが正しく動作しているかを確認します。以下に各チェックのエラー発生時や成功時の動作を示します。

Git操作方法について

Huskyのpre-commitフックは、ターミナルからのgit commitコマンドだけでなく、VSCodeのソース管理ビュー（コミットボタン）からのコミット操作にも対応しています。

ソース管理ビューの場所
VSCode左側の「ソース管理」アイコン（もしくはCtrl+Shift+G）をクリックすると、コミット用の入力欄とボタンが表示されます。
Huskyの動作
VSCode内でコミットを実行した場合も、pre-commitフックが呼び出され、自動チェックが行われます。

以下では、具体的なエラー発生時や成功時の動作を示します。