Swift-Format 中 NoEmptyLinesOpeningClosingBraces 规则的使用注意事项

在 Swift 代码格式化工具 Swift-Format 的使用过程中，开发者可能会遇到 NoEmptyLinesOpeningClosingBraces 规则不生效的情况。这个问题涉及到 Swift-Format 版本兼容性和规则实现的细节，值得开发者深入了解。

NoEmptyLinesOpeningClosingBraces 是一个用于规范代码大括号前后空行的格式化规则。当设置为 true 时，它会自动移除大括号前后的空行，使代码更加紧凑。例如：

// 格式化前
struct Test {

    let testVar: String = ""

}

// 格式化后（预期效果）
struct Test {
    let testVar: String = ""
}

然而，许多开发者在使用快捷键格式化代码时发现，这个规则并没有按预期工作。经过分析，这主要是因为该规则在 Swift-Format 6.0 版本中尚未实现，只有在 6.1 及更高版本中才被包含。

对于开发者而言，需要注意以下几点：

1. 版本兼容性：检查你使用的 Swift-Format 版本是否支持该规则。6.0 及以下版本无法使用此功能。

2. 规则优先级：即使在新版本中，某些情况下格式化可能不会完全删除空行，而是仅移除空格。这与格式化引擎的具体实现有关。

3. 替代方案：在等待新版本发布期间，可以考虑手动调整代码风格，或使用其他工具辅助检查。

4. 配置验证：确保 .swift-format 配置文件被正确加载，其他规则能正常工作，以排除配置问题。

在实际开发中，保持代码风格一致性对团队协作至关重要。虽然 NoEmptyLinesOpeningClosingBraces 规则看似只是处理空行的小细节，但它能显著提升代码的可读性和一致性。建议开发者在项目升级到支持该规则的 Swift-Format 版本后，积极采用这一规范。

对于需要立即使用此功能的团队，可以考虑从源码构建最新版本的 Swift-Format，但这需要权衡维护成本和收益。大多数情况下，等待官方稳定版本发布是更稳妥的选择。