SwiftFormat 中关于操作符间距与属性修饰符的兼容性问题解析

SwiftFormat 是一个流行的 Swift 代码格式化工具，它通过一系列规则帮助开发者保持代码风格的一致性。在最新版本中，我们发现了一个关于 spaceAroundOperators 规则与 Swift 属性修饰符（如 @MainActor 和 @Sendable）交互时产生的有趣问题。

问题现象

当代码中包含泛型类型参数且参数类型使用了属性修饰符时，例如：

let example = Example<(@MainActor () -> Void)?>(nil)

或

let example = Example<(@Sendable () -> Void)?>(nil)

spaceAroundOperators 规则会错误地在 < 和 > 周围添加空格，导致格式化为：

let example = Example < (@MainActor () -> Void)?> nil

这种格式化结果会导致 Xcode 编译错误，因为 Swift 不允许在泛型参数列表的尖括号周围有空格。

问题分析

这个问题的核心在于 SwiftFormat 的 spaceAroundOperators 规则没有正确处理带有属性修饰符的闭包类型作为泛型参数的情况。规则将 @MainActor 和 @Sendable 视为需要分隔的独立元素，而非类型系统的一部分。

相比之下，没有属性修饰符的简单闭包类型则不会触发这个问题：

let example = Example<(() -> Void)?> // 正常格式化

技术背景

@MainActor 和 @Sendable 是 Swift 并发模型中的重要属性：

1. @MainActor 确保代码在主线程上执行，常用于 UI 相关操作
2. @Sendable 标记类型可以安全地在并发域之间传递

当这些属性应用于闭包类型时，它们成为类型签名的一部分，应该被视为一个整体，而不是需要额外分隔的独立元素。

解决方案

该问题已在 SwiftFormat 0.53.10 版本中修复。修复后的版本能够正确识别这些属性修饰符作为类型系统的一部分，不再错误地在其周围添加空格。

对于开发者而言，这意味着：

1. 可以安全地在泛型参数中使用带有属性修饰符的闭包类型
2. 无需担心格式化工具会破坏代码的语法有效性
3. 保持代码风格一致性的同时，不影响功能的正确性

最佳实践

在使用 SwiftFormat 时，建议：

1. 保持工具版本更新，以获取最新的错误修复和功能改进
2. 对于复杂的泛型类型参数，特别是涉及并发属性的情况，格式化后应进行编译检查
3. 了解格式化规则的行为边界，在必要时通过配置文件调整规则行为

这个问题的修复体现了 SwiftFormat 项目对 Swift 语言新特性的持续跟进，也展示了开源社区对代码质量工具精益求精的态度。