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。

Onu
Onu

将脚本转换为内部工具,不需要前端代码。

下载

最简可用配置示例:

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

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

豆包大模型
豆包大模型

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

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

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

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

2899

2023.09.01

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

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

1734

2023.10.11

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

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

1567

2023.10.11

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

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

1120

2023.10.23

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

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

1546

2023.10.23

html怎么上传
html怎么上传

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

1277

2023.11.03

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

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

1669

2023.11.09

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

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

1310

2023.11.13

拼多多赚钱的5种方法 拼多多赚钱的5种方法
拼多多赚钱的5种方法 拼多多赚钱的5种方法

在拼多多上赚钱主要可以通过无货源模式一件代发、精细化运营特色店铺、参与官方高流量活动、利用拼团机制社交裂变,以及成为多多进宝推广员这5种方法实现。核心策略在于通过低成本、高效率的供应链管理与营销,利用平台社交电商红利实现盈利。

31

2026.01.26

热门下载

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

精品课程

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

共137课时 | 9.5万人学习

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

共6课时 | 11.2万人学习

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

共13课时 | 0.9万人学习

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

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