ESLint插件Perfectionist新增对只读属性的排序支持

在TypeScript类成员排序规则中，只读属性(readonly)的处理一直是一个值得关注的问题。最近，ESLint插件Perfectionist在其3.2.0版本中新增了对只读属性的排序支持，为开发者提供了更精细的类成员组织能力。

背景与需求

在TypeScript开发中，类成员的排序和组织对于代码的可读性和维护性至关重要。许多团队都制定了相应的代码风格规范，其中就包括类成员的排序规则。常见的排序维度包括访问修饰符(public/private/protected)、静态属性、成员类型(属性/方法)等。

然而，TypeScript特有的readonly修饰符之前并没有被纳入Perfectionist插件的排序考量中。这导致开发者在使用该插件时，无法将只读属性与非只读属性分开组织，影响了代码的清晰度。

实际应用场景

考虑以下TypeScript类示例：

class Game {
  private readonly runway = 5;
  private participants = new Array<Player>();
  private readonly voted = new Set<Player>();
}

开发者通常希望将只读属性集中放置，形成更清晰的代码结构：

class Game {
  private readonly runway = 5;
  private readonly voted = new Set<Player>();
  
  private participants = new Array<Player>();
}

这种组织方式使得类的不可变部分和可变部分明确分离，提高了代码的可读性和维护性。

技术实现

Perfectionist插件通过扩展其sort-classes规则，新增了对readonly修饰符的支持。开发者现在可以在配置中指定是否要将只读属性作为排序的一个维度。

配置示例如下：

{
  "perfectionist/sort-classes": [
    "error",
    {
      "groups": [
        "readonly-property",
        "property"
      ],
      "order": "asc"
    }
  ]
}

这种实现方式保持了与插件现有API的一致性，同时提供了足够的灵活性来满足不同团队的代码风格需求。

最佳实践建议

1. 一致性优先：团队应统一决定是否将只读属性单独分组，并在整个项目中保持一致。

2. 结合其他规则：可以将只读属性排序与其他排序规则(如访问修饰符、静态属性等)结合使用，创建更细致的代码组织结构。

3. 渐进式采用：对于已有项目，可以考虑逐步引入此规则，先作为警告而非错误，待团队适应后再强制执行。

4. 文档说明：在项目的代码风格指南中明确记录排序规则，方便新成员快速上手。

总结

Perfectionist插件对只读属性排序的支持，填补了TypeScript类成员排序的一个重要空白。这一特性使得开发者能够更好地组织类结构，特别是对于包含大量成员的大型类，能够显著提高代码的可读性和可维护性。作为TypeScript生态中的一项实用工具增强，它将继续帮助开发者保持代码的一致性和整洁性。