0

0

如何让composer在git pre-commit钩子中自动运行检查

裘德小鎮的故事

裘德小鎮的故事

发布时间:2025-09-29 15:53:01

|

313人浏览过

|

来源于php中文网

原创

答案:通过 Composer 脚本与 Git pre-commit 钩子结合,可自动化代码检查。在 composer.json 中定义 lint、check-cs 等命令,手动或使用 leftheris/git-hooks-composer-plugin 插件配置 pre-commit 钩子自动执行检查,确保提交代码符合规范,提升团队协作效率与代码质量。

如何让composer在git pre-commit钩子中自动运行检查

在开发 PHP 项目时,使用 Composer 管理依赖的同时,结合 Git 的 pre-commit 钩子自动运行检查,能有效防止提交不符合规范的代码。以下是具体实现方式。

配置 pre-commit 钩子调用 Composer 脚本

Git 的 pre-commit 钩子是一个脚本文件,存放在项目根目录下的 .git/hooks/pre-commit。你可以在此脚本中调用 Composer 定义的命令进行静态检查。

先确保你的 composer.json 中定义了需要运行的检查命令,例如:

"scripts": {
    "check-cs": "phpcs --standard=PSR12 src/",
    "check-types": "phpstan analyse src/",
    "lint": "php -l src/"
}

然后创建或编辑 .git/hooks/pre-commit 文件:

#!/bin/sh
# 运行 Composer 检查
composer run lint
composer run check-cs
composer run check-types

检查上一个命令是否成功

if [ $? -ne 0 ]; then echo "Commit 失败:代码检查未通过" exit 1 fi

保存后,给钩子添加执行权限:

chmod +x .git/hooks/pre-commit

使用 Composer 插件简化钩子管理

手动管理钩子不利于团队协作。推荐使用 Composer Hook ManagerPhine/PHAR工具,但更流行的是 leftheris/git-hooks-composer-plugin

Pixso
Pixso

Pixso一站式完成原型、设计、交互与交付,为数字化团队协作提效。

下载

安装插件:

composer require --dev leftheris/git-hooks-composer-plugin

composer.json 中添加钩子配置:

"extra": {
    "hooks": {
        "pre-commit": [
            "composer run lint",
            "composer run check-cs",
            "composer run check-types"
        ]
    }
}

运行 composer installcomposer update 后,插件会自动将命令写入 pre-commit 钩子。

注意事项与最佳实践

这类自动化检查应快速完成,避免拖慢提交流程。

  • 只检查暂存区(staged)文件可以提升效率,例如配合 php-cs-fixer 使用 --diff--dry-run
  • 允许临时跳过检查:提交时加 --no-verify 参数,用于紧急修复。
  • 将钩子纳入版本控制需借助工具(如上面的插件),否则 .git/hooks 不会被 Git 跟踪。
  • 跨平台兼容性:确保钩子脚本在 Windows 和 Unix 系统都能运行,建议使用 PHP 脚本代替 shell 脚本(可选)。

基本上就这些。通过 Composer 脚本与 Git 钩子结合,能让代码质量检查成为提交流程的一部分,减少人为遗漏。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

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

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

154

2023.12.25

json数据格式
json数据格式

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

419

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

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

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

724

2023.07.05

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

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

555

2023.07.06

git撤销提交的commit
git撤销提交的commit

Git是一个强大的版本控制系统,它提供了很多功能帮助开发人员有效地管理和控制代码的变更,本专题为大家提供git 撤销提交的commit相关的各种文章内容,供大家免费下载体验。

267

2023.07.24

clawdbot ai使用教程 保姆级clawdbot部署安装手册
clawdbot ai使用教程 保姆级clawdbot部署安装手册

Clawdbot是一个“有灵魂”的AI助手,可以帮用户清空收件箱、发送电子邮件、管理日历、办理航班值机等等,并且可以接入用户常用的任何聊天APP,所有的操作均可通过WhatsApp、Telegram等平台完成,用户只需通过对话,就能操控设备自动执行各类任务。

16

2026.01.29

热门下载

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

精品课程

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

共137课时 | 10.1万人学习

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号