SwiftFormat 在 SwiftData 模型类中处理默认日期值的注意事项

SwiftFormat 是一个广受欢迎的 Swift 代码格式化工具，但在处理 SwiftData 模型类时，用户可能会遇到一个特殊问题。本文将详细介绍这个问题及其解决方案。

问题现象

当开发者在 SwiftData 模型类中使用 @Model 宏时，如果属性声明中包含类型注解和默认日期值，例如：

@Model
class FooBar {
  var happenedAt: Date = Date.now
  init() {}
}

运行 SwiftFormat 后，代码会被修改为：

@Model
class FooBar {
  var happenedAt: Date = .now
  init() {}
}

这种修改会导致编译错误："A default value requires a fully qualified domain named value"（默认值需要完全限定的域名值）。

问题根源

这个问题源于 SwiftFormat 的 redundantType 规则。该规则旨在简化代码，当类型可以从上下文推断时，会移除冗余的类型声明。在普通 Swift 代码中，Date.now 可以安全地简化为 .now，因为编译器可以从变量类型 Date 推断出 .now 的含义。

然而，SwiftData 的 @Model 宏对默认值有特殊要求，必须使用完全限定的类型名称（即 Date.now 而不是 .now）。这是 SwiftData 框架的一个限制。

解决方案

目前有两种解决方案：

1. 移除类型注解（推荐）：

   @Model
   class FooBar {
     var happenedAt = Date.now
     init() {}
   }
   

   这种方式让 Swift 自动推断类型，SwiftFormat 不会对其进行修改。

2. 配置 SwiftFormat： 使用 --redundanttype inferred 选项运行 SwiftFormat，这会达到与第一种方案相同的效果。

最新进展

该问题已在 SwiftFormat 0.53.6 版本中修复。更新到最新版本后，SwiftFormat 将能够正确处理 SwiftData 模型类中的这种情况。

最佳实践建议

对于 SwiftData 模型类：

• 优先考虑让编译器自动推断类型
• 如果必须显式声明类型，确保默认值使用完全限定名称
• 保持 SwiftFormat 更新到最新版本以获得最佳体验

这个案例展示了工具链中各组件（语言、框架、格式化工具）之间的微妙交互，提醒我们在使用自动化工具时需要保持警惕，特别是在涉及框架特殊语法时。