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

该脚本会:

GitHub Copilot
GitHub Copilot

GitHub 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 流程,降低协作门槛。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
composer是什么插件
composer是什么插件

Composer是一个PHP的依赖管理工具,它可以帮助开发者在PHP项目中管理和安装依赖的库文件。Composer通过一个中央化的存储库来管理所有的依赖库文件,这个存储库包含了各种可用的依赖库的信息和版本信息。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

151

2023.12.25

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

418

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

535

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

311

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

77

2025.09.10

require的用法
require的用法

require的用法有引入模块、导入类或方法、执行特定任务。想了解更多require的相关内容,可以阅读本专题下面的文章。

466

2023.11.27

自建git服务器
自建git服务器

git服务器是目前流行的分布式版本控制系统之一,可以让多人协同开发同一个项目。本专题为大家提供自建git服务器相关的各种文章、以及下载和课程。

723

2023.07.05

git和svn的区别
git和svn的区别

git和svn的区别:1、定义不同;2、模型类型不同;3、存储单元不同;4、是否拥有全局版本号;5、内容完整性不同;6、版本库不同;7、克隆目录速度不同;8、分支不同。php中文网为大家带来了git和svn的相关知识、以及相关文章等内容。

553

2023.07.06

Python 自然语言处理(NLP)基础与实战
Python 自然语言处理(NLP)基础与实战

本专题系统讲解 Python 在自然语言处理(NLP)领域的基础方法与实战应用,涵盖文本预处理(分词、去停用词)、词性标注、命名实体识别、关键词提取、情感分析,以及常用 NLP 库(NLTK、spaCy)的核心用法。通过真实文本案例,帮助学习者掌握 使用 Python 进行文本分析与语言数据处理的完整流程,适用于内容分析、舆情监测与智能文本应用场景。

10

2026.01.27

热门下载

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

精品课程

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

共137课时 | 9.7万人学习

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

共6课时 | 11.2万人学习

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

共13课时 | 0.9万人学习

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

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