SwiftFormat 0.56.1 版本中 trailingCommas 规则在闭包参数中的问题分析

SwiftFormat 是一个流行的 Swift 代码格式化工具，它可以帮助开发者保持代码风格的一致性。在最新发布的 0.56.1 版本中，trailingCommas 规则在处理某些闭包参数时出现了一个值得注意的问题。

问题描述

当使用 Swift 6.1 编译器并启用 trailingCommas 规则（设置为 always）时，格式化工具会在某些闭包参数列表的最后一个参数后错误地添加逗号。这种情况特别容易出现在参数较多、需要跨多行显示的闭包声明中。

问题示例

以下是一个典型的受影响代码示例：

格式化前的代码：

var countAssignedWorkers: @Sendable (
      _ shiftId: String,
      _ startsAtDay: String,
      _ startsAtTime: String,
      _ newAssignedWorkerIds: Set<String>,
      _ newUnassignedWorkerIds: Set<String>
    ) async throws -> Int

格式化后的错误输出：

var countAssignedWorkers: @Sendable (
      _ shiftId: String,
      _ startsAtDay: String,
      _ startsAtTime: String,
      _ newAssignedWorkerIds: Set<String>,
      _ newUnassignedWorkerIds: Set<String>,
    ) async throws -> Int

可以看到，格式化工具在最后一个参数 newUnassignedWorkerIds 后添加了逗号，这会导致代码编译失败。

问题分析

这个问题主要出现在以下场景中：

1. 闭包参数使用了显式参数标签（如 _ shiftId:）
2. 参数列表较长，需要跨多行显示
3. 使用了 Swift 6.1 编译器
4. trailingCommas 规则被设置为 always

在 Swift 语法中，闭包参数列表的最后一个参数后不应该有逗号，这与数组或字典字面量的语法规则不同。SwiftFormat 在此处的行为实际上是一个 bug，因为它错误地将闭包参数列表与集合字面量的格式化规则混为一谈。

解决方案

该问题已在 SwiftFormat 的 0.56.2 版本中得到修复。开发团队迅速响应并提交了修复补丁，确保了工具在处理闭包参数列表时的正确性。

对于遇到此问题的开发者，建议：

1. 升级到 SwiftFormat 0.56.2 或更高版本
2. 如果暂时无法升级，可以考虑在受影响文件中暂时禁用 trailingCommas 规则
3. 检查项目中是否存在类似的闭包声明，确保它们没有被错误格式化

最佳实践

为了避免类似问题，建议开发者在以下情况下特别注意：

1. 当使用多行闭包参数声明时
2. 当闭包使用了 @Sendable 或其他属性修饰时
3. 当项目同时支持多个 Swift 版本时

定期更新代码格式化工具是保持代码健康的重要实践，这不仅能获得最新的功能改进，也能及时修复已知的问题。