ESLint Stylistic 规则中关于类与方法间空行的处理指南

在 JavaScript/TypeScript 代码风格规范中，控制代码块之间的空行对于提升代码可读性至关重要。ESLint Stylistic 项目提供了丰富的代码风格规则，其中关于空行控制的规则值得开发者深入理解。

问题背景

许多开发者期望类声明和类方法能够像函数声明一样被识别为"块状结构"(block-like)，从而在 padding-line-between-statements 规则下自动要求添加空行。然而实际上，类和方法默认不被视为块状结构，这可能导致不一致的代码风格。

核心规则解析

ESLint Stylistic 提供了两条相关规则来处理这类情况：

1. padding-line-between-statements：通用规则，用于控制任意语句之间的空行
2. lines-between-class-members：专门针对类成员之间空行的规则

实际应用方案

对于类和方法间的空行控制，推荐使用专门的 lines-between-class-members 规则而非通用的 padding-line-between-statements。这是因为：

1. 专用规则提供了更精确的控制粒度
2. 可以区分不同类成员类型（方法、属性、getter/setter等）
3. 配置更加直观明确

最佳实践建议

1. 对于类内部的成员间隔，优先配置 lines-between-class-members 规则
2. 对于类与外部代码的间隔，可以结合使用 padding-line-between-statements
3. 保持配置的一致性，团队内部应统一约定

配置示例

module.exports = {
  rules: {
    // 控制类成员间的空行
    '@stylistic/lines-between-class-members': [
      'error',
      'always',
      { exceptAfterSingleLine: true }
    ],
    
    // 控制类声明与其他代码间的空行
    '@stylistic/padding-line-between-statements': [
      'error',
      {
        blankLine: 'always',
        prev: ['class'],
        next: '*'
      }
    ]
  }
}

通过合理组合这两条规则，开发者可以实现精细化的空行控制，既保证类内部的清晰结构，又维持类与外部代码的适当间隔，从而提升整体代码的可读性和一致性。