ESLint 中设置和引用本地配置文件

本文档解释了如何在 ESLint 中设置和引用本地配置文件，尤其是当你有多个配置文件需要相互扩展并位于不同目录时。通过创建一个可共享的配置包，你可以更好地管理这些配置文件。下面详细解释这些内容。

本地配置文件解析

场景假设

假设你正在使用一个名为 eslint-config-myconfig 的包，目录结构如下：

myconfig
├── index.js
└─┬ lib
  ├── defaults.js
  ├── dev.js
  ├── ci.js
  └─┬ ci
    ├── frontend.js
    ├── backend.js
    └── common.js

配置文件的内容和引用

index.js 文件

index.js 文件是配置包的入口文件，它指定了默认的导出配置：

module.exports = require('./lib/ci.js');

lib/defaults.js 文件

defaults.js 文件包含一些默认规则：

module.exports = {
    rules: {
        'no-console': 1
    }
};

lib/ci.js 文件

ci.js 文件引用了 backend.js 配置：

module.exports = require('./ci/backend');

lib/ci/common.js 文件

common.js 文件包含一些通用规则，并扩展了 defaults.js：

module.exports = {
    rules: {
        'no-alert': 2
    },
    extends: 'myconfig/lib/defaults'
};

关键点：配置文件的路径引用

即使这些配置文件位于不同的目录中，你需要使用完整的包路径来引用需要扩展的配置文件。例如，common.js 中的 extends 使用的是 myconfig/lib/defaults，而不是相对路径。这确保了 ESLint 能够正确解析和加载配置文件。

lib/ci/backend.js 文件

backend.js 文件包含了一些特定的规则，并扩展了 common.js：

module.exports = {
    rules: {
        'no-console': 1
    },
    extends: 'myconfig/lib/ci/common'
};

解析总结

1. 入口文件 (index.js)：定义了默认导出的配置，可以是包中的任何配置文件。
2. 配置文件结构：配置文件可以分散在不同的目录中，但它们需要使用完整的包路径进行相互引用。
3. 路径引用：使用完整的包路径（如 myconfig/lib/defaults 或 myconfig/lib/ci/common），确保 ESLint 能够正确解析配置文件。

通过这种方式，你可以创建一个复杂但结构清晰的可共享配置包，方便在不同项目中复用和管理 ESLint 配置。这样即使配置文件分布在不同目录中，也可以通过完整的包路径确保它们能够正确扩展和应用。