0

0

如何在 Composer 项目中使用 php-cs-fixer 并在提交前自动格式化代码?

裘德小鎮的故事

裘德小鎮的故事

发布时间:2025-12-14 15:32:54

|

306人浏览过

|

来源于php中文网

原创

Composer 项目集成 php-cs-fixer 并实现提交前自动格式化需三步:本地安装为 dev 依赖、配置 .php-cs-fixer.php 规则文件、绑定 Git 钩子;推荐本地安装确保团队一致性,禁用全局安装以防版本冲突。

如何在 composer 项目中使用 php-cs-fixer 并在提交前自动格式化代码?

在 Composer 项目中集成 php-cs-fixer 并实现提交前自动格式化,核心是三步:安装工具、配置规则、绑定 Git 钩子。重点不是“能不能做”,而是让流程稳定、可复现、不干扰日常开发。

安装 php-cs-fixer 到项目本地

推荐作为 dev 依赖安装,避免全局环境差异影响团队一致性:

  • 运行 composer require --dev friendsofphp/php-cs-fixer
  • 安装后命令路径为 vendor/bin/php-cs-fixer(Linux/macOS)或 vendor\bin\php-cs-fixer.bat(Windows)
  • 不要用全局安装(如 composer global require),否则不同项目可能因版本冲突导致格式结果不一致

定义项目专属的 .php-cs-fixer.php 配置文件

在项目根目录新建 .php-cs-fixer.php,明确指定规则和作用范围:

  • 基础示例(适配 PSR-12 + PHP 8+):
setRules([
        '@PSR12' => true,
        'array_syntax' => ['syntax' => 'short'],
        'declare_strict_types' => true,
        'no_unused_imports' => true,
        'ordered_imports' => true,
    ])
    ->setFinder(PhpCsFixer\Finder::create()
        ->in(['src', 'tests'])
        ->name('*.php')
        ->notName('*.blade.php')
        ->ignoreDotFiles(true)
        ->ignoreVCS(true)
    )
    ->setCacheFile('.php-cs-fixer.cache');
  • 务必设置 setCacheFile:加速后续运行,尤其对大项目明显
  • ->in([...]) 明确限定目录,避免误处理 vendor 或生成文件
  • 首次运行可加 --dry-run --diff 参数预览改动,确认无意外变更

用 Composer 脚本 + Git pre-commit 钩子自动执行

不依赖第三方钩子管理器(如 Husky),用最简方式落地:

CPWEB企业网站管理系统2.2 Beta
CPWEB企业网站管理系统2.2 Beta

CPWEB企业网站管理系统(以下称CPWEB)是一个基于PHP+Mysql架构的企业网站管理系统。CPWEB 采用模块化方式开发,功能强大灵活易于扩展,并且完全开放源代码,面向大中型站点提供重量级企业网站建设解决方案。CPWEB企业网站管理系统 2.2 Beta 测试版本,仅供测试,不建议使用在正式项目中,否则发生任何的后果自负。

下载

立即学习PHP免费学习笔记(深入)”;

  • composer.json"scripts" 中添加:
"scripts": {
  "cs-fix": "php-cs-fixer fix --verbose",
  "cs-check": "php-cs-fixer fix --dry-run --using-cache=no"
}
  • 然后在项目根目录创建 .git/hooks/pre-commit 文件(Linux/macOS):
#!/bin/sh
echo "Running PHP code style check..."
if ! composer cs-check; then
  echo "❌ Code style violations found. Run 'composer cs-fix' to fix them."
  exit 1
fi
  • 给钩子加执行权限:chmod +x .git/hooks/pre-commit
  • Windows 用户可用 pre-commit.bat(内容类似,用 call composer cs-check
  • 这个钩子只做检查(--dry-run),失败则中断提交——更安全,避免自动修改引入意外

补充建议:CI 和团队协同

本地钩子只是第一道防线,还需配套保障:

  • 在 GitHub Actions / GitLab CI 中加入 composer cs-check 步骤,防止绕过本地钩子
  • .php-cs-fixer.phpcomposer.json 中的脚本纳入版本管理,确保所有人用同一套规则
  • 编辑器(如 VS Code)可装 PHP CS Fixer 插件并设为“保存时格式化”,但仅作辅助——以 pre-commit 钩子为准

基本上就这些。不复杂但容易忽略的是缓存文件路径和 Finder 范围,设错会导致慢或漏检。跑通一次,之后每次提交都默默守着代码风格。

相关专题

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

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

2831

2023.09.01

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

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

1696

2023.10.11

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

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

1556

2023.10.11

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

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

1056

2023.10.23

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

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

1505

2023.10.23

html怎么上传
html怎么上传

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

1256

2023.11.03

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

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

1609

2023.11.09

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

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

1307

2023.11.13

c++空格相关教程合集
c++空格相关教程合集

本专题整合了c++空格相关教程,阅读专题下面的文章了解更多详细内容。

0

2026.01.23

热门下载

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

精品课程

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

共21课时 | 2.9万人学习

Go语言实战之 GraphQL
Go语言实战之 GraphQL

共10课时 | 0.8万人学习

Bootstrap4.x---十天精品课堂
Bootstrap4.x---十天精品课堂

共22课时 | 1.7万人学习

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

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