SwiftFormat中测试规则时处理docComments规则的注意事项

在SwiftFormat项目中编写自定义格式化规则测试时，开发者可能会遇到一个常见问题：即使测试一个空规则实现，测试也会因为docComments规则而失败。本文将深入分析这一现象的原因，并提供两种有效的解决方案。

问题现象

当开发者创建一个空的格式化规则并编写测试时，如以下示例：

public let testRule = FormatRule(help: "Test.") { _ in }

然后编写测试用例：

func testSome() {
    let input = """
    guard let somethingTwo = test.somethingTwo else {
        return
    }
    // commentOne
    guard let somethingOne = test.somethingOne else {
        return
    }
    // commentTwo
    let something = xxx
    """
    
    let output = """
    guard let somethingTwo = test.somethingTwo else {
        return
    }
    // commentOne
    guard let somethingOne = test.somethingOne else {
        return
    }
    // commentTwo
    let something = xxx
    """
    
    testFormatting(for: input, output, rule: FormatRules.testRule)
}

测试会失败，错误信息显示docComments规则将// commentTwo修改为了/// commentTwo。

原因分析

这个问题的根本原因在于testFormatting函数的实际行为。该函数不仅会应用指定的规则，还会默认应用所有其他格式化规则。这是SwiftFormat测试框架的预期行为，目的是确保新规则不会与其他现有规则产生冲突。

具体来说：

1. testFormatting会首先应用所有格式化规则处理输入代码
2. 然后才会应用开发者指定的特定规则
3. 最后验证输出是否符合预期

因此，即使测试一个空规则实现，其他规则（如docComments）仍然会生效并修改代码。

解决方案

方案一：调整测试输入以符合docComments规则

修改测试用例中的注释，使其符合docComments规则的预期。将单行注释//改为文档注释///：

let input = """
    // ...其他代码...
    /// commentTwo
    let something = xxx
    """

let output = """
    // ...其他代码...
    /// commentTwo
    let something = xxx
    """

这种方法的优点是：

• 保持测试简洁，不需要额外配置
• 确保测试代码本身符合SwiftFormat的所有规则
• 更接近真实使用场景

方案二：显式排除docComments规则

在测试调用中明确排除docComments规则：

testFormatting(for: input, output, rule: FormatRules.testRule, exclude: ["docComments"])

这种方法的优点是：

• 允许测试专注于特定规则的行为
• 不需要修改测试输入来符合其他规则
• 当确实需要测试不符合docComments规则的代码时特别有用

最佳实践建议

1. 优先考虑方案一：在大多数情况下，调整测试代码使其符合所有格式化规则是更好的选择，因为这更接近实际使用场景。

2. 理解测试框架行为：编写测试时，要意识到testFormatting会应用所有规则，而不仅仅是指定的规则。

3. 保持测试代码规范：即使测试代码也应该遵循良好的格式规范，这有助于提高代码质量和可维护性。

4. 合理使用排除选项：只有在确实需要测试不符合某些规则的特定场景时，才使用exclude参数。

实际案例

假设我们正在开发一个处理guard语句间距的规则，测试用例可以这样编写：

func testGuardSpacing() {
    let input = """
    guard let somethingTwo = test.somethingTwo else {
        return
    }
    /// 这是一个文档注释
    guard let somethingOne = test.somethingOne else {
        return
    }
    let something = xxx
    """
    
    let output = """
    guard let somethingTwo = test.somethingTwo else {
        return
    }
    
    /// 这是一个文档注释
    guard let somethingOne = test.somethingOne else {
        return
    }
    
    let something = xxx
    """
    
    testFormatting(for: input, output, rule: FormatRules.guardSpacing)
}

注意我们使用了///文档注释，这样测试就能顺利通过，而不受docComments规则的干扰。

总结

理解SwiftFormat测试框架的工作机制对于编写有效的规则测试至关重要。通过合理处理docComments规则的影响，开发者可以创建更可靠、更易维护的测试用例。无论是调整测试代码使其符合所有规则，还是选择性地排除某些规则，都有其适用场景，开发者应根据具体情况选择最合适的方法。