ESLint Plugin Perfectionist 中 sort-classes 规则的一个Bug解析

在 TypeScript 开发中，我们经常会使用 ESLint 的 perfectionist 插件来保持代码风格的一致性。最近，该插件在处理类方法重载签名时被发现存在一个有趣的格式化问题。

问题背景

当使用 perfectionist 插件的 sort-classes 规则，并配置了 newlinesInside: always 选项时，插件会在类方法的重载签名之间强制添加换行符。这在某些情况下会导致代码可读性下降，特别是当有多个重载签名时。

问题复现

考虑以下 TypeScript 类代码：

class Class {
  public a(parameter: number): string;
  public a(parameter: string): number;
  public a(parameter: number | string): number | string {
    return parameter;
  }

  public b(parameter: number): string;
  public b(parameter: string): number;
  public b(parameter: number | string): number | string {
    return parameter;
  }
}

当应用了特定的完美主义配置后，代码会被格式化为：

class Class {
  public a(parameter: number): string;

  public a(parameter: string): number;

  public a(parameter: number | string): number | string {
    return parameter;
  }

  public b(parameter: number): string;

  public b(parameter: string): number;

  public b(parameter: number | string): number | string {
    return parameter;
  }
}

问题分析

这种格式化行为存在两个主要问题：

1. 过度格式化：在方法重载签名之间强制添加换行符，会导致代码垂直间距过大，特别是在有多个重载的情况下。

2. 与常见风格指南冲突：大多数 TypeScript 风格指南建议将重载签名紧密排列，只在实现前添加一个换行符，以保持代码的紧凑性和可读性。

解决方案

该问题已在 perfectionist 插件的 4.8.0 版本中得到修复。修复后的行为更符合开发者的预期：

• 不再在重载签名之间强制添加换行符
• 保持重载签名的紧凑排列
• 只在实现体前添加适当的间距

最佳实践建议

对于 TypeScript 类方法的格式化，建议：

1. 保持重载签名紧密排列，以显示它们属于同一个方法
2. 在实现体前添加适当的间距，以区分签名和实现
3. 考虑使用 JSDoc 注释来增强重载方法的文档化

这个修复体现了 perfectionist 插件团队对开发者体验的关注，也展示了开源社区如何通过反馈和改进来不断提升工具的质量。