如何在 ESLint 中优雅地扩展并覆盖规则配置(避免重复定义)

夏杰姑娘_9099

夏杰姑娘_9099

2026-04-26

395人浏览

原创

如何在 ESLint 中优雅地扩展并覆盖规则配置(避免重复定义)

本文详解如何在 eslint 单配或多层继承场景中,对已继承的规则(如 import/order)进行增量式覆盖,避免全量重写,提升配置可维护性与复用性。

本文详解如何在 eslint 单配或多层继承场景中,对已继承的规则(如 import/order)进行增量式覆盖,避免全量重写,提升配置可维护性与复用性。

在大型 React Monorepo 项目中,常需为不同子包(如 web 和 ui)复用基础 ESLint 配置(如 ./base.json),同时按需定制规则。但直接在子配置中重写整个 import/order 规则(如你当前 web.json 所做)不仅冗余,还易引发遗漏或冲突——一旦 base.json 中 import/order 的 groups 或 newlines-between 调整,web.json 必须同步更新,违背配置继承的设计初衷。

ESLint 原生不支持对嵌套对象规则的“深合并”,但可通过 overrides + 文件匹配机制实现精准、增量式覆盖:仅针对特定文件类型(如 .js 或 .ts)注入增强配置,而保留基线规则的其余部分。

✅ 正确做法:使用 overrides 实现规则增量扩展

将 web.json 改写为如下结构:

{
  "extends": ["./base.json", "next/core-web-vitals"],
  "overrides": [
    {
      "files": ["**/*.js", "**/*.jsx", "**/*.ts", "**/*.tsx"],
      "rules": {
        "@next/next/no-img-element": "off",
        "import/order": [
          "warn",
          {
            "groups": ["type", "builtin", "external", "internal", "parent", "sibling", "index", "object"],
            "pathGroups": [
              {
                "pattern": "@/custom/**",
                "group": "internal"
              }
            ],
            "newlines-between": "always"
          }
        ]
      }
    }
  ]
}

? 关键说明:

  • overrides.files 指定作用范围(推荐覆盖所有源码后缀),确保该规则只在目标文件中生效;
  • overrides.rules 中的 import/order 完整定义看似重复,实则是必需的“覆盖入口”;但因其作用域受限,不会污染其他文件,且逻辑清晰;
  • 基线 base.json 中的 import/order 配置(如 groups、newlines-between)仍被继承,此处只需补充 pathGroups ——即语义上是“扩展”,技术上是“覆盖+复用”。

⚠️ 注意事项与最佳实践

  • 不要省略 groups 和 newlines-between:ESLint 规则值是完整数组 [level, options],覆盖时必须提供完整选项对象,否则会丢失基线配置;
  • 优先使用 overrides 而非顶层 rules:顶层 rules 会无差别覆盖所有文件,破坏基线统一性;overrides 提供粒度控制;
  • 路径别名需与 TypeScript/webpack 配置一致:@/custom/** 能被 import/order 识别,前提是你的 tsconfig.json 或 jsconfig.json 已正确定义 baseUrl 和 paths;
  • 验证配置是否生效:运行 npx eslint . --ext .js,.jsx,.ts,.tsx --fix 并检查 import 排序结果,或使用 VS Code ESLint 插件实时提示。

✅ 总结

ESLint 的配置继承本质是“浅合并”,无法自动合并嵌套规则对象。通过 overrides 机制,你既能保持 base.json 的纯净与通用性,又能在 web.json 中以声明式方式精准扩展规则细节。这种模式显著提升多环境配置的可维护性,是 Monorepo 场景下的推荐实践。

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

4406

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1109

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

4324

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

880

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

1776

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

3185

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

4133

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

2660

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

868

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.6万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.4万人学习