首页
/ PHP-CS-Fixer 中方法链缩进与双冒号空格的修复顺序问题

PHP-CS-Fixer 中方法链缩进与双冒号空格的修复顺序问题

2025-05-17 09:42:43作者:卓艾滢Kingsley

在 PHP 代码格式化工具 PHP-CS-Fixer 中,存在一个关于方法链缩进(method_chaining_indentation)和双冒号周围空格(no_space_around_double_colon)两个修复规则的执行顺序问题。这个问题会导致代码格式化结果不符合预期。

问题现象

当同时启用这两个规则时,代码格式化会出现异常情况。例如以下代码:

$formattedIncorrectly = Foo::bar
    ::baz()
                    ->where('id', 1)
    ->firstOrFail();

理想情况下应该被格式化为:

$formattedIncorrectly = Foo::bar::baz()
    ->where('id', 1)
    ->firstOrFail();

但实际格式化结果却变成了:

$formattedIncorrectly = Foo::bar::baz()
        ->where('id', 1)
        ->firstOrFail();

问题根源

这个问题源于两个修复器的执行顺序:

  1. MethodChainingIndentationFixer(方法链缩进修复器)
  2. NoSpaceAroundDoubleColonFixer(双冒号周围空格修复器)

这两个修复器都没有显式定义优先级(即都继承了AbstractFixer的默认优先级0),因此它们的执行顺序取决于它们在规则集中的定义顺序。当规则按字母顺序排序时,method_chaining_indentation会排在no_space_around_double_colon之前执行。

技术原理

在 PHP-CS-Fixer 中,修复器的执行顺序由以下因素决定:

  1. 显式优先级:修复器可以通过实现getPriority()方法定义自己的优先级
  2. 隐式顺序:当多个修复器具有相同优先级时,它们的执行顺序取决于定义顺序

对于方法链缩进和双冒号周围空格的处理,正确的执行顺序应该是:

  1. 先处理双冒号周围的空间(合并或拆分双冒号)
  2. 再处理方法链的缩进

这样才能确保最终的格式化结果符合预期。

解决方案

要解决这个问题,可以考虑以下两种方案:

  1. 调整修复器优先级:为这两个修复器设置明确的优先级,确保NoSpaceAroundDoubleColonFixer先执行
  2. 手动指定规则顺序:在配置文件中手动排列规则顺序,确保no_space_around_double_colonmethod_chaining_indentation之前

对于 PHP-CS-Fixer 项目本身,更合适的解决方案是第一种,即为这两个修复器设置适当的优先级,这样无论它们在配置文件中以什么顺序出现,都能保证正确的执行顺序。

最佳实践

在实际使用 PHP-CS-Fixer 时,如果遇到类似的多规则交互问题,可以:

  1. 检查相关修复器的优先级设置
  2. 通过测试确定规则的执行顺序
  3. 必要时调整配置文件中规则的顺序
  4. 考虑向项目提交修复建议,完善修复器的优先级设置

这个问题也提醒我们,在开发代码格式化工具时,需要仔细考虑各个规则之间的依赖关系和执行顺序,以确保最终的格式化结果符合开发者的预期。

登录后查看全文
热门项目推荐

项目优选

收起
kernelkernel
deepin linux kernel
C
22
6
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
163
2.05 K
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
60
16
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
199
279
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
951
557
ShopXO开源商城ShopXO开源商城
🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
96
15
apintoapinto
基于golang开发的网关。具有各种插件,可以自行扩展,即插即用。此外,它可以快速帮助企业管理API服务,提高API服务的稳定性和安全性。
Go
22
0
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Python
77
70
giteagitea
喝着茶写代码!最易用的自托管一站式代码托管平台,包含Git托管,代码审查,团队协作,软件包和CI/CD。
Go
17
0