认识Eslint以及项目常见的.eslintrc.js配置

什么是eslintrc

ESLint旨在完全可配置,这意味着你可以关闭每个规则并仅使用基本语法验证运行,或混合并匹配捆绑规则和自定义规则,以使ESLint完美适合您的项目。配置ESLint有两种主要方法:

配置注释 - 使用JavaScript注释将配置信息直接嵌入到文件中。
配置文件 - 使用JavaScript,JSON或YAML文件指定整个目录(主目录除外)及其所有子目录的配置信息。


配置文件格式

ESLint支持多种格式的配置文件:
JavaScript - 使用.eslintrc.js和导出包含您的配置的对象。
YAML - 使用.eslintrc.yaml或.eslintrc.yml定义配置结构。
JSON - 用于.eslintrc.json定义配置结构。ESLint的JSON文件也允许JavaScript样式的注释。
不推荐使用 - 使用.eslintrc,可以是JSON或YAML。
package.json - eslintConfig在您的package.json文件中创建一个属性并在那里定义您的配置。

如果同一目录中有多个配置文件,则ESLint将只使用一个。优先顺序是:
1.eslintrc.js
2.eslintrc.yaml
3.eslintrc.yml
4.eslintrc.json
5.eslintrc
6.package.json


配置级联和层次结构

假设您具有以下结构:

your-project
├── .eslintrc
├── lib
│ └── source.js
└─┬ tests
  ├── .eslintrc
  └── test.js

配置级联的工作方式是使用最接近.eslintrc文件的文件作为最高优先级,然后使用父目录中的任何配置文件,依此类推。
1⃣️lib/所有文件,将使用.eslintrc项目根目录中的文件作为其配置
2⃣️tests/目录,.eslintrc其目录层次结构中的两个文件的组合来绘制,其中最接近的文件具有优先权。
通过这种方式,您可以拥有项目级ESLint设置,并且还具有特定于目录的覆盖。

假设您具有以下结构:

your-project
├── package.json
├── lib
│ └── source.js
└─┬ tests
  ├── .eslintrc
  └── test.js

如果在同一目录中找到了一个.eslintrc和一个package.json文件,.eslintrc将优先使用,并且package.json不会使用该文件。

假设您具有以下结构:

home
└── user
    ├── .eslintrc <- Always skipped if other configs present
    └── projectA
        ├── .eslintrc  <- Not used
        └── lib
            ├── .eslintrc  <- { "root": true }
            └── main.js

默认情况下,ESLint将在根目录下的所有父文件夹中查找配置文件。
要将ESLint限制为特定项目,请将其"root": true放在文件eslintConfig字段内package.json或.eslintrc.*项目根级别的文件中。一旦找到配置,ESLint将停止查找父文件夹"root": true。


项目中常用的配置

下面这些rules是用来设置从插件来的规范代码的规则,使用必须去掉前缀eslint-plugin-主要有如下的设置规则,可以设置字符串也可以设置数字,两者效果一致
"off" -> 0 关闭规则
"warn" -> 1 开启警告规则
"error" -> 2 开启错误规则

// http://eslint.org/docs/user-guide/configuring

module.exports = {
  //此项是用来告诉eslint找当前配置文件不能往父级查找
  root: true,

 //此项是用来指定eslint解析器的,解析器必须符合规则,babel-eslint解析器是对babel解析器的包装使其与ESLint解析
  parser: 'babel-eslint',

 //此项是用来指定javaScript语言类型和风格,sourceType用来指定js导入的方式,默认是script,此处设置为module,指某块导入方式
  parserOptions: {

// 设置 script(默认) 或 module,如果代码是在ECMASCRIPT中的模块
    sourceType: 'module',
    "ecmaVersion": 6,
  },

// 此项指定环境的全局变量,下面的配置指定为浏览器环境
  env: {
    browser: true,
  },

// 此项是用来配置标准的js风格,就是说写代码的时候要规范的写,如果你使用vs-code我觉得应该可以避免出错
  extends: 'airbnb-base',

// 此项是用来提供插件的,插件名称省略了eslint-plugin-,下面这个配置是用来规范html的
  // required to lint *.vue files
  plugins: [
    'html'
  ],

  // check if imports actually resolve
  'settings': {
    'import/resolver': {
      'webpack': {
        'config': 'build/webpack.base.conf.js'
      }
    }
  },

  // add your custom rules here
  'rules': {
    // don't require .vue extension when importing
    'import/extensions': ['error', 'always', {  // 对文件扩展名的验证
      'js': 'never',
      'vue': 'never'
    }],
    // allow optionalDependencies
    'import/no-extraneous-dependencies': ['error', {
      'optionalDependencies': ['test/unit/index.js']
    }],
    'no-unused-expressions': ["error", {   // 禁止无用的表达式
      "allowTernary": true,
      "allowShortCircuit": true
    }],
    'no-bitwise': ["error", {   //不允许使用位运算符
      "allow": ["~"]
    }],
    'import/prefer-default-export': 0,// 关闭-使用default export
    'import/newline-after-import': 0, // 关闭-在import中新起一行
    'no-param-reassign': 0,  //关闭-不允许重新分配函数参数"no-proto
    'no-plusplus': 0,  //关闭-不允许使用++ --运算符
    'linebreak-style': 0,
    'max-len': 0,  //关闭-一行最大长度,单位为字符
    'no-nested-ternary': 0,  //关闭-不允许使用嵌套的三目运算符
    'camelcase': 0,  // 不强制驼峰命名规则
    // allow debugger & console during development
    'no-debugger': process.env.NODE_ENV === 'production' ? 2 : 0,
    'no-console': process.env.NODE_ENV === 'production' ? 2 : 0
  }
}
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 151,511评论 1 330
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 64,495评论 1 273
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 101,595评论 0 225
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 42,558评论 0 190
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 50,715评论 3 270
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 39,672评论 1 192
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,112评论 2 291
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 29,837评论 0 181
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 33,417评论 0 228
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 29,928评论 2 232
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,316评论 1 242
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 27,773评论 2 234
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,253评论 3 220
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,827评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,440评论 0 180
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 34,523评论 2 249
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 34,583评论 2 249

推荐阅读更多精彩内容

  • ESLint 配置 ESlint 被设计为完全可配置的,这意味着你可以关闭每一个规则而只运行基本语法验证,或混合和...
    静默虚空阅读 40,964评论 3 14
  • 一、JSLint JSHint ESLint 参考前端工具考 - ESLint 篇JS Linter 进化史 C ...
    合肥黑阅读 76,396评论 0 47
  • ESlint 被设计为完全可配置的,这意味着你可以关闭每一个规则而只运行基本语法验证,或混合和匹配 ESLint ...
    Maco_wang阅读 758评论 0 1
  • EsLint入门学习整理 这两天因为公司要求,就对ESLint进行了初步的了解,网上的内容基本上都差不多,但是内容...
    点柈阅读 25,962评论 3 42
  • 01 “我们单位好几个90后小伙子都秃顶了。” “还有个小伙子不但秃顶,而且还得了前列腺炎。” “以前基本上不要女...
    我是姜燕妮阅读 14,707评论 61 156