eslint-plugin-perfectionist 项目中的对象排序问题解析

问题背景

在 JavaScript/TypeScript 开发中，eslint-plugin-perfectionist 是一个用于代码风格优化的 ESLint 插件，它提供了多种规则来帮助开发者保持代码的一致性和美观性。其中，sort-object 规则用于强制对象属性的排序，但在特定环境下会出现运行时错误。

问题现象

当开发者在项目中同时使用 TypeScript 和该插件时，可能会遇到以下错误：

Cannot read properties of undefined (reading 'getTokensBefore')

这个错误通常发生在尝试对包含多个属性的对象进行排序检查时。例如：

const something = {
  b: false,
  a: true,
};

技术分析

错误根源

经过深入分析，这个问题与 typescript-eslint 解析器的版本兼容性有关。具体表现为：

1. 当项目同时使用 @typescript-eslint 套件（特别是 parser 和 utils）时
2. 在 ESLint 配置中同时配置了对 JavaScript 和 TypeScript 文件的解析
3. 插件内部在处理对象属性排序时，未能正确处理 TypeScript 解析器生成的 AST 节点

影响范围

该问题影响以下环境组合：

• eslint-plugin-perfectionist 2.7.0 版本
• @typescript-eslint 相关包（parser/utils/eslint-plugin）6.x 版本
• 混合使用 JavaScript 和 TypeScript 的项目

解决方案

项目维护者在 v3.0.0 版本中修复了这个问题。主要修复内容包括：

1. 改进了对 TypeScript AST 节点的处理逻辑
2. 增强了与 @typescript-eslint 解析器的兼容性
3. 优化了规则内部对 token 的获取方式

最佳实践建议

对于需要使用该插件的开发者，建议：

1. 升级到最新版本的 eslint-plugin-perfectionist（v3.0.0+）
2. 确保 @typescript-eslint 相关依赖保持最新
3. 在 ESLint 配置中正确设置解析器覆盖规则
4. 对于混合项目，明确区分 JavaScript 和 TypeScript 文件的解析方式

总结

这个问题的解决展示了开源社区如何快速响应和修复兼容性问题。对于开发者而言，保持依赖项更新和正确配置是避免类似问题的关键。eslint-plugin-perfectionist 的维护团队通过这次修复，进一步提升了插件在 TypeScript 项目中的稳定性和可用性。