Git submodule中ESLint如何覆盖父项目配置并解决插件重复加载问题

问题本质 #

ESLint 默认从执行命令的目录开始，向上递归遍历查找各级目录的配置文件。当core子模块的配置与父级client目录的配置同时显式声明同名ESLint插件时，就会触发插件重复加载的校验报错，同时伴随子模块配置被父级规则覆盖的问题。

解决步骤 #

1. 阻断配置递归继承 #

在core子模块的ESLint配置文件（通常为core/.eslintrc.js）中添加根配置标记：

module.exports = {
  // 新增配置项
  root: true,
  // 保留原有子模块配置
  extends: [/* 子模块专属规则配置 */],
  plugins: [/* 子模块专属插件声明 */]
}

配置root: true后，ESLint会将当前配置识别为项目根级配置，停止向上递归查找父目录的配置文件，从根源上切断父项目配置对子模块的继承链路。

2. 消除插件重复加载冲突 #

配置链路隔离后，按代码范围拆分插件声明职责：

• 子模块的ESLint配置中，仅声明校验自身代码需要的插件，配套在子模块本地的node_modules下安装对应版本的插件依赖
• 父项目的ESLint配置中，仅声明校验父项目自有代码需要的插件，不再跨层级引用子模块路径下的插件
• 若父子项目需使用同一款ESLint插件，尽量对齐版本号，减少版本差异引发的兼容问题

3. 可选优化：固定ESLint运行上下文 #

为规避路径解析偏差，可调整子模块的lint执行脚本，显式指定配置文件路径：

// core/package.json 脚本配置
{
  "scripts": {
    "lint": "eslint ./src/**/*.{js,jsx} --fix --config .eslintrc.js"
  }
}

内容的提问来源于stack exchange，提问作者Igor Paiva Ferreira