在eslint-plugin-perfectionist中正确配置internalPattern匹配SvelteKit的$lib别名

eslint-plugin-perfectionist是一个用于优化代码风格的ESLint插件，其中的sort-imports规则可以帮助开发者自动整理和排序import语句。在使用SvelteKit框架时，开发者经常会遇到如何正确配置internalPattern来识别$lib别名的问题。

问题背景

SvelteKit框架提供了一个方便的$lib别名，指向项目的src/lib目录，开发者可以这样使用：

import { cart } from '$lib/services/stores';

当使用perfectionist/sort-imports规则时，开发者希望将这些$lib导入识别为内部模块，而不是外部依赖。常见的错误配置是：

internalPattern: ['$lib/**']

这种配置无法正确识别$lib导入，导致它们仍然被归类为外部模块。

正确配置方法

要正确匹配SvelteKit的$lib别名，需要使用正则表达式模式：

'perfectionist/sort-imports': [
  'error',
  {
    internalPattern: ['^\\$lib/.+'],
    type: 'natural'
  }
]

这个正则表达式^\\$lib/.+的解释：

• ^表示字符串开始
• \\$匹配$字符（需要转义）
• lib/匹配lib/字符串
• .+匹配一个或多个任意字符

为什么需要这样配置

1. 正则表达式要求：internalPattern选项实际上接受的是正则表达式模式，而不是简单的glob模式。$在正则中有特殊含义（匹配行尾），所以需要转义。

2. 完整路径匹配：^\\$lib/.+确保匹配的是以$lib/开头的完整路径，避免部分匹配的情况。

3. 与SvelteKit的兼容性：这种模式能正确识别SvelteKit项目中所有通过$lib别名导入的模块。

实际效果

配置正确后，以下导入：

import { cart } from '$lib/services/stores';
import { assign } from 'radashi';

将被正确识别为：

• $lib/services/stores：内部模块
• radashi：外部模块

并按照内部模块优先的规则进行排序。

总结

在使用eslint-plugin-perfectionist的sort-imports规则时，对于SvelteKit的lib别名，需要使用正则表达式`^\\lib/.+`作为internalPattern的值。这能确保工具正确识别这些导入为内部模块，从而实现预期的自动排序效果。理解配置背后的正则表达式原理，有助于开发者更灵活地处理各种自定义别名的情况。