SwiftFormat中实现仅检查行长度的最佳实践

SwiftFormat是一款强大的Swift代码格式化工具，它不仅能自动格式化代码，还能通过lint模式检查代码风格问题。在实际开发中，我们经常会遇到一个需求：希望自动格式化大部分代码风格问题，但对于某些特定规则（如行长度限制）只进行警告而不自动修改。

为什么需要仅检查行长度

行长度限制是一个常见的代码规范要求，但自动换行有时会降低代码可读性。例如：

• 链式调用被强制换行后可能更难追踪
• 复杂的条件判断语句被分割后逻辑关系变得模糊
• 表格数据对齐被破坏

因此，很多团队希望在保持其他格式化规则自动应用的同时，仅对行长度问题进行提示，让开发者手动决定最佳换行方式。

解决方案

SwiftFormat提供了两种方式来处理这种需求：

方法一：分两次运行

1. 第一次运行使用格式化模式，应用除行长度外的所有规则：

swiftformat --config .swiftformat .

2. 第二次运行使用lint模式，仅检查行长度：

swiftformat --lint --rules wrap --maxwidth 120 .

这种方法的优点是清晰明确，缺点是需要在构建流程中配置两次运行。

方法二：使用lintonly配置

在.swiftformat配置文件中，可以指定某些规则仅在lint模式下生效：

--lintonly wrap
--maxwidth 120

然后运行时使用：

swiftformat --lint --config .swiftformat .

这种方法的优点是可以统一管理配置，缺点是理解成本略高，且需要明确区分格式化模式和lint模式。

实际应用建议

对于大多数项目，推荐采用方法一，因为：

1. 意图更加明确，便于团队理解
2. 可以精确控制哪些规则在哪种模式下运行
3. 更容易集成到CI/CD流程中
4. 当需要调整规则时，修改更加直观

如果项目已经建立了完善的SwiftFormat使用规范，且团队成员都熟悉其配置方式，方法二也是一个不错的选择，可以减少配置文件的复杂度。

注意事项

1. --maxwidth是一个选项(option)，而--lintonly应用于规则(rule)，因此不能直接组合使用
2. 行长度规则的实际名称是wrap，而不是maxwidth
3. 在CI环境中，lint模式的退出代码可以用于阻断不符合规范的代码合并

通过合理配置SwiftFormat，我们可以在保持代码整体风格一致的同时，对行长度这类特殊规则进行灵活处理，既保证了代码质量，又不牺牲可读性。