PHP 项目 git 钩子 php-cs-fixer,提交前自动格式化代码规范

夏静酱_6596

夏静酱_6596

2026-10-08

612人浏览

原创

php项目中用git pre-commit钩子结合php-cs-fixer实现提交前自动格式化,通过composer安装、配置规则、封装命令并接入钩子,确保代码风格统一且全员生效。

php 项目 git 钩子 php-cs-fixer,提交前自动格式化代码规范

在 PHP 项目中用 Git 钩子结合 php-cs-fixer 实现提交前自动格式化,核心是让 pre-commit 钩子调用修复命令,确保每次提交的代码都符合团队规范。这不需要所有人手动执行,也不依赖编辑器设置,真正做到了“一次配置,全员生效”。

安装与基础配置

先将 php-cs-fixer 作为开发依赖安装到项目中:

  • composer require --dev friendsofphp/php-cs-fixer

接着在项目根目录创建配置文件 .php-cs-fixer.dist.php(推荐用 .dist 后缀,便于区分本地覆盖):

  • 明确指定扫描范围,比如只处理 src/ 和 app/ 目录,跳过 vendor、tests/fixtures 等无关路径
  • 规则建议从 @PSR12 开始,再按需启用 ordered_imports、trailing_comma_in_multiline 等高频实用项
  • 配置中使用 Finder::create() 构建路径筛选逻辑,避免误扫或漏扫

通过 Composer Scripts 封装命令

在 composer.json 的 scripts 区块里定义清晰易记的命令:

  • "format": "php-cs-fixer fix --verbose" —— 用于手动快速修复
  • "check-style": "php-cs-fixer fix --dry-run --diff" —— 用于 CI 检查或预提交验证

这样开发者随时可运行 composer format 手动整理,也方便后续钩子调用。

git-sync
git-sync

全平台统一发布工具。支持 skills 和 agents 的 Gitee/GitHub/ClawHub/SkillHub/PyPI 同步与 Release 创建,LLM 驱动的文件过滤与脱敏。

下载

接入 pre-commit 钩子(推荐 Husky 或纯 Git 方式)

有两类主流接入方式,选其一即可:

  • 若项目已用 Husky(尤其搭配前端工具链),执行:
    npx husky add .husky/pre-commit "composer check-style || (composer format && git add .)"
    该命令先检查,不通过则自动修复并重新暂存,再允许提交
  • 若倾向轻量方案,直接编辑 .git/hooks/pre-commit 文件(需 chmod +x):
    写入 shell 脚本,调用 composer check-style;失败时输出提示并 exit 1 中断提交

注意:钩子脚本里不要硬编码 vendor/bin/php-cs-fixer 绝对路径,优先走 composer run,更兼容不同环境。

团队协同与持续集成衔接

仅本地钩子还不够,要形成闭环:

  • 把 .php-cs-fixer.dist.php 和 composer.json 中的 scripts 提交进仓库,确保所有成员拉取即用
  • CI 流程(如 GitHub Actions)中加入 composer check-style 步骤,作为 PR 合并的准入条件
  • 可选加一层保护:在 pre-push 钩子中也跑一次 check-style,防止本地绕过 pre-commit 提交

这样从开发、提交到合并,每个环节都有风格兜底,不再因空格、括号换行等细节反复返工。

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

相关文章

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

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

下载

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

相关专题

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

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

2023.09.01

10144

6

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

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

2023.10.11

6001

5

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

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

2023.10.11

2095

5

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

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

2023.10.23

3768

4

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

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

2023.10.23

4474

6

html怎么上传
html怎么上传

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

2023.11.03

3511

9

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

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

2023.11.09

4997

8

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

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

2023.11.13

3922

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

11862

4

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
《20天入门精通PHP》视频教程
《20天入门精通PHP》视频教程

共200课时 | 48.3万人学习

墨刀帮助中心
墨刀帮助中心

共0课时 | 0人学习

MyEclipse学习中心
MyEclipse学习中心

共0课时 | 0人学习