0

0

如何用composer scripts设置git的pre-commit钩子

穿越時空

穿越時空

发布时间:2025-10-15 20:01:02

|

766人浏览过

|

来源于php中文网

原创

答案:通过Composer的scripts功能可自动化配置Git pre-commit钩子,确保代码检查流程统一。1. 创建scripts/pre-commit脚本并赋予执行权限;2. 在composer.json中配置post-install-cmd和post-update-cmd命令复制或调用钩子;3. 推荐使用自定义PHP类Scripts\Composer\ScriptHandler处理钩子安装逻辑;4. 注意.git/hooks目录不纳入版本控制,需在文档中告知团队成员运行composer install以启用钩子,避免因路径或权限问题导致失败。

如何用composer scripts设置git的pre-commit钩子

在项目中使用 Composer 的 scripts 功能来设置 Git 的 pre-commit 钩子,是一种自动化代码检查流程的好方法。你可以通过 Composer 在安装或更新依赖时自动配置钩子,避免手动设置的遗漏。

1. 创建 pre-commit 脚本文件

在项目根目录下创建一个用于执行 pre-commit 逻辑的脚本,比如:scripts/pre-commit

内容示例如下:

#!/bin/bash
echo "Running pre-commit checks..."

运行 PHP 语法检查

git diff --cached --name-only --diff-filter=ACM | grep '.php$' | xargs -r php -l

可加入其他检查,如 PHP-CS-Fixer、PHPStan 等

vendor/bin/php-cs-fixer fix --dry-run --using-cache=no

vendor/bin/phpstan analyse src/

if [ $? -ne 0 ]; then echo "Pre-commit checks failed." exit 1 fi

echo "All checks passed." exit 0

确保该脚本可执行:

chmod +x scripts/pre-commit

2. 配置 composer.json 中的 scripts

composer.json 中添加 post-install-cmd 和 post-update-cmd,用于自动链接 pre-commit 钩子。

示例配置:

"scripts": {
    "post-install-cmd": [
        "Scripts\\Composer\\ScriptHandler::linkPreCommitHook"
    ],
    "post-update-cmd": [
        "Scripts\\Composer\\ScriptHandler::linkPreCommitHook"
    ]
}

也可以直接使用匿名函数或 shell 命令(简单场景):

"scripts": {
    "post-install-cmd": [
        "cp scripts/pre-commit .git/hooks/pre-commit"
    ],
    "post-update-cmd": [
        "cp scripts/pre-commit .git/hooks/pre-commit"
    ]
}

这种方式简单直接,适合小项目。

3. 使用自定义 PHP 类处理(推荐方式)

对于更复杂的逻辑,建议写一个 PHP 类来处理钩子创建。

Cutout.Pro抠图
Cutout.Pro抠图

AI批量抠图去背景

下载

创建文件:src/Composer/ScriptHandler.php

namespace Scripts\Composer;

use Composer\Script\Event;

class ScriptHandler { public static function linkPreCommitHook(Event $event) { $from = DIR . '/../../scripts/pre-commit'; $to = DIR . '/../../.git/hooks/pre-commit';

    if (file_exists($from)) {
        copy($from, $to);
        chmod($to, 0755); // 确保可执行
        echo "Git pre-commit hook installed.\n";
    } else {
        echo "Pre-commit script not found: $from\n";
    }
}

}

确保 autoload 能加载这个类,或者将脚本逻辑改为直接调用命令。

4. 注意事项

Git 钩子存储在 .git/hooks/ 目录下,不会被版本控制,默认不共享。因此每个开发者都需要运行 composer install 来触发钩子安装。

团队协作时,应在 README 中说明这一机制。

某些 Git 操作(如 rebase)也会触发 pre-commit,确保脚本性能良好,不影响开发体验。

基本上就这些。通过 Composer 自动化 pre-commit 钩子设置,能有效统一团队的代码质量检查流程。不复杂但容易忽略权限和路径问题。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

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

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

155

2023.12.25

json数据格式
json数据格式

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

420

2023.08.07

json是什么
json是什么

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

536

2023.08.23

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

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

312

2023.10.13

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

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

77

2025.09.10

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

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

744

2023.07.05

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

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

559

2023.07.06

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

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

268

2023.07.24

2026赚钱平台入口大全
2026赚钱平台入口大全

2026年最新赚钱平台入口汇总,涵盖任务众包、内容创作、电商运营、技能变现等多类正规渠道,助你轻松开启副业增收之路。阅读专题下面的文章了解更多详细内容。

54

2026.01.31

热门下载

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

精品课程

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

共137课时 | 10.5万人学习

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号