Ktlint 项目中关于 when 语句分支空行插入的格式化探讨

在 Kotlin 代码格式化工具 Ktlint 的开发过程中，关于 when 语句分支之间是否应该插入空行的问题引发了深入的讨论。这个问题涉及到代码可读性、一致性以及开发者偏好的平衡。

背景与现状

Kotlin 官方编码规范建议，在 when 语句中，如果一个分支超过单行，可以考虑在其与相邻分支之间插入空行以提高可读性。然而，当前版本的 Ktlint (1.1.1) 并未实现这一格式化规则。

不同格式化方案的对比

开发团队提出了三种主要的格式化方案：

1. IDEA 默认格式化方案：仅在多行分支后插入空行

   when (input) {
       is String -> "text"
       is Int -> 
           "number"
           
       is Boolean -> {
           "boolean"
       }
       else -> null
   }
   

2. 统一空行方案：在所有分支之间插入空行

   when (input) {
       is String -> "text"
       
       is Int -> 
           "number"
           
       is Boolean -> {
           "boolean"
       }
       
       else -> null
   }
   

3. 统一空行+大括号方案：在所有分支之间插入空行并强制使用大括号

   when (input) {
       is String -> {
           "text"
       }
       
       is Int -> {
           "number"
       }
       
       is Boolean -> {
           "boolean"
       }
       
       else -> {
           null
       }
   }
   

技术分析与决策

经过社区调研和讨论，大多数开发者倾向于第一种方案（IDEA 默认格式化），认为它在保持代码紧凑性和可读性之间取得了最佳平衡。完全统一空行的方案虽然更加一致，但可能导致代码出现过多不必要的空白。

关于是否强制使用大括号的问题，团队认为应当保持灵活性。对于简单的单行表达式，强制使用大括号会增加不必要的代码行数，降低可读性。

实现方案

Ktlint 最终决定：

1. 引入新规则，当 when 语句包含多行分支时，在所有分支之间插入空行
2. 不强制要求简单分支使用大括号
3. 提供配置选项让开发者选择是否启用这一规则

这一决策既遵循了 Kotlin 官方规范的建议，又考虑了实际开发中的可读性和实用性需求，体现了 Ktlint 在代码格式化方面的灵活性和实用性原则。