ESLint插件Perfectionist中实现自定义类成员排序分组

在Angular开发中，我们经常遇到类成员排序的问题，特别是当使用依赖注入(DI)时。ESLint插件Perfectionist的sort-classes规则可以帮助我们保持代码整洁，但默认配置可能无法满足所有特定场景的需求。

问题背景

传统Angular组件中，依赖注入通常通过构造函数实现，这种模式下的代码排序相对直观：

export class ExampleComponent {
  public user = this.authService.user;

  constructor(private readonly authService: AuthService) {
  }
}

随着Angular引入新的inject函数语法，依赖注入可以直接在类属性中完成：

export class ExampleComponent {
  public user = this.authService.user;
  private readonly authService = inject(AuthService);
}

这种写法虽然简洁，但会引发排序问题：如果访问注入服务的属性(如user)在注入声明(如authService)之前，就会导致运行时错误。

解决方案

Perfectionist插件的sort-classes规则在v3.0.0版本中增加了自定义分组功能，允许开发者定义特定的排序规则来解决这类问题。

自定义分组配置

我们可以通过ESLint配置为特定模式的类成员创建优先排序组：

{
  "perfectionist/sort-classes": [
    "error",
    {
      "groups": [
        { "type": "property", "name": "inject-*", "order": "asc" },
        "public-property",
        "private-property",
        "constructor",
        "method"
      ],
      "order": "asc"
    }
  ]
}

这个配置会确保所有名称匹配"inject-*"模式的属性优先排序，避免了依赖注入相关的运行时错误。

针对Angular装饰器的处理

对于Angular的@Input装饰器，同样可以通过自定义分组实现优先排序：

{
  "perfectionist/sort-classes": [
    "error",
    {
      "groups": [
        { "type": "property", "decorator": "Input", "order": "asc" },
        { "type": "property", "name": "inject-*", "order": "asc" },
        "public-property",
        "private-property",
        "constructor",
        "method"
      ]
    }
  ]
}

这样配置后，带有@Input装饰器的属性会排在最前面，然后是依赖注入属性，最后是其他常规类成员。

实施建议

1. 根据项目实际情况定义合理的分组顺序
2. 对于框架特定模式(如Angular的依赖注入)，建议创建专门的分组
3. 团队内部应统一排序规则配置
4. 将配置放入共享的ESLint配置中，确保所有项目一致

通过合理配置Perfectionist插件的sort-classes规则，可以显著提高代码的可读性和可维护性，同时避免因成员排序不当导致的运行时错误。