如何用composer scripts设置git的pre-commit钩子

技术教程
2025-10-15 20:01:02

答案：通过Composer的scripts功能可自动化配置Git pre-commit钩子，确保代码检查流程统一。1. 创建scripts/pre-commit脚本并赋予执行权限；2. 在composer.json中配置post-install-cmd和post-update-cmd命令复制或调用钩子；3. 推荐使用自定义PHP类ScriptsComposerScriptHandler处理钩子安装逻辑；4. 注意.git/hooks目录不纳入版本控制，需在文档中告知团队成员运行composer install以启用钩子，避免因路径或权限问题导致失败。

在项目中使用 Composer 的 scripts 功能来设置 Git 的 pre-commit 钩子，是一种自动化代码检查流程的好方法。你可以通过 Composer 在安装或更新依赖时自动配置钩子，避免手动设置的遗漏。

1. 创建 pre-commit 脚本文件

在项目根目录下创建一个用于执行 pre-commit 逻辑的脚本，比如：scripts/pre-commit。

内容示例如下：

#!/bin/bash
echo "Running pre-commit checks..."
<h1>运行 PHP 语法检查</h1><p>git diff --cached --name-only --diff-filter=ACM | grep '.php$' | xargs -r php -l</p><h1>可加入其他检查，如 PHP-CS-Fixer、PHPStan 等</h1><h1>vendor/bin/php-cs-fixer fix --dry-run --using-cache=no</h1><h1>vendor/bin/phpstan analyse src/</h1><p>if [ $? -ne 0 ]; then
echo "Pre-commit checks failed."
exit 1
fi</p><p>echo "All checks passed."
exit 0</p>

确保该脚本可执行：

chmod +x scripts/pre-commit

2. 配置 composer.json 中的 scripts

在 composer.json 中添加 post-install-cmd 和 post-update-cmd，用于自动链接 pre-commit 钩子。

示例配置：

"scripts": {
    "post-install-cmd": [
        "Scripts\Composer\ScriptHandler::linkPreCommitHook"
    ],
    "post-update-cmd": [
        "Scripts\Composer\ScriptHandler::linkPreCommitHook"
    ]
}

也可以直接使用匿名函数或 shell 命令（简单场景）：

"scripts": {
    "post-install-cmd": [
        "cp scripts/pre-commit .git/hooks/pre-commit"
    ],
    "post-update-cmd": [
        "cp scripts/pre-commit .git/hooks/pre-commit"
    ]
}

这种方式简单直接，适合小项目。

3. 使用自定义 PHP 类处理（推荐方式）

对于更复杂的逻辑，建议写一个 PHP 类来处理钩子创建。

美图云修

商业级AI影像处理工具

61 查看详情美图云修

创建文件：src/Composer/ScriptHandler.php

<?php
<p>namespace ScriptsComposer;</p><p>use ComposerScriptEvent;</p><p>class ScriptHandler
{
public static function linkPreCommitHook(Event $event)
{
$from = <strong>DIR</strong> . '/../../scripts/pre-commit';
$to = <strong>DIR</strong> . '/../../.git/hooks/pre-commit';</p><pre class="brush:php;toolbar:false;"><code>    if (file_exists($from)) {
        copy($from, $to);
        chmod($to, 0755); // 确保可执行
        echo "Git pre-commit hook installed.
";
    } else {
        echo "Pre-commit script not found: $from
";
    }
}

}

确保 autoload 能加载这个类，或者将脚本逻辑改为直接调用命令。