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

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

2025-05-28 20:12:56作者:咎岭娴Homer

在 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. 保持工具版本更新可以获取最新的问题修复和功能改进

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

登录后查看全文
热门项目推荐
相关项目推荐

热门内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
143
1.92 K
kernelkernel
deepin linux kernel
C
22
6
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
274
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
929
553
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
422
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
65
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8