ESLint是1个用来识别和报告ECMAScript/JavaScript中代码格式的工具,目标是使代码风格越来越统一和幸免不当。

ESLint最初是由尼古拉斯 C. 扎卡s
于2013年4月创制的开源项目。它的对象是提供一个插件化的javascript代码检测工具。相比较于jshint显然的性状就是永葆插件举行还有就是帮衬jsx语法(jshint并不辅助jsx,react开发老报错也是很高烧ㄟ(
▔, ▔ )ㄏ )。

1.装置和行使
有两种艺术去安装ESLint:全局和地面。

命令行

实际的可以参见那里
传送门
大概 eslint -h, 那里给出多少个常用的。

1.1本地安装和行使
若是要将ESLint作为项目营造系统的一片段,那么采用在该地开展设置。
您可以利用npm:

安装

运用npm安装,没有npm的点那里https://www.npmjs.com/

npm i -g eslint
npm install eslint --save-dev

转移配置

eslint --init
//回答问题后生成eslint配置。

下一场你须求树立三个布局文件:

运行eslint

eslint [options] [file|dir|glob]*

//eslint file1.js file2.js
//eslint lib/**
//eslint "lib/**" glob模式要用引号
./node_modules/.bin/eslint --init

eslint配置

配置有那二种方法:

  • 直接在代码文件中定义,使用 JavaScript
    注释把布署消息平昔嵌入到七个文本。
  • 使用 .eslintrc (json或者YAML)或者 .eslintrc.yml(YAML)或者
    .eslintrc.js(javascript)或者 .eslintrc.json (JSON);
  • 在 package.json 中添加 eslintConfig 字段;

和jshint一样有个忽略检测文件的配置.eslintignore。
eslintrc执行时会从检测的文本一学富五车往上找配置文件,可是离检测文件如今的文件优先级最高,会覆盖父级的布置。所以一般会在根目录的安排中加一个:

# YAML
root: true

ESLint 一旦发觉配置文件中有 “root”: true,它就会甘休在父级目录中寻找。
即使项目内没有布置文件,会倒退到系统 ~/.eslintrc 中自定义的暗中同意配置。

有很多音信方可被陈设:

  • Environments –
    内定脚本的运维条件。每一个环境都有一组特定的预约义全局变量。
  • Globals – 脚本在实践期间做客的附加的全局变量。
  • Rules – 启用的条条框框及分级的荒谬级别。

贰个简短的例证(.eslintrc.yml):

# YAML 
env:
  browser: true
parserOptions: 
  ecmaVersion: 6
  ecmaFeatures:
    jsx: true
globals :
   angular: true 
rules:
  camelcase: 0
  curly: 2
  brace-style: 
    - 2 
    - 1tbs
  quotes: 
    - 2 
    - single
  semi: 
    - 2 
    - always
  space-in-brackets:
    - 2 
    - never
  space-infix-ops: 2

继之,你可以在你的项目根目录运转ESLint:

1.parserOptions 解析器摘取

#YAML
parserOptions: 
  ecmaVersion: 6
  ecmaFeatures:
    jsx: true

parserOptions 属性设置解析器选项。可用的选项有:

  • ecmaVersion – 设置为 3, 5 (默许), 陆 、7 或 8 内定你想要使用的
    ECMAScript 版本。你也得以钦定为 二零一四(同 6),二〇一五(同 7),或
    2017(同 8)使用年份命名
  • sourceType – 设置为 “script” (暗中认同) 或 “module”(借使你的代码是
    ECMAScript 模块)。
  • ecmaFeatures – 那是个目标,表示您想采用的额外的语言特征:
    • globalReturn – 允许在全局意义域下使用 return 语句
    • impliedStrict – 启用全局 strict mode (如若 ecmaVersion 是 5
      或更高)
    • jsx – 启用 JSX
    • experimentalObjectRestSpread – 启用对实验性的 object rest/spread
      properties
      的支撑。(主要:那是贰个试验性的效益,在今后大概会变动肯定。
      提议您写的平整
      不要借助该成效,除非当它发生转移时您愿意承担维护资金。)
./node_modules/.bin/eslint yourfile.js

2.env 环境全局变量

# YAML
env:
  browser: true

条件定义了预约义的全局变量。可用的条件有:

  • browser – browser 全局变量。
  • node – Node.js 全局变量和 Node.js 成效域。
  • commonjs – CommonJS 全局变量和 CommonJS 成效域 (仅为利用
    Browserify/WebPack 写的只帮忙浏览器的代码)。
  • shared-node-browser – Node 和 Browser 通用全局变量。
  • es6 – 援助除模块外全体 ECMAScript 6 个性(该选项会自动安装
    ecmaVersion 解析器选项为 6)。
  • worker – web workers 全局变量。
  • amd – 定义 require() 和 define() 作为像 amd 一样的全局变量。
  • mocha – 添加全体的 Mocha 测试全局变量。
  • jasmine – 添加全数的 Jasmine 版本 1.3 和 2.0 的测试全局变量。
  • jest – Jest 全局变量。
  • phantomjs – PhantomJS 全局变量。
  • protractor – Protractor 全局变量。
  • qunit – QUnit 全局变量。
  • jquery – jQuery 全局变量。
  • prototypejs – Prototype.js 全局变量。
  • shelljs – ShellJS 全局变量。
  • meteor – Meteor 全局变量。
  • mongo – MongoDB 全局变量。
  • applescript – AppleScript 全局变量。
  • nashorn – Java 8 Nashorn 全局变量。
  • serviceworker – Service Worker 全局变量。
  • atomtest – Atom 测试全局变量。
  • embertest – Ember 测试全局变量。
  • webextensions – WebExtensions 全局变量。
  • greasemonkey – GreaseMonkey 全局变量。

您使用的其余插件或可共享配置也非得在当地安装,以此与地方安装的ESLint合营使用。

3.globals全局变量

# YAML
globals :
   angular: true 
   var1: true
   var2: false

当访问未定义的变量时,no-undef
规则将爆发警告。假使你想在多少个文本里拔取全局变量,推荐您定义那一个全局变量,那样
ESLint 就不会生出警示了。你可以动用注释或在布署文件中定义全局变量。

1.2大局安装和利用
比方要使ESLint能够行使你的有着品类,那么采用在全局安装ESLint。
你可以动用npm:

4.plugins 插件

ESLint 接济接纳第叁方插件。在利用插件以前,你不只怕不拔取 npm 安装它。
在布局文件里安插插件,要选用 plugins
,其中含有插件名字的列表。插件名称可以大致 eslint-plugin- 前缀。

# YAML
plugins:
    - plugin1
    - eslint-plugin-plugin2

瞩目:全局安装的 ESLint 只可以动用全局安装的插件。本地安装的 ESLint
不仅能够采纳当地安装的插件还能使用全局安装的插件。

npm install -g eslint

5.Rules 规则

plugins:
  - plugin1
rules:
  curly: 2
  brace-style: 
    - 2 
    - 1tbs
  quotes: 
    - 2 
    - single
  plugin1/rule1 : error
  #配置定义在插件中的一个规则的时候,你必须使用 插件名/规则ID 的形式

ESLint
附带有多量的规则。你可以行使注释或配备文件修改你项目中要接Nash么规则。改变一个条条框框设置,你必须安装规则
ID 等于那个值之一:

  • “off” 或 0 – 关闭规则
  • 爱博体育,”warn” 或 1 – 开启规则,使用警告级其他失实:warn (不会招致程序退出)
  • “error” 或 2 – 开启规则,使用不当级其他一无所能:error
    (当被触发的时候,程序会脱离)

现实的规则太多了这一看那里 :
传送门

下一场您必要建立壹个配备文件:

6.共享安装

# YAML
settings:
    sharedData: "Hello"

ESLint 援救在配备文件添加共享设置。你可以增进 settings
对象到布署文件,它将提须求每三个将被实施的平整。假设你想添加的自定义规则而且使它们得以访问到同一的音信,这将会很有用,并且很不难配置。

eslint --init

*行内配置

进而,你可以在您的花色根目录运维ESLint:

禁止eslint检测

//1.禁止规则出现警告
/* eslint-disable */
alert('foo');
/* eslint-enable */

//.2或者对指定的规则启用或禁用警告
/* eslint-disable no-alert, no-console */
alert('foo');
console.log('bar');
/* eslint-enable no-alert, no-console */

//3.整个文件范围内禁止规则出现警告,将 /* eslint-disable */ 块注释放在文件顶部

//4.你也可以对整个文件启用或禁用警告:
/* eslint-disable no-alert */
// Disables no-alert for the rest of the file

//5.单行注释
alert('foo'); // eslint-disable-line
// eslint-disable-next-line
alert('foo');
eslint yourfile.js

*陈设文件的继续

一个布置文件能够被基础配置中的已启用的规则接轨

你使用的其余插件或可共享配置也非得在全局安装,以此与全局安装的ESLint合作使用。

1 eslint:recommended

值为 “eslint:recommended” 的 extends
属性启用一文山会海基本规则,那一个规则报告一些周边难点,在 规则页面 中被标记为
。这些推荐的子集只幸亏 ESLint 主要版本举行立异。

# YAML
extends: eslint:recommended,
rules : 
  #enable additional rules
  indent: 
    - error
    - 4

 

2 extend npm包

接轨的可以是三个 npm 包,它输出一个安顿对象。要保证这几个包安装在 ESLint
能请求到的目录下。extends 属性值可以简简单单包名的前缀 eslint-config-。

# YAML
extends: standard
rules:
  comma-dangle:
    - error
    - always
  no-empty: warn

2.配置
在运作eslint
–init之后,会在您的目录建立壹个.eslintrc文件。在中间你将看到有个别之类的布局规则:

3 plugins npm包

一些插件也足以出口一个或多个命名的 配置。要力保那一个包安装在 ESLint
能请求到的目录下。plugins 属性值 能够大致包名的前缀 eslint-plugin-。
extends 属性值可以由以下组成:

  • plugin:
  • 包名 (省略了前缀,比如,react)
  • /
  • 配备名称 (比如 recommended)

# JSON
{
    "plugins": [
        "react"
    ],
    "extends": [
        "eslint:recommended",
        "plugin:react/recommended"
    ],
    "rules": {
       "no-set-state": "off"
    }
}
{
  "rules": {
    "semi": ["error", "always"],
    "quotes": ["error", "double"]
  }
}

4 继承配置文件

extends 属性值可以是大旨配置文件的相对路径或相对路径。

{
    "extends": [
        "./node_modules/coding-standard/eslintDefaults.js",
        "./node_modules/coding-standard/.eslintrc-es6",
        "./node_modules/coding-standard/.eslintrc-jsx"
    ],
    "rules": {
        "eqeqeq": "warn"
    }
}

参考
http://eslint.cn/
http://eslint.org/docs
https://csspod.com/getting-started-with-eslint/

“semi”和“quotes”是ESLint中规则的名目。
第两个值是平整的荒谬级别,可以是以下值之一:

  • “off” 或 0 – 关闭规则
  • “warn” 或 1 – 将规则作为警示
  • “error” 或 2 – 将规则作为不当

那两个谬误级别允许你细微地控制ESLint怎么样行使规则。

你的.eslintrc配置文件将同样包涵该行:

"extends": "eslint:recommended"

是因为这一行,规则页面上标记为“”的有所规则都将被打开。

ESLint被设计为可完全配置的,配置ESLint有二种重点的不二法门:

  1. 注脚配置 – 使用JavaScript注释将陈设消息直接嵌入文件。
  2. 布局文件 –
    使用JavaScript,JSON或YAML文件来钦定整个目录及其所有子目录的配置音信。

那足以是格式为.eslintrc.*文件或package.json中的eslintConfig域,那八个ESLint都将活动寻找和读取,也可以在命令行中钦虞升卿插文件。

有多少个可布置的音信:

  • Environment –
    您的脚本被规划在所运维的条件。每种环境都含有一组预订义的全局变量。
  • Globals – 您的本子在执行时期做客的别样全局变量。
  • Rules – 启用的规则和错误的级别。

越多配备选项和细节,看法定配置文档http://eslint.org/docs/user-guide/configuring)。