0

0

Composer怎么安装PHP-CS-Fixer 代码格式化工具配置【教程】

裘德小鎮的故事

裘德小鎮的故事

发布时间:2026-01-26 13:22:03

|

288人浏览过

|

来源于php中文网

原创

全局安装php-cs-fixer需先将Composer bin目录加入PATH,否则提示“command not found”;验证用php-cs-fixer --version;推荐全局开发、本地CI;配置文件为.php-cs-fixer.php,须设setFinder并exclude('vendor');运行前必加--dry-run和--diff预览。

composer怎么安装php-cs-fixer 代码格式化工具配置【教程】

用 Composer 全局安装 php-cs-fixer

直接运行 composer global require friendsofphp/php-cs-fixer 即可,但前提是你的 ~/.composer/vendor/bin(Linux/macOS)或 %USERPROFILE%\AppData\Roaming\Composer\vendor\bin(Windows)已加入系统 PATH。没加的话,命令会提示“command not found”,不是安装失败,而是找不到可执行文件。

验证是否生效:终端执行 php-cs-fixer --version。如果报错说找不到命令,别重装,先检查 PATH 是否包含 Composer 的 bin 目录。

本地项目安装 vs 全局安装的区别

项目级安装用 composer require --dev friendsofphp/php-cs-fixer,生成的二进制在 vendor/bin/php-cs-fixer。好处是版本锁定、团队一致;坏处是每次都要写相对路径或加 ./vendor/bin/php-cs-fixer,CI/CD 脚本里容易漏掉 ./vendor/bin/ 前缀。

全局安装更方便日常使用,但要注意:多个项目依赖不同版本时,全局只有一个版本,可能不兼容旧项目规则。建议主力开发用全局,CI 流水线用本地安装 + vendor/bin/php-cs-fixer 显式调用。

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

  • 本地安装后,php-cs-fixer 不会自动注册为全局命令
  • 全局安装后,升级只需 composer global update friendsofphp/php-cs-fixer
  • --dev 参数必须加,它不是运行时依赖,只是开发工具

配置 .php-cs-fixer.php 文件常见写法

配置文件名必须是 .php-cs-fixer.php(注意开头的点),放在项目根目录。内容返回一个 PhpCsFixer\Config 实例,不是 JSON 或 YAML。

阿里云AI平台
阿里云AI平台

阿里云AI平台

下载

最简可用配置示例:

return PhpCsFixer\Config::create()
    ->setRules([
        '@PSR12' => true,
        'array_syntax' => ['syntax' => 'short'],
        'no_unused_imports' => true,
    ])
    ->setFinder(PhpCsFixer\Finder::create()
        ->in(__DIR__)
        ->exclude('vendor')
        ->name('*.php')
    )
;

注意点:

  • setFinder() 必须显式设置,否则默认只处理当前目录下的 PHP 文件,不会递归
  • exclude('vendor') 很关键,否则会尝试格式化第三方包,极慢且无意义
  • 规则名如 @PSR12 是预设集,array_syntax 是单条规则,参数结构要看官方文档对应规则页
  • 配置文件里不能用短数组语法 [] 如果项目 PHP 版本低于 5.4 —— 但你真还在用 PHP 5.4 以下?

运行 fix 时 --dry-run 和 --diff 参数别漏掉

首次在项目中运行前,务必先加 --dry-run 看哪些文件会被改、改多少行,避免误操作覆盖未提交的修改。加上 --diff 可以直接看到具体差异(类似 git diff),比纯统计更有用。

常用组合:

  • php-cs-fixer fix --dry-run --diff:预览改动
  • php-cs-fixer fix --verbose:显示每个文件的处理状态,卡住时能定位是哪个文件出问题
  • php-cs-fixer fix src/ --rules=@Symfony:只处理 src/ 目录,且只启用 @Symfony 规则集

如果你发现某次 fix 后 Git 提交了大量空格或换行变化,大概率是配置里没设 'line_ending' => "\n" 或系统换行符和规则不一致,尤其 Windows 和 macOS 混合开发时。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

WorkBuddy
WorkBuddy

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
PHP Symfony框架
PHP Symfony框架

本专题专注于PHP主流框架Symfony的学习与应用,系统讲解路由与控制器、依赖注入、ORM数据操作、模板引擎、表单与验证、安全认证及API开发等核心内容。通过企业管理系统、内容管理平台与电商后台等实战案例,帮助学员全面掌握Symfony在企业级应用开发中的实践技能。

87

2025.09.11

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数据方法,阅读专题下面的文章了解更多详细内容。

82

2025.09.10

require的用法
require的用法

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

510

2023.11.27

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

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

979

2023.07.05

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

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

26

2026.03.13

热门下载

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

精品课程

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

共137课时 | 13.5万人学习

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号