SwiftFormat中`swiftformat:sort`指令在`extension`内失效问题解析

问题背景

SwiftFormat是一个流行的Swift代码格式化工具，它提供了// swiftformat:sort指令来对代码块内的声明进行排序。然而，用户发现在extension扩展中使用该指令时，排序功能未能正常工作。

技术分析

这个问题源于SwiftFormat内部两个规则organizeDeclarations和sortDeclarations的交互机制：

1. 当同时启用这两个规则时，sortDeclarations规则会避免对声明体进行排序，以防止与organizeDeclarations规则产生冲突（后者已内置排序功能）

2. 默认情况下，organizeTypes选项设置为class,actor,struct,enum，这意味着organizeDeclarations规则不会处理extension扩展

这种设计导致了在扩展中使用排序指令时出现"规则真空"——既没有organizeDeclarations处理，sortDeclarations又主动避让，最终导致排序功能失效。

解决方案

项目维护者在版本0.53.3中修复了这个问题，主要改动是：

• 当声明类型被organizeTypes选项排除时，sortDeclarations规则现在会主动处理这些类型的声明体排序
• 这样既保持了原有规则的协作关系，又填补了特殊场景下的功能空白

最佳实践

对于需要在扩展内排序的场景，建议：

1. 确保使用SwiftFormat 0.53.3或更高版本
2. 明确配置organizeTypes选项，包含所有需要排序的类型
3. 根据项目需求选择启用organizeDeclarations或sortDeclarations规则

// 示例配置
--organizetypes class,actor,struct,enum,extension,protocol

总结

这个案例展示了工具规则间交互可能产生的边界情况。SwiftFormat通过精细调整规则优先级和职责范围，既保持了规则的独立性，又确保了功能的完整性。开发者在使用时应了解各规则的协作机制，以便更好地利用工具功能。