【Eslint配置】 eslint-config-* 和 eslint-plugin-* 的区别

前言

应该有很多同学在配置eslint文件的时候,会有这样的疑问,为什么每种校验模块包要分成 config/plugin 两个版本,并且有时候在plugins引入了插件,还可以再以extends方式去使用插件,既然插件这么全能,为何要有 eslint-config-* 呢?

探索

eslint-config-* 的配置形式

以 eslint-config-airbnb 为参考
    module.exports = {
      extends: [
        'eslint-config-airbnb-base',
        './rules/react',
        './rules/react-a11y',
      ].map(require.resolve),
      rules: {}
    };

你会发现就是一个简单的.eslintrc对象,再往它 —> 继承的文件 里去看

以 ./rules/react 为参考
    module.exports = {
      plugins: [
        'react',
      ],
    
      parserOptions: {
        ecmaFeatures: {
          jsx: true,
        },
      },
      rules: {...无数规则声明s}
    }

是不是很神奇,继承链的顶端忽然之间就没那么神秘了。其实就是一个 常规的.eslintrc文件,那我们可以理解最终被 eslint所识别的配置文件就是所有继承文件的属性合并,并且子类覆盖父类。

eslint-plugin-* 的配置形式

以eslint-plugin-react 为参考对象

    // 引用规则的验证逻辑块
    const allRules = {
      'boolean-prop-naming': require('./lib/rules/boolean-prop-naming'),
      'button-has-type': require('./lib/rules/button-has-type'),
      ...
    };

    // 导出的对象
    module.exports = {
      deprecatedRules,
      rules: allRules,
      configs: {
        recommended: {
          plugins: [
            'react'
          ],
          parserOptions: {
            ecmaFeatures: {
              jsx: true
            }
          },
          rules: {
            'react/display-name': 2,
            'react/jsx-key': 2,
            ...
          }
        },
        all: {
          plugins: [
            'react'
          ],
          parserOptions: {
            ecmaFeatures: {
              jsx: true
            }
          },
          rules: activeRulesConfig
        }
      }
    };

以上我们可以看出,allRules包含了所有的规则,并且所有的规则逻辑都是通过 require 的形式获取到真正的校验逻辑。

真相

至此,真相大白 ->

  • 所有规则的校验逻辑都包含在plugin模块里面
  • config只是一种指定了plugin对应的规则状态的配置文件
  • 可以确定的就是 config已经在导出的配置结构中的plugins内包含了plugin对应的插件,以至于我们在实际.eslintrc文件内是不需要再重复添加到plugins的数组内的
  • 因此所依赖的插件在没有对应config文件的情况下,如果没有指定rules,它的规则其实是不会发生校验的
  • 事实上 eslint-config-* 功能定位是偏弱化的,但是从降低耦合的角度来说这样分开更符合软件科学

个人观点:
主动去添加重复的plugin名这一行为的好处大概就是可以让不了解eslintrc继承结构的人能从项目目录下更直观的了解该项目所依赖的插件,可以有据可查地在rules里手动去修正一些自己觉得不符合科学的规则。

                                                  编辑 by  buddy  Date: 2020/01/11
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,236评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,867评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,715评论 0 340
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,899评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,895评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,733评论 1 283
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,085评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,722评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,025评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,696评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,816评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,447评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,057评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,009评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,254评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,204评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,561评论 2 343

推荐阅读更多精彩内容