0

0

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

冰火之心

冰火之心

发布时间:2025-12-21 09:05:22

|

458人浏览过

|

来源于php中文网

原创

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

如何在git hooks(如pre-commit)中集成composer脚本来检查代码?

可以在 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

检查 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

该脚本会:

析稿Ai写作
析稿Ai写作

科研人的高效工具:AI论文自动生成,十分钟万字,无限大纲规划写作思路。

下载
  • 定位到 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 runcomposer 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 流程,降低协作门槛。

相关专题

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

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

2687

2023.09.01

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

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

1662

2023.10.11

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

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

1523

2023.10.11

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

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

953

2023.10.23

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

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

1420

2023.10.23

html怎么上传
html怎么上传

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

1235

2023.11.03

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

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

1488

2023.11.09

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

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

1306

2023.11.13

PS使用蒙版相关教程
PS使用蒙版相关教程

本专题整合了ps使用蒙版相关教程,阅读专题下面的文章了解更多详细内容。

23

2026.01.19

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PHP课程
PHP课程

共137课时 | 8.9万人学习

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

共6课时 | 8.5万人学习

PHP新手语法线上课程教学
PHP新手语法线上课程教学

共13课时 | 0.9万人学习

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

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