如何在Git Hooks(如pre-commit)中集成Composer脚本来检查代码?

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

如何在Git Hooks(如pre-commit)中集成Composer脚本来检查代码?-第1张图片-佛山资讯网

可以在 Git 的 pre-commit 钩子中调用 Composer 脚本,实现提交前自动执行代码检查(如 PHP 语法校验、静态分析、格式化等)。关键在于让钩子正确识别项目根目录下的 composer.json 和本地 vendor/bin/ 中的工具。

确保 Composer 脚本已定义

先在 composer.jsonscripts 段中定义好检查命令,例如:

"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
<h1>检查 composer.json 是否存在</h1><p>if [ ! -f "composer.json" ]; then
echo "⚠️  composer.json not found. Skipping Composer checks."
exit 0
fi</p><h1>执行预设的检查脚本</h1><p>echo "? Running Composer check..."
if ! composer check; then
echo "❌ Composer check failed. Please fix issues before committing."
exit 1
fi

登录后复制

该脚本会:

标签: php linux js git json composer windows 编码 工具 mac ai macos wi

发布评论 0条评论)

还木有评论哦,快来抢沙发吧~