0

0

composer如何安装并使用代码美化工具PHP-CS-Fixer_composer实战教程【实战】

冰火之心

冰火之心

发布时间:2026-01-22 11:45:11

|

398人浏览过

|

来源于php中文网

原创

应按项目安装而非全局安装,因全局安装易致版本冲突、CI/Docker 环境路径不可靠及团队格式化结果不一致;推荐执行 composer require --dev friendsofphp/php-cs-fixer,并配置 .php-cs-fixer.php 文件。

composer如何安装并使用代码美化工具php-cs-fixer_composer实战教程【实战】

为什么不用全局安装 php-cs-fixer

直接运行 composer global require friendsofphp/php-cs-fixer 看似省事,但实际项目中容易出问题:不同项目依赖的 PHP-CS-Fixer 版本可能冲突;全局二进制路径在某些 CI 环境或 Docker 容器里不可靠;团队成员本地环境不一致导致格式化结果不一致。
更稳妥的做法是把 php-cs-fixer 作为开发依赖,按项目安装。

如何为项目安装并配置 php-cs-fixer

进入项目根目录后执行:

composer require --dev friendsofphp/php-cs-fixer

安装完成后,php-cs-fixer 二进制文件会出现在 vendor/bin/php-cs-fixer。推荐用这个路径调用,避免版本错乱。
常见配置方式:

  • 在项目根目录新建 .php-cs-fixer.php(注意不是 .php_cs,后者已弃用)
  • 内容示例(适配 PSR-12 + Laravel 风格):
setRules([
        '@PSR12' => true,
        'array_syntax' => ['syntax' => 'short'],
        'binary_operator_spaces' => ['operators' => ['=>' => 'align_single_space_minimal']],
        'blank_line_before_statement' => ['statements' => ['return']],
        'single_quote' => true,
    ])
    ->setFinder(
        PhpCsFixer\Finder::create()
            ->in(['app', 'config', 'database', 'routes', 'tests'])
            ->name('*.php')
            ->notName('*.blade.php')
            ->ignoreDotFiles(true)
            ->ignoreVCS(true)
    );

关键点:
setFinder() 必须显式指定要处理的目录和文件,否则默认只扫当前目录
ignoreVCS(true) 能跳过 .git 目录,防止报错
• 规则数组里用 @PSR12 是基础,再叠加项目定制项更可控

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

Background Eraser
Background Eraser

AI自动删除图片背景

下载

怎么安全地批量格式化又不破坏 Git 历史?

直接跑 vendor/bin/php-cs-fixer fix 可能一次性改几百个文件,Git diff 失去可读性,Code Review 难以聚焦逻辑变更。
建议分三步走:

  • 先用 --dry-run --diff 预览改动:vendor/bin/php-cs-fixer fix --dry-run --diff
  • 确认无误后,加 --verbose 查看每个文件是否被处理:vendor/bin/php-cs-fixer fix --verbose
  • 若只想修某个文件或目录,直接指定路径:vendor/bin/php-cs-fixer fix app/Http/Controllers/

特别注意:
• 不要在 git add . 后再运行 fix,否则未暂存的修改会被混入提交
• 如果团队用 pre-commit hook,务必把 php-cs-fixer 加入 composer.jsonscripts 段,并用 composer run fix 统一入口

composer.json 里怎么集成成一键命令?

composer.json"scripts" 字段里加一条:

"scripts": {
    "fix": "php-cs-fixer fix --verbose",
    "fix-dry": "php-cs-fixer fix --dry-run --diff"
}

这样就能用 composer run fix 执行(Composer 2.2+),旧版用 composer run-script fix
好处是命令路径、参数、PHP 版本都由 Composer 自动管理,不需要记 vendor/bin/... 的完整路径。
容易忽略的一点:
• 如果项目用了 platform 配置(如 "php": "8.1"),php-cs-fixer 会自动匹配兼容版本,但某些新规则(如 modernize_types_casting)需要 PHP 8.0+,低版本会静默跳过 —— 建议在 CI 中明确检查 php-cs-fixer --version 和当前 PHP 版本是否匹配

相关专题

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

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

2787

2023.09.01

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

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

1685

2023.10.11

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

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

1546

2023.10.11

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

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

1016

2023.10.23

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

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

1464

2023.10.23

html怎么上传
html怎么上传

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

1255

2023.11.03

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

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

1569

2023.11.09

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

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

1307

2023.11.13

菜鸟裹裹入口以及教程汇总
菜鸟裹裹入口以及教程汇总

本专题整合了菜鸟裹裹入口地址及教程分享,阅读专题下面的文章了解更多详细内容。

0

2026.01.22

热门下载

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

精品课程

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

共137课时 | 9.1万人学习

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

共6课时 | 9.8万人学习

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

共13课时 | 0.9万人学习

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

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