Swift-Format配置文件支持注释的技术实现解析

在Swift项目的代码格式化工具swift-format中，开发者长期以来面临一个痛点：配置文件.swift-format作为JSON格式文件，原生不支持注释功能。这个问题在2025年5月被正式提出并快速得到了解决。

背景与需求

配置文件中的注释对于团队协作和长期维护至关重要。注释可以帮助开发者：

• 记录特定配置项的决策原因
• 临时禁用某些规则
• 为团队成员提供配置说明

然而标准的JSON格式不支持注释，这迫使开发者不得不通过外部文档或代码注释等方式间接记录配置信息，降低了配置的可维护性。

技术解决方案

Swift-format团队采用了JSON5作为解决方案，这是JSON的超集，主要增加了以下特性：

1. 支持单行（//）和多行（/* */）注释
2. 允许尾随逗号
3. 支持单引号字符串
4. 数字可以包含前导或尾随小数点

在实现上，只需要在Swift代码中使用Foundation框架的JSONDecoder时，设置其allowsJSON5属性为true即可：

let decoder = JSONDecoder()
decoder.allowsJSON5 = true

这个改动虽然简单，但对开发者体验的提升却非常显著。

影响与最佳实践

这个改动使得.swift-format配置文件现在可以这样编写：

{
  // 团队约定的缩进规则
  "indentation": {
    "spaces": 2  // 使用2空格缩进而非制表符
  },
  /*
   * 以下规则用于兼容旧代码库
   * 计划在下个季度统一清理
   */
  "lineLength": 120
}

对于使用者来说，建议：

1. 使用注释说明非默认值的配置原因
2. 为暂时性配置添加TODO注释和过期时间
3. 避免过度注释，只注释那些不直观的配置

实现启示

这个改进展示了良好开发者体验的几个关键点：

1. 配置应该人性化而非机器优先
2. 小改动可以带来大体验提升
3. 遵循社区已有标准（JSON5）而非创造新格式

类似的配置格式改进思路也可以应用到其他工具的配置设计中，特别是那些需要团队协作维护的配置文件。

未来展望

随着Swift生态的发展，配置文件的易用性会越来越受重视。可能的后续改进包括：

• 配置项的自动文档生成
• 配置schema验证
• 编辑器对配置注释的特殊支持

这个看似小的改进，实际上代表了开发者工具向更加人性化方向发展的趋势。