ESLint Stylistic 项目中关于 TS enum 空行规则的增强

背景介绍

在 TypeScript 开发中，代码风格一致性对于团队协作和代码可维护性至关重要。ESLint Stylistic 是一个专注于代码风格的 ESLint 插件，其中的 padding-line-between-statements 规则用于控制语句之间的空行，帮助开发者保持一致的代码间距风格。

问题发现

在 TypeScript 项目中，枚举（enum）是一种常用的数据结构定义方式。然而，开发者发现现有的 padding-line-between-statements 规则无法正确处理 TypeScript 枚举声明前后的空行问题。这意味着：

1. 无法自动检测枚举声明前后的空行是否符合团队规范
2. 无法自动修复不符合规范的枚举声明空行
3. 需要手动维护枚举相关的代码间距

技术分析

该问题的根本原因在于规则实现时没有将 TypeScript 的枚举声明（TSEnumDeclaration）纳入支持范围。具体表现为：

• 规则内部的关键字测试器（keywordTester）缺少对 enum 类型的支持
• AST 解析时没有处理 TSEnumDeclaration 节点类型
• 修复功能无法识别枚举声明的位置

解决方案

通过分析源代码，解决方案相对简单直接：

1. 在规则的关键字测试器中添加对 enum 的支持
2. 使用 AST_NODE_TYPES.TSEnumDeclaration 节点类型
3. 实现与其它语句类型相同的空行检查逻辑

核心代码修改只需添加以下几行：

'enum': newKeywordTester(
  AST_NODE_TYPES.TSEnumDeclaration,
  'enum',
),

影响范围

这一改进将影响以下方面：

1. 现在可以检查枚举声明前后的空行
2. 支持自动修复枚举相关的空行问题
3. 与其它语句类型的空行规则保持一致性
4. 提升 TypeScript 项目的代码风格统一性

最佳实践建议

对于使用此规则的项目，建议：

1. 明确团队对枚举声明空行的规范要求
2. 考虑枚举声明与周围代码的视觉关系
3. 可以配置为在枚举前后都保留空行，提高可读性
4. 对于连续的枚举声明，可以配置为不需要中间空行

总结

ESLint Stylistic 项目通过这一改进，完善了对 TypeScript 枚举声明的代码风格支持，使得 TypeScript 项目的代码风格检查更加全面。这一变化虽然看似微小，但对于大型 TypeScript 项目维护一致的代码风格具有重要意义。