ESLint Plugin Perfectionist 中装饰器排序与JSDoc注释的冲突问题解析

在TypeScript开发中，装饰器(Decorator)和JSDoc注释都是常用的代码特性。最近在ESLint Plugin Perfectionist项目中，发现了一个关于装饰器排序规则与JSDoc注释位置处理的值得关注的问题。

问题背景

当使用sort-decorators规则对类成员上的装饰器进行排序时，发现该规则会将装饰器移动到JSDoc注释的上方，这与大多数开发者的预期不符。通常情况下，JSDoc注释应该保持在所有装饰器之前，因为它是对整个成员（包括其装饰器）的文档说明。

问题表现

原始代码示例：

export class Test {
    /**
     * Test.
     */
    @B()
    @A()
    foo: number;
}

经过sort-decorators规则修复后，代码变为：

export class Test {
    @A()
    /**
     * Test.
     */
    @B()
    foo: number;
}

而开发者期望的结果应该是：

export class Test {
    /**
     * Test.
     */
    @A()
    @B()
    foo: number;
}

问题分析

这个问题的核心在于ESLint对注释节点的处理方式。默认情况下，注释节点会被关联到紧随其后的语法节点上。对于普通注释，这种行为是合理的，但对于JSDoc注释这种特殊的文档注释，应该保持其在所有装饰器之前的独立位置。

更复杂的情况出现在同时使用eslint-plugin-jsdoc插件时。如果启用了require-jsdoc规则，其自动修复功能会在装饰器上方添加JSDoc注释，而sort-decorators规则又会将装饰器移动到这些注释上方，导致无限循环的修复冲突，最终产生重复的JSDoc注释。

解决方案

项目维护者在v4.2.0版本中修复了这个问题。修复方案主要调整了装饰器排序时的注释处理逻辑，特别识别JSDoc注释并确保它们始终保持在所有装饰器之前。这种处理方式更符合开发者的直觉和代码规范。

最佳实践建议

1. 对于类成员的文档，建议始终使用JSDoc注释而非普通注释
2. 当同时使用装饰器和JSDoc时，将JSDoc放在所有装饰器之前
3. 保持装饰器的有序排列，可以使用sort-decorators规则来自动维护顺序
4. 升级到最新版本的ESLint Plugin Perfectionist以获得最佳的兼容性体验

这个问题的解决展示了开源社区如何通过反馈和协作不断改进工具链，使开发者能够更专注于业务逻辑而非格式问题。