0

0

composer中如何配置项目的代码规范自动修复脚本_composer集成php-cs-fixer【指南】

裘德小鎮的故事

裘德小鎮的故事

发布时间:2026-01-16 15:07:02

|

413人浏览过

|

来源于php中文网

原创

Composer 本身不提供代码规范修复能力,但可通过 scripts 配置集成 php-cs-fixer 实现一键格式化;需以 --dev 安装至 require-dev,配置文件须显式指定,scripts 中命令基于项目根目录且不支持 shell 语法。

composer中如何配置项目的代码规范自动修复脚本_composer集成php-cs-fixer【指南】

Composer 本身不提供代码规范修复能力,但可以通过 scripts 配置项集成 php-cs-fixer,实现一键格式化。关键不是“配置 Composer”,而是让 Composer 成为触发 php-cs-fixer 的快捷入口。

安装 php-cs-fixer 并设为项目本地依赖

必须用 --dev 安装到 require-dev,避免污染生产环境;不推荐全局安装,因为不同项目可能依赖不同版本的规则集。

  • 运行 composer require --dev friendsofphp/php-cs-fixer
  • 安装后二进制文件位于 vendor/bin/php-cs-fixer,这是脚本中要调用的路径
  • 若项目已有 .php-cs-fixer.php.php-cs-fixer.dist.php,优先被读取;没有则需显式指定配置

composer.json 的 scripts 中定义 fix 命令

scripts 是纯字符串命令,不支持 shell 语法(如 &&、管道),也不展开环境变量。所有路径都应基于项目根目录,且需使用单引号避免 shell 解析问题。

"scripts": {
    "fix": "php-cs-fixer fix --config=.php-cs-fixer.php --verbose --diff",
    "fix-dry": "php-cs-fixer fix --config=.php-cs-fixer.php --dry-run --verbose"
}
  • --config 必须显式指定,否则 php-cs-fixer 可能找不到配置或加载默认规则(往往不符合预期)
  • --dry-run 用于预览改动,配合 --diff 可看到具体修改位置
  • 不要写成 vendor/bin/php-cs-fixer —— Composer 的 bin-dir 默认是 vendor/bin,且已加入 PATH

编写 .php-cs-fixer.php 配置文件控制规则

配置文件决定哪些规则生效、是否自动加 PHP tag、是否强制 use 语句排序等。不写配置等于裸跑,默认规则会随版本升级变化,极不稳定。

Question AI
Question AI

一款基于大模型的免费的AI问答助手、总结器、AI搜索引擎

下载

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

setRules([
        '@PSR12' => true,
        'array_syntax' => ['syntax' => 'short'],
        'ordered_imports' => true,
        'no_unused_imports' => true,
    ])
    ->setFinder(
        PhpCsFixer\Finder::create()
            ->in(['src', 'tests'])
            ->name('*.php')
            ->notName('*.blade.php')
            ->ignoreDotFiles(true)
            ->ignoreVCS(true)
    );
  • setFinder() 明确限定作用范围,避免误处理 vendor/ 或生成文件
  • 规则名必须拼写准确,例如 '@PSR12' 不是 'psr12',大小写和符号敏感
  • 若使用旧版 php-cs-fixer(v2.x),配置结构不同,PhpCsFixer\Config 类不存在,需用数组返回

最易被忽略的是配置文件与 php-cs-fixer 版本的兼容性 —— v3 要求 PHP 7.4+,且规则名、配置类名、finder 方法全部变更;v2 和 v3 的 .php-cs-fixer.php 不能混用。运行前先确认 vendor/bin/php-cs-fixer --version

相关专题

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

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

2549

2023.09.01

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

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

1615

2023.10.11

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

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

1504

2023.10.11

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

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

952

2023.10.23

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

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

1417

2023.10.23

html怎么上传
html怎么上传

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

1234

2023.11.03

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

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

1446

2023.11.09

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

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

1306

2023.11.13

高德地图升级方法汇总
高德地图升级方法汇总

本专题整合了高德地图升级相关教程,阅读专题下面的文章了解更多详细内容。

2

2026.01.16

热门下载

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

精品课程

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

共137课时 | 8.7万人学习

JavaScript ES5基础线上课程教学
JavaScript ES5基础线上课程教学

共6课时 | 7.1万人学习

PHP新手语法线上课程教学
PHP新手语法线上课程教学

共13课时 | 0.9万人学习

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

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