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();
问题根源
这个问题源于两个修复器的执行顺序:
MethodChainingIndentationFixer(方法链缩进修复器)NoSpaceAroundDoubleColonFixer(双冒号周围空格修复器)
这两个修复器都没有显式定义优先级(即都继承了AbstractFixer的默认优先级0),因此它们的执行顺序取决于它们在规则集中的定义顺序。当规则按字母顺序排序时,method_chaining_indentation会排在no_space_around_double_colon之前执行。
技术原理
在 PHP-CS-Fixer 中,修复器的执行顺序由以下因素决定:
- 显式优先级:修复器可以通过实现
getPriority()方法定义自己的优先级 - 隐式顺序:当多个修复器具有相同优先级时,它们的执行顺序取决于定义顺序
对于方法链缩进和双冒号周围空格的处理,正确的执行顺序应该是:
- 先处理双冒号周围的空间(合并或拆分双冒号)
- 再处理方法链的缩进
这样才能确保最终的格式化结果符合预期。
解决方案
要解决这个问题,可以考虑以下两种方案:
- 调整修复器优先级:为这两个修复器设置明确的优先级,确保
NoSpaceAroundDoubleColonFixer先执行 - 手动指定规则顺序:在配置文件中手动排列规则顺序,确保
no_space_around_double_colon在method_chaining_indentation之前
对于 PHP-CS-Fixer 项目本身,更合适的解决方案是第一种,即为这两个修复器设置适当的优先级,这样无论它们在配置文件中以什么顺序出现,都能保证正确的执行顺序。
最佳实践
在实际使用 PHP-CS-Fixer 时,如果遇到类似的多规则交互问题,可以:
- 检查相关修复器的优先级设置
- 通过测试确定规则的执行顺序
- 必要时调整配置文件中规则的顺序
- 考虑向项目提交修复建议,完善修复器的优先级设置
这个问题也提醒我们,在开发代码格式化工具时,需要仔细考虑各个规则之间的依赖关系和执行顺序,以确保最终的格式化结果符合开发者的预期。
登录后查看全文
热门项目推荐
atomcodeClaude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed. Get StartedRust0214
cann-learning-hubCANN 学习中心仓,支持在线互动运行、边学边练,提供教程、示例与优化方案,一站式助力昇腾开发者快速上手。Jupyter Notebook0138
uni-appA cross-platform framework using Vue.jsJavaScript08
GLM-5.2智谱开源 GLM-5.2,这是针对长文本任务的最新旗舰模型。相较于前代产品 GLM-5.1,它在长文本任务处理能力上实现了显著飞跃,并且首次在稳定的 100 万 token 上下文中提供这一能力。Jinja00
SwanLab⚡️SwanLab - an open-source, modern-design AI training tracking and visualization tool. Supports Cloud / Self-hosted use. Integrated with PyTorch / Transformers / LLaMA Factory / veRL/ Swift / Ultralytics / MMEngine / Keras etc.Python00
tiny-universe《大模型白盒子构建指南》:一个全手搓的Tiny-UniverseJupyter Notebook03
项目优选
收起
deepin linux kernel
C
32
16
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
469
465
暂无描述
Dockerfile
778
5.08 K
本项目是CANN提供的transformer类大模型算子库,实现网络在NPU上加速计算。
C++
877
2.03 K
Ascend Extension for PyTorch
Python
758
968
本项目是CANN提供的神经网络类计算算子库,实现网络在NPU上加速计算。
C++
697
1.4 K
昇腾LLM分布式训练框架
Python
185
231
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
1.1 K
1.14 K
本仓库是 Flutter SDK 与 Flutter Engine 的 OpenHarmony 适配版本,由 CPF-Flutter 团队维护。开发者可使用熟悉的 Flutter 技术栈开发 OpenHarmony 应用,3.35.7 及以后的适配版本可基于本仓库源码构建支持 OpenHarmony 的 Flutter Engine。
Dart
1.04 K
271
JiuwenSwarm 是一款基于openJiuwen开发的智能AI Agent,它能够将大语言模型的强大能力,通过你日常使用的各类通讯应用,直接延伸至你的指尖。
Python
2.25 K
677