Composer如何配合GrumPHP预提交检查_Composer配合GrumPHP预提交检查解析

胖宇大大_6024

胖宇大大_6024

2026-04-04

857人浏览

原创

grumphp 不会自动注册 git hook,需手动在 composer.json 中配置 post-install-cmd 和 post-update-cmd 脚本并执行 grumphp git:hook:install --force;同时确保 grumphp.yml 正确配置 tasks 且路径、依赖、触发条件无误,ci 环境应改用 vendor/bin/grumphp run 显式执行。

composer如何配合grumphp预提交检查_composer配合grumphp预提交检查解析

GrumPHP 不能直接靠 Composer 自动触发预提交检查,必须手动配置 Git hook —— 否则 git commit 时根本不会运行任何检查。

为什么 composer require grumphp 后 git commit 没反应

很多人执行 composer require --dev phpro/grumphp 就以为万事大吉,结果 git commit 照常通过。这是因为 GrumPHP 默认不自动注册 Git hook,它只是把二进制文件和配置放好,等着你“拉闸通电”。

常见错误现象:git commit 无任何 PHP 语法、CS 或单元测试提示,grumphp run 却能手动跑出问题。

  • GrumPHP 的 grumphp 命令行工具默认不监听 Git 生命周期,它只是个检查执行器
  • Git hook(如 .git/hooks/pre-commit)必须存在且可执行,否则 Git 完全忽略它
  • composer install 或 composer update 不会自动写 hook 文件,除非你显式启用 phpro/grumphp 的脚本钩子

必须启用 composer-scripts 才能自动安装 hook

GrumPHP 提供了 post-install-cmd 和 post-update-cmd 脚本,在 Composer 安装/更新后自动调用 grumphp git:hook:install。但这个功能默认关闭,需手动在 composer.json 中声明。

实操建议:在 composer.json 的 "scripts" 区块里补上这两行:

"scripts": {
    "post-install-cmd": [
        "@php ./vendor/bin/grumphp git:hook:install --force"
    ],
    "post-update-cmd": [
        "@php ./vendor/bin/grumphp git:hook:install --force"
    ]
}

注意点:

Discussion Composer
Discussion Composer

围绕关键发现、作用机制、临床相关性及研究局限性展开讨论。适用于撰写或优化任何生物医学论文的“讨论(Discussion)”部分——包括结果解读、与既往文献关联、阐释意外发现、界定研究局限性,以及撰写结论。当用户输入以下任一指令时也会自动触发该功能: - “write my discussion” - “help me discuss my findings” - “how do I compare to prior studies” - “write the limitations par

下载
  • --force 很关键:避免因已有 hook 冲突导致安装失败
  • 路径必须写 ./vendor/bin/grumphp,不能只写 grumphp —— Windows 和某些 CI 环境中 $PATH 不一定包含 vendor/bin
  • 如果项目已存在 .git/hooks/pre-commit,GrumPHP 默认跳过安装;加 --force 才会覆盖

grumphp.yml 配置决定哪些检查实际生效

即使 hook 装好了,git commit 也可能“静默通过”,原因通常是 grumphp.yml 里没配任何 task,或配了但被条件过滤掉了。

典型配置误区:

  • 只写了 tasks: 但下面空着,等于“检查零项”
  • 用了 triggered_by 限定文件类型(比如只检查 .php),但你改的是 .js 或 README.md,task 直接跳过
  • 启用了 phpcs 却没装 squizlabs/php_codesniffer,GrumPHP 默认忽略缺失的 task,不报错也不提醒
  • phpunit task 默认只跑 tests/ 下的用例,如果你的测试在 test/(单数),得显式改 config: 里的 configuration 路径

一个最小可用示例(放在项目根目录):

parameters:
  bin_dir: "./vendor/bin"
tasks:
  phpcs:
    standard: "PSR12"
    triggered_by: ["php"]
  phpstan:
    level: 5
    configuration: "phpstan.neon"

CI 环境下要小心 hook 被绕过

很多 CI 流水线用 git clone --depth=1 或直接解压代码包,根本不带 .git/hooks/ 目录 —— 这意味着 GrumPHP 的 pre-commit hook 在 CI 里天然失效。

解决思路不是“修 hook”,而是换执行时机:

  • CI 脚本里显式加一行:vendor/bin/grumphp run,作为独立步骤运行
  • 不要依赖 git commit 触发,因为 CI 通常不走 Git 提交流程
  • 若用 GitHub Actions,注意 actions/checkout@v4 默认不保留 hooks,也别指望它自动恢复
  • 本地开发用 hook,CI 用 grumphp run,两者职责分开更可靠

真正容易被忽略的是:GrumPHP 的配置加载顺序(grumphp.yml → grumphp.yaml → grumphp.json)和工作目录判定逻辑 —— 如果你在子目录执行 git commit,而 grumphp.yml 在父目录,它可能根本读不到配置。

php免费学习视频:立即使用
踏上前端学习之旅,开启通往精通之路!从前端基础到项目实战,循序渐进,一步一个脚印,迈向巅峰!

相关文章

PHP速学教程(入门到精通)
PHP速学教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

composer

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2023.12.25

344

5

Composer 安装与快速入门指南
Composer 安装与快速入门指南

面向 PHP 开发新手,详细介绍 Composer 的下载安装方式(本地安装与全局安装)、国内镜像源(阿里云/腾讯云)加速配置、composer.json 与 composer.lock 文件的作用解析、require/install/update 等核心命令的使用方法,帮助开发者快速掌握 PHP 依赖管理的基本工作流。

2026.04.10

543

36

Composer 依赖管理与版本控制实战
Composer 依赖管理与版本控制实战

深入讲解 Composer 的依赖管理机制,涵盖语义化版本号规范、版本约束符(^、~、*、>=)的区别与最佳实践、composer.lock 在团队协作中的锁定策略、依赖冲突的排查与解决方法、require-dev 与生产依赖的分离管理、平台依赖检查(platform-check)等进阶内容,帮助开发者在项目中精准控制依赖版本、避免"依赖地狱"。

2026.04.10

307

29

Composer 自定义包开发与发布教程合集
Composer 自定义包开发与发布教程合集

以实际项目为导向,讲解如何从零创建一个符合规范的 Composer 包,涵盖 composer.json 元信息配置、PSR-4 自动加载规则设置、命名空间规划、单元测试集成、README 与 LICENSE 编写规范,以及将包提交到 Packagist 公共仓库或搭建 Satis/Private Packagist 私有仓库的完整发布流程,帮助开发者将可复用代码封装为标准化的 Composer 包。

2026.04.10

349

15

Composer 自动加载机制与性能优化
Composer 自动加载机制与性能优化

系统剖析 Composer 的自动加载体系,讲解 PSR-0 与 PSR-4 自动加载标准的区别与演进、classmap 与 files 加载方式的适用场景、autoload_real.php 源码级加载流程解析,同时介绍 composer dump-autoload -o 优化加载映射、APCu 缓存加速、authoritative-classmap 配置等生产环境性能优化手段,帮助开发者深入理解自动加载原理并提升项目启动速度。

2026.04.13

300

21

Composer 在主流 PHP 框架中的应用实践
Composer 在主流 PHP 框架中的应用实践

结合 Laravel、ThinkPHP、Symfony 等主流 PHP 框架的实际场景,讲解 Composer 在框架项目中的典型应用,包括通过 create-project 初始化框架项目、安装与管理第三方扩展包、scripts 钩子(post-install/post-update)自动执行部署任务、自定义 Installer 插件开发、多项目共享 vendor 依赖的 Monorepo 工作流管理,帮助开发者在真实框架项目中充分发

2026.04.13

423

14

Composer 镜像源配置与网络问题排查
Composer 镜像源配置与网络问题排查

针对国内开发者常遇到的 Composer 网络问题,详细讲解阿里云、腾讯云、华为云等国内镜像源的全局与项目级切换方法、多镜像源优先级配置策略、composer config 命令行快速设置技巧,同时涵盖 SSL 证书错误、连接超时、下载中断等常见网络报错的排查与修复方案,以及利用 artifact / path 仓库实现完全离线环境下的依赖安装。

2026.04.14

231

24

Composer Scripts 脚本与自动化工作流
Composer Scripts 脚本与自动化工作流

系统讲解 Composer Scripts 机制的完整用法,涵盖 pre-install、post-update、post-autoload-dump 等内置事件钩子的触发时机与应用场景、自定义脚本命令的定义与参数传递、调用外部 Shell 命令与 PHP 静态方法、多脚本串联执行与条件判断,以及结合代码检查(PHPStan/PHP-CS-Fixer)、数据库迁移、缓存清理等任务构建一键部署自动化工作流。

2026.04.14

290

18

Composer 私有仓库搭建与企业级管理
Composer 私有仓库搭建与企业级管理

面向团队与企业开发场景,讲解如何使用 Satis 搭建轻量级静态私有仓库、通过 Toran Proxy / Private Packagist 构建功能完善的企业级私有包管理平台,涵盖 Git/SVN 仓库类型接入、Token 鉴权与访问权限控制、Webhook 自动触发包更新、内网部署方案以及与 GitLab CI/CD 流水线的集成配置,帮助企业安全高效地管理内部 PHP 组件资产。

2026.04.14

340

26

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
phpMyAdmin 安装文档
phpMyAdmin 安装文档

共0课时 | 0人学习

phpEnv手册
phpEnv手册

共0课时 | 0人学习