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 语句排序等。不写配置等于裸跑,默认规则会随版本升级变化,极不稳定。

MaxAI
MaxAI

MaxAI.me是一款功能强大的浏览器AI插件,集成了多种AI模型。

下载

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

<?php
return (new PhpCsFixer\Config())
    ->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

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

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

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

162

2023.12.25

json数据格式
json数据格式

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

457

2023.08.07

json是什么
json是什么

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

549

2023.08.23

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

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

337

2023.10.13

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

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

83

2025.09.10

require的用法
require的用法

require的用法有引入模块、导入类或方法、执行特定任务。想了解更多require的相关内容,可以阅读本专题下面的文章。

510

2023.11.27

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

761

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

221

2023.09.04

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

69

2026.03.13

热门下载

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

精品课程

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

共137课时 | 13.7万人学习

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

共6课时 | 11.3万人学习

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

共13课时 | 1.0万人学习

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

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