可在 Git pre-commit 钩子中调用 Composer 脚本实现提交前自动代码检查,需在 composer.json 定义 scripts(如 "check"),钩子脚本切换至仓库根目录执行 composer check,并兼容无 composer.json 场景;推荐使用 brainmaestro/composer-git-hooks 或 phpro/grumphp 统一管理。

可以在 Git 的 pre-commit 钩子中调用 Composer 脚本,实现提交前自动执行代码检查(如 PHP 语法校验、静态分析、格式化等)。关键在于让钩子正确识别项目根目录下的 composer.json 和本地 vendor/bin/ 中的工具。
确保 Composer 脚本已定义
先在 composer.json 的 scripts 段中定义好检查命令,例如:
"scripts": {
"check": [
"@phpcs",
"@phpstan",
"@php-cs-fixer --dry-run"
],
"phpcs": "phpcs --standard=PSR12 src/",
"phpstan": "phpstan analyse --level=7 src/",
"php-cs-fixer": "php-cs-fixer fix --config=.php-cs-fixer.php"
}这样运行 composer check 就能一次性触发多个检查。注意添加 --dry-run 或对应参数,避免修改文件影响暂存区。
编写 pre-commit 钩子脚本
在项目根目录创建 .git/hooks/pre-commit(无扩展名),赋予可执行权限(chmod +x .git/hooks/pre-commit),内容如下:
#!/bin/sh # 切换到 git 仓库根目录,确保 composer 命令能找到 composer.json GIT_ROOT=$(git rev-parse --show-toplevel) cd "$GIT_ROOT" || exit 1检查 composer.json 是否存在
if [ ! -f "composer.json" ]; then echo "⚠️ composer.json not found. Skipping Composer checks." exit 0 fi
执行预设的检查脚本
echo "? Running Composer check..." if ! composer check; then echo "❌ Composer check failed. Please fix issues before committing." exit 1 fi
该脚本会:
- 定位到 Git 仓库根目录,避免因工作路径问题找不到
composer.json - 跳过没有
composer.json的情况(兼容非 PHP 子模块) - 失败时中止提交,并提示用户修复
处理依赖路径与环境差异
如果项目使用 composer install --no-dev 部署,但开发时需要 phpcs 等 dev-only 工具,需确保:
- 这些工具声明在
require-dev中(如"squizlabs/php_codesniffer": "^3.6") - 钩子只在开发环境启用(可通过检查
vendor/bin/phpcs是否存在来兜底) - 避免硬编码
vendor/bin/xxx,优先走composer run或composer exec(Composer 2.2+ 支持)
例如改用:composer exec -- phpstan analyse --level=7 src/,更健壮。
推荐搭配 husky-like 工具管理钩子
手动维护 .git/hooks/ 文件易丢失或不同步。建议用 composer-plugin 或独立工具统一管理:
-
brainmaestro/composer-git-hooks:通过composer require --dev brainmaestro/composer-git-hooks安装,然后在composer.json中配置 -
phpro/grumphp:更重但功能全面,支持多语言、自定义任务、报告输出等
它们会自动注册钩子、支持 Windows/macOS/Linux,并可纳入 composer install 流程,降低协作门槛。










