SwiftFormat 中 privateStateVariables 规则在 SwiftUI Preview 宏中的误判问题解析

在 Swift 代码格式化工具 SwiftFormat 的最新版本中，开发者发现了一个关于 privateStateVariables 规则的有趣问题。该规则旨在自动为 @State 变量添加 private 修饰符，但在 SwiftUI 的 #Preview 宏中使用时却会导致编译错误。

问题现象

当开发者在 SwiftUI 预览代码中使用 @Previewable 和 @State 属性时，SwiftFormat 的 privateStateVariables 规则会错误地添加 private 修饰符：

#Preview {
  @Previewable
  @State var something = false  // 格式化前
  Text("hi")
}

格式化后会变成：

#Preview {
  @Previewable
  @State private var something = false  // 格式化后（会导致编译错误）
  Text("hi")
}

这种修改会导致编译错误，因为 private 修饰符不能在局部作用域中使用。

问题根源

经过分析，这个问题源于 SwiftFormat 的实现机制。当前的 privateStateVariables 规则实现仅检查当前行的内容，而没有考虑上下文信息。具体来说：

1. 规则只检查当前行是否包含 @State 属性
2. 不考虑前一行是否有 @Previewable 或其他宏
3. 也不考虑当前是否处于 #Preview 宏的闭包中

这种简单的行级检查导致了在特殊上下文中的误判。

解决方案

对于这个问题，开发者提供了两种临时解决方案：

1. 将 @Previewable 和 @State 放在同一行：

#Preview {
  @Previewable @State var something = false  // 这样不会触发格式化
  Text("hi")
}

2. 在预览代码中暂时禁用 privateStateVariables 规则

SwiftFormat 团队已经在 0.56.2 版本中修复了这个问题。修复后的版本能够正确识别 #Preview 宏中的上下文，避免在不适当的场景添加 private 修饰符。

技术启示

这个问题给我们几个重要的技术启示：

1. 代码格式化工具的局限性：即使是成熟的格式化工具，也可能在特殊语法结构中出现问题。工具通常基于模式匹配，难以完全理解所有上下文。

2. Swift 属性系统的复杂性：Swift 的属性包装器和宏系统增加了语言的表现力，但也带来了工具支持的挑战。

3. 渐进式改进的重要性：SwiftFormat 团队通过版本迭代快速响应并修复了这个问题，展示了开源项目的活力。

对于开发者来说，在使用代码格式化工具时应当：

• 了解各个规则的具体行为
• 对格式化结果保持审慎态度
• 及时报告发现的问题
• 关注工具的更新日志

SwiftFormat 作为 Swift 生态中的重要工具，其持续改进有助于提升整个社区的开发体验。这个问题的发现和解决过程也体现了开源协作的价值。