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

命令行

切实的可参见这里
传送门
或者 eslint -h, 这里让起几乎单常因此的。

眼看三独错级别允许而细微地控制ESLint如何使规则。

运行eslint

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

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

1.装与使用
发有限栽艺术去安装ESLint:全局与当地。

安装

使npm安装,没有npm的接触这里https://www.npmjs.com/

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

2 extend npm包

继承的得是一个 npm 包,它输出一个布置对象。要力保这包安装于 ESLint
能请求到的目录下。extends 属性值可以简简单单包名的前缀 eslint-config-。

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

君运的别插件或只是共享配置为亟须在地头安装,以此与本土安装的ESLint配合以。

*行内配置

随即,你可以在您的类型根本目录运行ESLint:

1 eslint:recommended

值为 “eslint:recommended” 的 extends
属性启用一文山会海基本规则,这些规则报告有普遍问题,在 规则页面 中叫记为
。这个推荐的子集只能当 ESLint 主要版本进行创新。

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

由于当下同样推行,规则页面上记为“”的所有条条框框都将于辟。

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/

随即好是格式为.eslintrc.*文件或者package.json中之eslintConfig域,这片个ESLint都以机关寻找和读取,也得以于指令行中指定安排文件。

6.共享装

# YAML
settings:
    sharedData: "Hello"

ESLint 支持以部署文件添加共享设置。你得添加 settings
对象及布置文件,它将提供被各一个用被实施的平整。如果你想添加的自定义规则以只要它可以拜到同样之音讯,这将会充分有因此,并且大轻配置。

  1. 注解配置 – 使用JavaScript注释将安排信息一直坐文件。
  2. 配置文件 –
    使用JavaScript,JSON或YAML文件来指定整个目录及其所有子目录的安排信息。

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"
    }
}

接下来您得树立一个安排文件:

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 yourfile.js

ESLint最初是出于Nicholas C. Zakas
于2013年6月创设的开源项目。它的靶子是供一个插件化的javascript代码检测工具。对比于jshint显著的特征就是支撑插件进行还有即使是永葆jsx语法(jshint并无支持jsx,react开发镇报错也是老大头疼ㄟ(
▔, ▔ )ㄏ )。

eslint --init

*布文件的继续

一个布局文件可以叫基础配置中的已启用的规则接轨

ESLint给设计也罢而净配置的,配置ESLint有个别种植关键的方:

1.parserOptions 解析器选择

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

parserOptions 属性设置解析器选项。可用之取舍项有:

  • ecmaVersion – 设置也 3, 5 (默认), 6、7 或 8 指定你想要动的
    ECMAScript 版本。你为可指定为 2015(同 6),2016(同 7),或
    2017(同 8)使用载命名
  • sourceType – 设置也 “script” (默认) 或 “module”(如果您的代码是
    ECMAScript 模块)。
  • ecmaFeatures – 这是个对象,表示你想使的额外的言语特色:
    • globalReturn – 允许在全局意图域下使用 return 语句子
    • impliedStrict – 启用全局 strict mode (如果 ecmaVersion 是 5
      或更胜)
    • jsx – 启用 JSX
    • experimentalObjectRestSpread – 启用对实验性的 object rest/spread
      properties
      的支持。(重要:这是一个实验性的功效,在未来恐会见改变肯定。
      建议乃勾勒的规则
      不要因该意义,除非当她发生反时若愿意当维护成本。)

君的.eslintrc配置文件将一如既往带有该行:

3.globals全局变量

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

当访问未定义之变量时,no-undef
规则拿发出警告。如果您想以一个文件里使用全局变量,推荐您定义这些全局变量,这样
ESLint 就无见面出警示了。你可以采用注释或在安排文件被定义全局变量。

"extends": "eslint:recommended"

转变配置

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

有几乎单可配置的信息:

5.Rules 规则

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

ESLint
附带有大量的规则。你得应用注释或布文件修改你色中只要运用什么规则。改变一个平整设置,你必须装规则
ID 等于这些值之一:

  • “off” 或 0 – 关闭规则
  • “warn” 或 1 – 爱博体育开启规则,使用警告级别的谬误:warn (不会见招程序退出)
  • “error” 或 2 – 开启规则,使用不当级别之错:error
    (当让点的时刻,程序会离)

切切实实的平整太多了当下同一看押这里 :
传送门

若使用的任何插件或可共享配置为非得在大局安装,以此与大局安装的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');
npm install -g eslint

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
  • Environment –
    您的本子被设计于所运行的环境。每个环境都蕴含一组预定义的全局变量。
  • Globals – 您的本子在尽中走访的旁全局变量。
  • Rules – 启用的平整与错误的级别。

4.plugins 插件

ESLint 支持用第三着插件。在运插件之前,你必运用 npm 安装她。
在布局文件里安排插件,要动 plugins
,其中包含插件名字的列表。插件名称可以简简单单 eslint-plugin- 前缀。

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

留神:全局安装之 ESLint 只能使全局安装的插件。本地安装之 ESLint
不仅可以运用当地安装的插件还可以行使全局安装的插件。

再次多安排选和细节,看法定配置文档(http://eslint.org/docs/user-guide/configuring)。

./node_modules/.bin/eslint yourfile.js
{
  "rules": {
    "semi": ["error", "always"],
    "quotes": ["error", "double"]
  }
}

 

随着,你得当公的档次根本目录运行ESLint:

npm install eslint --save-dev
./node_modules/.bin/eslint --init

下一场你需树立一个布局文件:

“semi”和“quotes”是ESLint中规则的名号。
第一只价是规则的一无是处级别,可以是盖下值之一:

1.2大局安装和以
若果一旦而ESLint可以下你的有着项目,那么选择在全局安装ESLint。
你得应用npm:

1.1本土安装及利用
设若一旦以ESLint作为项目构建系统的同一有些,那么选择当地方开展设置。
您得用npm:

2.配置
以运转eslint
–init之后,会当您的目录建立一个.eslintrc文本。在其间你将视部分之类的配置规则: