如何利用 composer scripts 自动化执行 pre-commit 钩子？-composer-PHP中文网

如何利用 composer scripts 自动化执行 pre-commit 钩子？

穿越時空

发布： 2025-11-28 18:06:06

原创

822人浏览过

答案：通过Composer脚本与Git钩子集成实现自动化代码检查。在composer.json中定义check-cs、analyse、test及pre-commit脚本，创建scripts/pre-commit钩子脚本并设置可执行权限，利用post-install-cmd和post-update-cmd自动安装钩子，确保每次提交前运行代码规范、静态分析和测试，提升团队协作一致性。

如何利用 composer scripts 自动化执行 pre-commit 钩子？

在 PHP 项目中，可以利用 Composer 的 scripts 功能结合 Git 的 pre-commit 钩子实现自动化检查，比如运行代码格式化、静态分析或单元测试。这样能确保每次提交的代码符合质量标准。

1. 定义 Composer Scripts

在项目的 composer.json 中添加自定义脚本，例如执行 PHP CS Fixer、PHPStan 或 PHPUnit：

{
    "scripts": {
        "check-cs": "php-cs-fixer fix --dry-run --diff",
        "analyse": "phpstan analyse src --level=5",
        "test": "phpunit",
        "pre-commit": [
            "@check-cs",
            "@analyse",
            "@test"
        ]
    }
}

登录后复制

这里定义了三个独立命令和一个组合脚本 pre-commit，它会在提交前依次执行代码规范检查、静态分析和测试。

2. 创建 Git pre-commit 钩子

Git 的钩子脚本位于 .git/hooks/pre-commit，但直接放这里不利于团队共享。推荐将钩子放在项目内的 scripts 目录，并通过安装脚本软链到 .git/hooks。

创建文件 scripts/pre-commit：

#!/bin/sh
echo "Running pre-commit checks via Composer..."
<h1>执行 Composer 脚本</h1><p>composer run-script pre-commit</p><h1>检查上一条命令是否成功</h1><p>if [ $? -ne 0 ]; then
echo "Pre-commit checks failed. Commit aborted."
exit 1
fi</p><p>echo "All checks passed. Commit allowed."
exit 0

登录后复制

确保该脚本可执行：
chmod +x scripts/pre-commit

Noiz Agent

AI声音创作Agent平台

323

查看详情

3. 自动安装钩子（可选）

为了让团队成员无需手动设置，可以在 composer.json 中使用 post-install-cmd 和 post-update-cmd 自动创建符号链接：

"scripts": {
    "post-install-cmd": [
        "Scripts\Composer\HookHandler::installHooks"
    ],
    "post-update-cmd": [
        "Scripts\Composer\HookHandler::installHooks"
    ],
    "pre-commit": [ ... ]
}

登录后复制

然后创建 PHP 类 src/Composer/HookHandler.php 来处理安装逻辑：

<?php
<p>namespace ScriptsComposer;</p><p>class HookHandler
{
public static function installHooks()
{
$hookDir = <strong>DIR</strong> . '/../../.git/hooks';
$source  = <strong>DIR</strong> . '/../../scripts/pre-commit';
$target  = $hookDir . '/pre-commit';</p><pre class="brush:php;toolbar:false;"><pre class="brush:php;toolbar:false;">    if (file_exists($source) && is_dir($hookDir)) {
        if (!file_exists($target)) {
            symlink($source, $target);
            echo "Git pre-commit hook installed.
";
        }
    }
}

登录后复制

}