ESLint入门。eslint 静态代码检测工具。

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

ESLint最初是出于Nicholas C. Zakas
于2013年6月开立的开源项目。它的对象是供一个插件化的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 (默认), 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
      的支撑。(重要:这是一个试验性的力量,在未来说不定会见转移肯定。
      建议乃写的规则
      不要因该意义,除非当她产生反时若愿意承担维护本。)
./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
附带有大量的规则。你得应用注释或配备文件修改你色中如果采用什么规则。改变一个规则设置,你得设置规则
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)。

相关文章

admin

网站地图xml地图