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

by admin on 2018年10月5日

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)。

相关文章

发表评论

电子邮件地址不会被公开。 必填项已用*标注

网站地图xml地图