如何设置Git钩子(hooks)在提交前自动运行composer脚本(如lint, test)?

尼克
发布: 2025-11-19 14:55:02
原创
516人浏览过
可通过 Git pre-commit 钩子在提交前自动运行 Composer 脚本。2. 在 .git/hooks/ 目录创建可执行的 pre-commit 文件,调用 composer run lint 和 test 进行代码检查与测试。3. 确保 composer.json 定义了相关脚本命令。4. 钩子不会自动共享,建议将脚本放入项目并软链接安装。5. 可优化为仅对修改的文件运行检查。6. 紧急时可用 git commit --no-verify 跳过验证。设置后每次提交都将自动确保代码质量。

如何设置git钩子(hooks)在提交前自动运行composer脚本(如lint, test)?

在提交代码前自动运行 Composer 脚本(如代码检查、单元测试),可以通过 Git 的 pre-commit 钩子实现。这个钩子会在每次执行 git commit 时触发,适合用来运行 lint 或 test 命令,确保提交的代码符合质量标准。

1. 创建 pre-commit 钩子脚本

进入你的项目根目录下的 .git/hooks/ 目录:

cd .git/hooks

创建或编辑 pre-commit 文件:

touch pre-commit chmod +x pre-commit

用编辑器打开 pre-commit,写入以下内容:

#!/bin/sh

运行 composer lint(假设你在 composer.json 中定义了 lint 脚本)

composer run lint --no-interaction

怪兽智能全息舱
怪兽智能全息舱

专业的AI数字人平台,定制数字人专属IP

怪兽智能全息舱 9
查看详情 怪兽智能全息舱

检查上一条命令是否成功

if [ $? -ne 0 ]; then echo "❌ Lint 失败,提交被阻止" exit 1 fi

运行 composer test

composer run test --no-interaction

if [ $? -ne 0 ]; then echo "❌ 测试失败,提交被阻止" exit 1 fi

echo "✅ 代码检查和测试通过,允许提交" exit 0

2. 在 composer.json 中定义脚本

确保你的 composer.json 中定义了 linttest 命令,例如:

"scripts": { "lint": "php-cs-fixer fix --dry-run --config=.php-cs-fixer.php", "test": "phpunit --stop-on-failure" }

这样 composer run lintcomposer run test 就能正确执行。

3. 注意事项与优化建议

  • Git 钩子不会随项目自动共享,团队成员需手动设置或通过脚本安装。
  • 可将钩子脚本放在项目根目录(如 scripts/pre-commit),然后在初始化项目时软链接到 .git/hooks/
ln -sf ../../scripts/pre-commit .git/hooks/pre-commit
  • 考虑只对相关文件运行检查(如仅 PHP 文件被修改时才 lint),提升效率。
  • 若想跳过钩子(紧急情况),使用 git commit --no-verify(但应谨慎使用)。

基本上就这些。设置完成后,每次提交都会自动检查代码质量和测试通过情况,帮助维护项目稳定性。

以上就是如何设置Git钩子(hooks)在提交前自动运行composer脚本(如lint, test)?的详细内容,更多请关注php中文网其它相关文章!

最佳 Windows 性能的顶级免费优化软件
最佳 Windows 性能的顶级免费优化软件

每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。

下载
来源:php中文网
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
最新问题
开源免费商场系统广告
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新 English
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送
PHP中文网APP
随时随地碎片化学习

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号