SwiftFormat 中 organizeDeclarations 规则处理空白行的优化解析

在 Swift 代码格式化工具 SwiftFormat 的使用过程中，开发者可能会遇到一个关于 organizeDeclarations 规则的有趣问题。这个规则旨在自动组织类或结构体中的声明顺序，并添加适当的 MARK 注释来划分不同访问级别的代码块。

问题的核心在于当原始代码中包含仅含空白字符的空行时，organizeDeclarations 规则会在处理后产生多余的空行。例如，考虑以下原始代码：

public class TestClass {
    var variable01 = 1
    var variable02 = 2
    var variable03 = 3
    var variable04 = 4
    var variable05 = 5
    
    public func foo() {
    }
    
    internal func bar() {
    }
    
    private func baz() {
    }
}

当应用 organizeDeclarations 规则后，输出结果会在 MARK 注释后产生额外的空行：

public class TestClass {

    // MARK: Public

    
    public func foo() {
    }

    // MARK: Internal

    var variable01 = 1
    var variable02 = 2
    var variable03 = 3
    var variable04 = 4
    var variable05 = 5

    
    internal func bar() {
    }

    // MARK: Private

    
    private func baz() {
    }
}

这种现象的产生原因是 SwiftFormat 在处理空白行时的一个边界情况。原始代码中的空行实际上包含空白字符（如空格或制表符），而格式化工具未能完全识别这些"看似空"但实际上包含内容的行。当 organizeDeclarations 规则尝试在声明之间添加分隔时，它会保留这些空白行，同时添加自己的格式化空行，导致最终结果中出现重复的空行。

这个问题在实际开发中可能会引起一些困扰，特别是当项目同时使用 SwiftFormat 和 SwiftLint 这类工具时。SwiftLint 可能会将这些多余的空行标记为问题，而开发者运行 SwiftFormat 的检查命令时又会报告 organizeDeclarations 规则存在问题，形成一种工具间的"乒乓效应"。

幸运的是，SwiftFormat 的开发团队已经识别并修复了这个问题。修复方案主要改进了空白行的处理逻辑，确保在添加 MARK 注释和重新组织声明时，能够正确识别和处理仅含空白字符的行。这个修复已经在 SwiftFormat 的 0.54.6 版本中发布。

对于开发者而言，这个案例提醒我们在使用代码格式化工具时需要注意几个要点：

1. 空白字符的处理往往容易被忽视，但它们可能影响格式化结果
2. 当同时使用多个代码质量工具时，要注意它们之间的交互可能产生意外结果
3. 保持工具版本更新可以获取最新的问题修复和功能改进

理解这些底层机制有助于开发者更好地利用工具提升代码质量，同时在遇到问题时能够更快地定位原因并找到解决方案。