EsLint

       EsLint帮助我们检查javascript编程时的语法错误。比如：在JavaScript应用中，很难找到泄露的变量或者方法。EsLint能够帮助我们分析JS代码，找到bug并确保一定程度的JS语法书写的正确性。

　　EsLint是建立在ECMAScript解析架构的基础上的。EsLint不但提供一些默认的规则，也提供用户自定义规则来约束我们写的JavaScript代码。

　　EsLint提供以下支持：①.ES6 ②.AngularJS ③JSX ④Style检查⑤自定义错误和提示

　　EsLint提供以下几种校验：①.语法错误校验 ②.不重要或丢失的标点符号，如分号③.没法运行到的代码块④.未被使用的参数提醒⑤.漏掉的结束符，如}⑥.确保样式的统一规则，如sass或者less⑦.检查变量的命名

一、安装

npm install gulp-eslint –save-dev

在你的项目目录下，运行：eslint –init将会产生一个.eslintrc的文件，文件内容包含一些校验规则

{

    "rules": {

        "semi": ["error", "always"],

        "quotes": ["error", "double"]

    }

}

其中”semi”和”quotes”是规则名称。EsLint还提供了error的级别，对应数字，数字越高错误的提示越高，如0代码错误不提示、1代表警告提醒但不影响现有编译、2error会抛出错误。

"extends": "eslint:recommended"

Extends是EsLint默认推荐的验证，你可以使用配置选择哪些校验是你所需要的，可以登录npmjs.com查看

二、自定义配置EsLint

之前提到你可以关掉所有EsLint默认的验证，自行添加所确切需要的验证规则。为此EsLint提供了2个种方式进行设置：

1. Configuration Comments: 在所要验证的文件中，直接使用Javascript注释嵌套配置信息
2. Configuration Files: 使用JavaScript、JSON或YAML文件，比如前面提到的.eslintrc文件，当然你也可以在package.json文件里添加eslintConfig字段，EsLint都会自动读取验证。

开始介绍EsLint的用法

parserOptions

EsLint通过parserOptions，允许指定校验的ecma的版本，及ecma的一些特性

{
    "parserOptions": {
        "ecmaVersion": 6, //指定ECMAScript支持的版本，6为ES6
        "sourceType": "module", //指定来源的类型，有两种”script”或”module”
        "ecmaFeatures": {
            "jsx": true//启动JSX
        },
    }
}

Parser

EsLint默认使用esprima做脚本解析，当然你也切换他，比如切换成babel-eslint解析

{
    "parser": "esprima" //默认，可以设置成babel-eslint，支持jsx
}

Environments

Environment可以预设好的其他环境的全局变量，如brower、node环境变量、es6环境变量、mocha环境变量等

{
    "env": {
        "browser": true,
        "node": true
    }
}

如果你想使用插件中的环境变量，你可以使用plugins指定，如下

{
    "plugins": ["example"],
    "env": {
        "example/custom": true
    }
}

Globals

指定你所要使用的全局变量，true代表允许重写、false代表不允许重写

{
    "globals": {
        "var1": true,
        "var2": false
    }
}

Plugins

EsLint允许使用第三方插件

{
    "plugins": [
        "react"    
     ]
}

Rules

自定义规则，一般格式：”规则名称”:error级别系数。系数0为不提示(off)、1为警告(warn)、2为错误抛出(error)，可指定范围，如[1,4]

可以包括Strict模式、也可以是code的方式提醒，如符号等。还可以是第三方的校验，如react。

默认校验的地址http://eslint.org/docs/rules/

{
    "plugins": [
        "react"
    ],
    "rules": {
         //Javascript code 默认校验
        "eqeqeq": "off", //off = 0
        "curly": "error", //error = 2
        "quotes": ["warn", "double"], //warn = 1
         //使用第三方插件的校验规则
        "react/jsx-quotes": 0
    }
}

            https://www.npmjs.com/package/eslint-plugin-react ， 此链接是react的eslint使用

三、Gulp中使用

var eslint = require('gulp-eslint');
 
gulp.task('validate-eslint',function(){

    return gulp.src(['app/**/*.js']) //指定的校验路径

        .pipe(eslint({configFile:"./.eslintrc"})) //使用你的eslint校验文件

        .pipe(eslint.format())

});

四、规则

1.类别描述 

Possible Errors 可能的错误或逻辑错误 
no-cond-assign 禁止条件表达式中出现模棱两可的赋值操作符 
no-console 禁用console 
no-constant-condition 禁止在条件中使用常量表达式 
no-debugger 禁用 debugger 
no-dupe-args 禁止 function 定义中出现重名参数 
no-dupe-keys 禁止对象字面量中出现重复的 key 
no-duplicate-case 禁止出现重复的 case 标签 
no-empty 禁止出现空语句块 
no-ex-assign 禁止对 catch 子句的参数重新赋值 
no-extra-boolean-cast 禁止不必要的布尔转换 
no-extra-parens 禁止不必要的括号 
no-extra-semi 禁止不必要的分号 
no-func-assign 禁止对 function 声明重新赋值 
no-inner-declarations 禁止在嵌套的块中出现变量声明或 function 声明 
no-irregular-whitespace 禁止在字符串和注释之外不规则的空白 
no-obj-calls 禁止把全局对象作为函数调用 
no-sparse-arrays 禁用稀疏数组 
no-prototype-builtins 禁止直接使用Object.prototypes 的内置属性 
no-unexpected-multiline 禁止出现令人困惑的多行表达式 
no-unreachable 禁止在return、throw、continue 和 break语句之后出现不可达代码 
use-isnan 要求使用 isNaN() 检查 NaN 
valid-typeof 强制 typeof 表达式与有效的字符串进行比较 

2.Best Practices 最佳实践 

array-callback-return 强制数组方法的回调函数中有 return 语句 
block-scoped-var 强制把变量的使用限制在其定义的作用域范围内 
complexity 指定程序中允许的最大环路复杂度 
consistent-return 要求 return 语句要么总是指定返回的值，要么不指定 
curly 强制所有控制语句使用一致的括号风格 
default-case 要求 switch 语句中有 default 分支 
dot-location 强制在点号之前和之后一致的换行 
dot-notation 强制在任何允许的时候使用点号 
eqeqeq 要求使用 === 和 !== 
guard-for-in 要求 for-in 循环中有一个 if 语句 
no-alert 禁用 alert、confirm 和 prompt 
no-case-declarations 不允许在 case 子句中使用词法声明 
no-else-return 禁止 if 语句中有 return 之后有 else 
no-empty-function 禁止出现空函数 
no-eq-null 禁止在没有类型检查操作符的情况下与 null 进行比较 
no-eval 禁用 eval() 
no-extra-bind 禁止不必要的 .bind() 调用 
no-fallthrough 禁止 case 语句落空 
no-floating-decimal 禁止数字字面量中使用前导和末尾小数点 
no-implicit-coercion 禁止使用短符号进行类型转换 
no-implicit-globals 禁止在全局范围内使用 var 和命名的 function 声明 
no-invalid-this: 禁止 this 关键字出现在类和类对象之外 
no-lone-blocks 禁用不必要的嵌套块 
no-loop-func 禁止在循环中出现 function 声明和表达式 
no-magic-numbers 禁用魔术数字 
no-multi-spaces 禁止使用多个空格 
no-multi-str 禁止使用多行字符串 
no-new 禁止在非赋值或条件语句中使用 new 操作符 
no-new-func 禁止对 Function 对象使用 new 操作符 
no-new-wrappers 禁止对 String，Number 和 Boolean 使用 new 操作符 
no-param-reassign 不允许对 function 的参数进行重新赋值 
no-redeclare 禁止使用 var 多次声明同一变量 
no-return-assign 禁止在 return 语句中使用赋值语句 
no-script-url 禁止使用 javascript: url 
no-self-assign 禁止自我赋值 
no-self-compare 禁止自身比较 
no-sequences 禁用逗号操作符 
no-unmodified-loop-condition 禁用一成不变的循环条件 
no-unused-expressions 禁止出现未使用过的表达式 
no-useless-call 禁止不必要的 .call() 和 .apply() 
no-useless-concat 禁止不必要的字符串字面量或模板字面量的连接 
vars-on-top 要求所有的 var 声明出现在它们所在的作用域顶部 

3.Variables 变量声明 

init-declarations 要求或禁止 var 声明中的初始化 
no-catch-shadow 不允许 catch 子句的参数与外层作用域中的变量同名 
no-restricted-globals 禁用特定的全局变量 
no-shadow 禁止 var 声明 与外层作用域的变量同名 
no-undef 禁用未声明的变量，除非它们在 /global / 注释中被提到 
no-undef-init 禁止将变量初始化为 undefined 
no-unused-vars 禁止出现未使用过的变量 
no-use-before-define 不允许在变量定义之前使用它们

4.Nodejs and CommonJS Node.js,CommonJS 

global-require 要求 require() 出现在顶层模块作用域中 
handle-callback-err 要求回调函数中有容错处理 
no-mixed-requires 禁止混合常规 var 声明和 require 调用 
no-new-require 禁止调用 require 时使用 new 操作符 
no-path-concat 禁止对 dirname 和 filename进行字符串连接 
no-restricted-modules 禁用指定的通过 require 加载的模块 

5.Stylistic Issues 风格指南 （使用较多）

array-bracket-spacing 强制数组方括号中使用一致的空格 
block-spacing 强制在单行代码块中使用一致的空格 
brace-style 强制在代码块中使用一致的大括号风格 
camelcase 强制使用骆驼拼写法命名约定 
comma-spacing 强制在逗号前后使用一致的空格 
comma-style 强制使用一致的逗号风格 
computed-property-spacing 强制在计算的属性的方括号中使用一致的空格 
eol-last 强制文件末尾至少保留一行空行 
func-names 强制使用命名的 function 表达式 
func-style 强制一致地使用函数声明或函数表达式 
indent 强制使用一致的缩进 
jsx-quotes 强制在 JSX 属性中一致地使用双引号或单引号 
key-spacing 强制在对象字面量的属性中键和值之间使用一致的间距 
keyword-spacing 强制在关键字前后使用一致的空格 
linebreak-style 强制使用一致的换行风格 
lines-around-comment 要求在注释周围有空行 
max-depth 强制可嵌套的块的最大深度 
max-len 强制一行的最大长度 
max-lines 强制最大行数 
max-nested-callbacks 强制回调函数最大嵌套深度 
max-params 强制 function 定义中最多允许的参数数量 
max-statements 强制 function 块最多允许的的语句数量 
max-statements-per-line 强制每一行中所允许的最大语句数量 
new-cap 要求构造函数首字母大写 
new-parens 要求调用无参构造函数时有圆括号 
newline-after-var 要求或禁止 var 声明语句后有一行空行 
newline-before-return 要求 return 语句之前有一空行 
newline-per-chained-call 要求方法链中每个调用都有一个换行符 
no-array-constructor 禁止使用 Array 构造函数 
no-continue 禁用 continue 语句 
no-inline-comments 禁止在代码行后使用内联注释 
no-lonely-if 禁止 if 作为唯一的语句出现在 else 语句中 
no-mixed-spaces-and-tabs 不允许空格和 tab 混合缩进 
no-multiple-empty-lines 不允许多个空行 
no-negated-condition 不允许否定的表达式 
no-plusplus 禁止使用一元操作符 ++ 和 – 
no-spaced-func 禁止 function 标识符和括号之间出现空格 
no-ternary 不允许使用三元操作符 
no-trailing-spaces 禁用行尾空格 
no-whitespace-before-property 禁止属性前有空白 
object-curly-newline 强制花括号内换行符的一致性 
object-curly-spacing 强制在花括号中使用一致的空格 
object-property-newline 强制将对象的属性放在不同的行上 
one-var 强制函数中的变量要么一起声明要么分开声明 
one-var-declaration-per-line 要求或禁止在 var 声明周围换行 
operator-assignment 要求或禁止在可能的情况下要求使用简化的赋值操作符 
operator-linebreak 强制操作符使用一致的换行符 
quote-props 要求对象字面量属性名称用引号括起来 
quotes 强制使用一致的反勾号、双引号或单引号 
require-jsdoc 要求使用 JSDoc 注释 
semi 要求或禁止使用分号而不是 ASI 
semi-spacing 强制分号之前和之后使用一致的空格 
sort-vars 要求同一个声明块中的变量按顺序排列 
space-before-blocks 强制在块之前使用一致的空格 
space-before-function-paren 强制在 function的左括号之前使用一致的空格 
space-in-parens 强制在圆括号内使用一致的空格 
space-infix-ops 要求操作符周围有空格 
space-unary-ops 强制在一元操作符前后使用一致的空格 
spaced-comment 强制在注释中 // 或 /* 使用一致的空格

详见https://www.cnblogs.com/ruanyifeng/p/5283708.html

转载于:https://www.cnblogs.com/alhh/p/7929196.html