共享配置
要共享您的 ESLint 配置，请创建一个**可共享的配置**。您可以将可共享的配置发布到npm，以便其他人可以下载并在其 ESLint 项目中使用它。
此页面说明如何创建和发布可共享的配置。
创建可共享的配置
可共享的配置只是导出配置对象或数组的 npm 包。首先，创建一个 Node.js 模块，就像您平时一样。
虽然您可以以任何您想要的方式命名包，但我们建议使用以下约定之一来使您的包更容易识别
- 以
eslint-config-开头，例如eslint-config-myconfig。 - 对于 npm作用域模块，将模块命名或前缀为
@scope/eslint-config，例如@scope/eslint-config或@scope/eslint-config-myconfig。
在您的模块中，从模块的main入口点文件导出可共享的配置。默认的入口点是index.js。例如
// index.js
export default [
{
languageOptions: {
globals: {
MyGlobal: true
}
},
rules: {
semi: [2, "always"]
}
}
];
因为index.js文件只是 JavaScript，所以您可以从文件中读取这些设置或动态生成它们。
发布可共享的配置
可共享的配置准备就绪后，您可以将其发布到 npm以与他人共享。我们建议在package.json文件中使用eslint和eslintconfig关键字，以便其他人可以轻松找到您的模块。
您应该在package.json中使用peerDependencies字段声明您对 ESLint 的依赖关系。推荐的方法是使用“>=”范围语法声明依赖项以实现面向未来的兼容性，并使用最低所需的 ESLint 版本。例如
{
"peerDependencies": {
"eslint": ">= 9"
}
}
如果您的可共享配置依赖于插件或自定义解析器，则应在您的package.json中将这些包指定为dependencies。
使用可共享的配置
要使用可共享的配置，请在eslint.config.js文件中导入该包并将其添加到导出的数组中，如下所示
// eslint.config.js
import myconfig from "eslint-config-myconfig";
export default [
...myconfig
];
覆盖来自可共享配置的设置
您可以通过在导入可共享的配置后直接将其添加到您的eslint.config.js文件中来覆盖来自可共享的配置的设置。例如
// eslint.config.js
import myconfig from "eslint-config-myconfig";
export default [
...myconfig,
// anything from here will override myconfig
{
rules: {
"no-unused-vars": "warn"
}
}
];
共享多个配置
因为可共享的配置只是 npm 包，所以您可以从同一个包中导出任意数量的配置。除了使用package.json中的main条目指定默认配置外，您还可以通过将新文件添加到 npm 包中，然后从您的eslint.config.js文件中引用它来指定其他可共享的配置。
例如，您可以在 npm 包的根目录中创建一个名为my-special-config.js的文件并导出一个配置，例如
// my-special-config.js
export default {
rules: {
quotes: [2, "double"]
}
};
然后，假设您使用包名称eslint-config-myconfig，您可以通过以下方式访问其他配置
// eslint.config.js
import myconfig from "eslint-config-myconfig";
import mySpecialConfig from "eslint-config-myconfig/my-special-config.js";
export default [
...myconfig,
mySpecialConfig,
// anything from here will override myconfig and mySpecialConfig
{
rules: {
"no-unused-vars": "warn"
}
}
];