SwiftFormat 中 await 关键字与 swift-testing 库的格式问题解析

SwiftFormat 是 Swift 代码格式化工具中的佼佼者，但在处理某些特定语法结构时仍会遇到边缘情况。本文将深入分析一个与 Apple 新测试框架 swift-testing 相关的格式化问题，特别是 await 关键字在测试断言中的位置问题。

问题现象

当开发者在使用 swift-testing 框架编写异步测试时，常见的断言语句格式如下：

#expect(await monitor.isAvailable == false)

然而，使用 SwiftFormat v0.53.8 版本格式化后，代码会变成：

#expect await (monitor.isAvailable == false)

这种格式化结果不仅不符合代码习惯，还可能影响代码的可读性。await 关键字被错误地从括号内移动到了括号前，改变了代码的语义表达。

技术背景

这个问题涉及几个关键技术点：

1. swift-testing 框架：Apple 推出的新一代测试框架，预计从 Xcode 16 开始内置支持
2. await 关键字：Swift 并发模型中的关键语法，用于标记异步操作
3. 宏表达式：#expect 是 swift-testing 提供的测试断言宏

在 Swift 并发编程中，await 关键字的正确位置对于代码的可读性和正确性至关重要。它应该紧邻实际的异步操作，而不是被分离到表达式之外。

解决方案

对于遇到此问题的开发者，目前有两种解决方案：

1. 临时解决方案：在 SwiftFormat 配置文件中添加 --disable hoistAwait 选项，这会禁止格式化工具移动 await 关键字的位置

2. 永久解决方案：升级到 SwiftFormat v0.54.0 或更高版本，该版本已修复此特定问题

最佳实践建议

在处理类似的新语法特性时，建议开发者：

1. 保持 SwiftFormat 工具的最新版本，以获取最新的语法支持
2. 对于关键项目，在全面应用格式化规则前，先在小范围测试格式化效果
3. 了解 SwiftFormat 提供的各种禁用选项，在必要时可以针对特定规则进行禁用

总结

代码格式化工具虽然强大，但在面对语言新特性时偶尔会出现边缘情况。这个 await 关键字的格式化问题展示了工具与语言演进之间的微妙关系。通过理解问题本质和掌握解决方案，开发者可以更好地平衡代码规范与功能正确性之间的关系。

随着 Swift 语言的持续发展，类似的工具适配问题可能会不时出现。保持工具更新和深入理解格式化规则，是每个重视代码质量的开发者的必修课。