0

0

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

尼克

尼克

发布时间:2025-11-19 14:55:02

|

542人浏览过

|

来源于php中文网

原创

可通过 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

ima.copilot
ima.copilot

腾讯大混元模型推出的智能工作台产品,提供知识库管理、AI问答、智能写作等功能

下载

检查上一条命令是否成功

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(但应谨慎使用)。

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

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

1930

2023.09.01

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

1263

2023.10.11

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

1169

2023.10.11

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

948

2023.10.23

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

1399

2023.10.23

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

1229

2023.11.03

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1439

2023.11.09

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1303

2023.11.13

桌面文件位置介绍
桌面文件位置介绍

本专题整合了桌面文件相关教程,阅读专题下面的文章了解更多内容。

0

2025.12.30

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
React核心原理新老生命周期精讲
React核心原理新老生命周期精讲

共12课时 | 1万人学习

PHP课程
PHP课程

共137课时 | 8.1万人学习

JavaScript ES5基础线上课程教学
JavaScript ES5基础线上课程教学

共6课时 | 6.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

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