ESLint Plugin Perfectionist 中 sort-imports 规则的 newlinesBetween 配置问题解析

在 JavaScript 项目中，import 语句的组织和格式化是代码规范的重要组成部分。ESLint Plugin Perfectionist 提供了强大的 sort-imports 规则来帮助开发者保持 import 语句的一致性和可读性。本文将深入分析该规则中 newlinesBetween 配置项的一个特殊行为问题及其解决方案。

问题背景

sort-imports 规则允许开发者通过 groups 数组来定义 import 语句的分组方式，并通过 newlinesBetween 属性控制组间的空行数量。然而，当配置中存在多个 newlinesBetween 定义时，会出现一些不符合预期的行为。

问题复现

考虑以下配置示例：

'perfectionist/sort-imports': [
  'warn',
  {
    groups: [
      ['internal'],
      {newlinesBetween: 'never'},
      ['parent'],
      {newlinesBetween: 'never'},
      ['index', 'sibling'],
    ],
    internalPattern: ['^#'],
    newlinesBetween: 'always',
  },
]

开发者期望的行为是：

1. internal 组和 parent 组之间不空行
2. parent 组和 index/sibling 组之间不空行
3. 其他情况都空行

然而实际行为是：

• 当 parent 组没有实际 import 时，internal 组和 index/sibling 组会被强制分隔
• 只有当 parent 组有实际 import 时，才会按预期工作

技术分析

这个问题的本质在于 newlinesBetween 配置的实现逻辑。当前的实现方式是将 newlinesBetween 对象视为相邻两个组之间的分隔符，而不是全局性的分隔规则。

更合理的实现应该是：

• newlinesBetween 配置应该影响其上所有组与其下所有组之间的分隔
• 而不是仅仅影响直接相邻的两个组

解决方案

该问题已在最新版本(v4.11.0)中得到修复。修复后的行为符合开发者的预期：

• newlinesBetween 配置现在会正确影响所有相关组之间的分隔
• 无论中间组是否有实际 import，分隔规则都会一致应用

最佳实践建议

在使用 sort-imports 规则时，建议：

1. 明确定义所有需要的分组
2. 谨慎使用多个 newlinesBetween 配置
3. 对于复杂的分组需求，考虑拆分为多个规则配置
4. 保持配置的简洁性，避免过度复杂的嵌套

总结

ESLint Plugin Perfectionist 的 sort-imports 规则是一个强大的工具，能够帮助团队保持代码风格的一致性。理解其配置项的实际行为对于有效使用该规则至关重要。通过这次问题的修复，规则的配置行为更加符合直觉，为开发者提供了更好的使用体验。