ESLint - 简介

ESLint是一个用来识别 ECMAScript 并且按照规则给出报告的代码检测工具,使用它可以避免低级错误统一代码的风格。ESLint被设计为完全可配置的,主要有两种方式来配置ESLint:

  • 在注释中配置:使用JavaScript注释直接把配置嵌入到JS文件中。
  • 配置文件:使用下面任一的文件来为全部的目录和它的子目录指定配置信息。
    • javascript:使用.eslintrc.js文件并导出一个包含配置的对象。
    • YAML:.eslintrc.yaml或者.eslintrc.yml
    • JSON:.eslintrc.json,并且此文件允许使用JS形式的注释
    • 废弃的用法:.eslintrc,此文件可以是JSON或者YAML
    • package.json:在package.json文件中创建eslintConfig属性,所有的配置包含在此属性中。

这些文件的优先级则是按照以上出现的顺序(.eslintrc.js>.eslintrc.yaml>.eslintrc.yml>.eslintrc.json>.eslintrc>package.json)。

可以被配置的信息主要分为3类:

  • Environments:你的 javascript 脚本将要运行在什么环境(如:nodejs,browser,commonjs等)中。
  • Globals:执行代码时脚本需要访问的额外全局变量。
  • Rules:开启某些规则,也可以设置规则的等级。

安装

全局安装

npm install -g eslint

局部安装(推荐)

npm install -D eslint

安装完毕后,接下来新建一个配置文件.eslintrc.js,或者使用如下的命令行来自动生成。

eslint --init

配置

指定执行环境

JavaScript 代码可以运行在浏览器或 nodejs 等环境中,每个环境的全局变量都不尽相同(如 nodejs 中没有 DOM 相关的全局变量)。在配置文件中可以自由的指定执行环境。

// .eslintrc.js
module.exports = {
  env: {
    browser: true,
    node: true,
  },
};

所有的环境可以在官网上查询。

指定全局变量

可以在配置文件或注释中指定额外的全局变量,false表明变量只读:

注释:

/* global var1, var2 */
/* global var1:false, var2:false */

js 文件:

// .eslintrc.js
module.exports = {
  globals: {
    var1: true,
    var2: true,
  },
};

规则

在配置文件中可以设置一些规则。

这些规则的等级有三种:

  • "off" 或者 0:关闭规则。
  • "warn" 或者 1:打开规则,并且作为一个警告(不影响exit code)。
  • "error" 或者 2:打开规则,并且作为一个错误(exit code将会是1)。

例如:

  • js 文件
// .eslintrc.js
module.exports = {
  rules: {
    eqeqeq: 'off',
    curly: 'error',
  },
};
    注释文件
/* eslint eqeqeq: "off", curly: "error" */
/* eslint eqeqeq: 0, curly: 2 */

也可以在注释中关闭所有或者某个规则:

/* eslint-disable */
/* eslint-enable */

/* eslint-disable no-alert, no-console */
/* eslint-enable no-alert, no-console */

具体的规则可以在官网上找到,或者使用别人写好的配置,例如eslint-config-airbnb。

使用方法

通过命令行工具来使用 eslint 。

eslint [options] file.js [file.js] [dir]

除了使用命令行还可以配合 webpack 或者配合编辑器的插件(如vscode-eslint)来使用。

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

EsLint是建立在Esprima(ECMAScript解析架构)的基础上的。Esprima支持ES5.1,本身也是用ECMAScript编写的,用于多用途分析。EsLint不但提供一些默认的规则(可扩展),也提供用户自定义规则来约束我们写的Javascript代码。

EsLint提供以下支持:

  1. ES6
  2. AngularJS
  3. JSX
  4. Style检查
  5. 自定义错误和提示

EsLint提供以下几种校验:

  1. 语法错误校验
  2. 不重要或丢失的标点符号,如分号
  3. 没法运行到的代码块(使用过WebStorm的童鞋应该了解)
  4. 未被使用的参数提醒
  5. 漏掉的结束符,如}
  6. 确保样式的统一规则,如sass或者less
  7. 检查变量的命名

使用

一、安装

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({configFle:"./.eslintrc"})) //使用你的eslint校验文件

        .pipe(eslint.format())

});

下面讲解vue-cli脚手架根目录文件.eslintrc.js

eslint简介

eslint是用来管理和检测js代码风格的工具,可以和编辑器搭配使用,如vscode的eslint插件
当有不符合配置文件内容的代码出现就会报错或者警告

安装eslint

npm init -y
npm install eslint --save-dev
node_modules\.bin\eslint --init 初始化配置文件,此配置文件配置好之后,vscode编辑器自动识别

vue-cli的.eslintrc.js配置文件的解释

// http://eslint.org/docs/user-guide/configuring

module.exports = {
    //此项是用来告诉eslint找当前配置文件不能往父级查找
    root: true, 
    //此项是用来指定eslint解析器的,解析器必须符合规则,babel-eslint解析器是对babel解析器的包装使其与ESLint解析
    parser: 'babel-eslint',
    //此项是用来指定javaScript语言类型和风格,sourceType用来指定js导入的方式,默认是script,此处设置为module,指某块导入方式
    parserOptions: {
        sourceType: 'module'
    },
    //此项指定环境的全局变量,下面的配置指定为浏览器环境
    env: {
        browser: true,
    },
    // https://github.com/feross/standard/blob/master/RULES.md#javascript-standard-style
    // 此项是用来配置标准的js风格,就是说写代码的时候要规范的写,如果你使用vs-code我觉得应该可以避免出错
    extends: 'standard',
    // required to lint *.vue files
    // 此项是用来提供插件的,插件名称省略了eslint-plugin-,下面这个配置是用来规范html的
    plugins: [
        'html'
    ],
    // add your custom rules here
    // 下面这些rules是用来设置从插件来的规范代码的规则,使用必须去掉前缀eslint-plugin-
    // 主要有如下的设置规则,可以设置字符串也可以设置数字,两者效果一致
    // "off" -> 0 关闭规则
    // "warn" -> 1 开启警告规则
    //"error" -> 2 开启错误规则
    // 了解了上面这些,下面这些代码相信也看的明白了
    'rules': {
        // allow paren-less arrow functions
        'arrow-parens': 0,
        // allow async-await
        'generator-star-spacing': 0,
        // allow debugger during development
        'no-debugger': process.env.NODE_ENV === 'production' ? 2 : 0
    }
}

ESLint是完全可配置的,意味着可以关闭所有规则只保留语法验证,或者混合匹配捆绑规则和自定义规则。配置ESLint有两种方式:

  • 配置注释 - 用JavaScript的注释在文件中直接嵌入配置信息。
  • 配置文件 - 用JavaScript、JSON、YAML文件来配置整个工程。
    可以配置的参数包括:

  • Environments - 脚本执行的环境。不同的执行环境有不同的预定义全局变量。

  • Globals - 其他的脚本执行需要的全局变量。

  • Rules - 不同错误级别的规则。

配置parserOptions参数

ESLint默认支持ECMAScript5的语法规则。也可通过参数覆盖到ECMAScript6,JSX同样。
.eslintrc.* 中parserOptions其中可配置的参数包括:

  • ecmaVersion - ECMAScript的版本,3、5(默认)、6
  • sourceType -
  • ecmaFeatures - 表示一些附加特性的对象:

    • globalReturn - 在全局作用域允许return 语句
    • impliedStrict - strict模式(ecma版本大于等于5)
    • jsx - 支持jsx
    • experimentalObjectRestSpread - .ealintrc.json文件示例:
    { 
       "parserOptions":  {
         "ecmaVersion": 6,
         "sourceType": "module", 
         "ecmaFeatures": {
           "jsx": true
           },
       }, 
      "rules": { 
        "semi": 2 
      }
    }
    

    parserOptions的配置决定ESLint认为哪些是错误。默认规则都是false

配置具体规则

ESLint默认使用Espree 。同时满足以下要求的自定义解析规则也可定义:

  • 必须是本地的npm module
  • 必须是有 Esprima-compatible 的接口(parse()方法)
  • 必须生成一个 Esprima-compatible AST and token objects

ESLint配置参数介绍

ESLint 由 JavaScript 红宝书 作者 Nicholas C. Zakas 编写, 2013 年发布第一个版本。 NCZ 的初衷不是重复造一个轮子,而是在实际需求得不到 JSHint 团队响应 的情况下做出的选择:以可扩展、每条规则独立、不内置编码风格为理念编写一个 lint 工具。

ESLint 主要有以下特点:
默认规则包含所有 JSLint、JSHint 中存在的规则,易迁移;
规则可配置性高:可设置「警告」、「错误」两个 error 等级,或者直接禁用;
包含代码风格检测的规则(可以丢掉 JSCS 了);
支持插件扩展、自定义规则。

配置
可以通过以下三种方式配置 ESLint:
使用 .eslintrc 文件(支持 JSON 和 YAML 两种语法);
在 package.json 中添加 eslintConfig 配置块;
直接在代码文件中定义。

以下是.eslintrc 文件示例和解释:

{  
  "env": {  
    "browser": true,  
    "node": true,  
    "commonjs": true  
  },  
  "ecmaFeatures": {  
    // lambda表达式  
    "arrowFunctions": true,  
    // 解构赋值  
    "destructuring": true,  
    // class  
    "classes": true,  
    // http://es6.ruanyifeng.com/#docs/function#函数参数的默认值  
    "defaultParams": true,  
    // 块级作用域,允许使用let const  
    "blockBindings": true,  
    // 允许使用模块,模块内默认严格模式  
    "modules": true,  
    // 允许字面量定义对象时,用表达式做属性名  
    // http://es6.ruanyifeng.com/#docs/object#属性名表达式  
    "objectLiteralComputedProperties": true,  
    // 允许对象字面量方法名简写  
    /*var o = { 
        method() { 
          return "Hello!"; 
        } 
     }; 

     等同于 

     var o = { 
       method: function() { 
         return "Hello!"; 
       } 
     }; 
    */  
    "objectLiteralShorthandMethods": true,  
    /* 
      对象字面量属性名简写 
      var foo = 'bar'; 
      var baz = {foo}; 
      baz // {foo: "bar"} 

      // 等同于 
      var baz = {foo: foo}; 
    */  
    "objectLiteralShorthandProperties": true,  
    // http://es6.ruanyifeng.com/#docs/function#rest参数  
    "restParams": true,  
    // http://es6.ruanyifeng.com/#docs/function#扩展运算符  
    "spread": true,  
    // http://es6.ruanyifeng.com/#docs/iterator#for---of循环  
    "forOf": true,  
    // http://es6.ruanyifeng.com/#docs/generator  
    "generators": true,  
    // http://es6.ruanyifeng.com/#docs/string#模板字符串  
    "templateStrings": true,  
    "superInFunctions": true,  
    // http://es6.ruanyifeng.com/#docs/object#对象的扩展运算符  
    "experimentalObjectRestSpread": true  
  },  

  "rules": {  
    // 定义对象的set存取器属性时,强制定义get  
    "accessor-pairs": 2,  
    // 指定数组的元素之间要以空格隔开(,后面), never参数:[ 之前和 ] 之后不能带空格,always参数:[ 之前和 ] 之后必须带空格  
    "array-bracket-spacing": [2, "never"],  
    // 在块级作用域外访问块内定义的变量是否报错提示  
    "block-scoped-var": 0,  
    // if while function 后面的{必须与if在同一行,java风格。  
    "brace-style": [2, "1tbs", { "allowSingleLine": true }],  
    // 双峰驼命名格式  
    "camelcase": 2,  
    // 数组和对象键值对最后一个逗号, never参数:不能带末尾的逗号, always参数:必须带末尾的逗号,  
    // always-multiline:多行模式必须带逗号,单行模式不能带逗号  
    "comma-dangle": [2, "never"],  
    // 控制逗号前后的空格  
    "comma-spacing": [2, { "before": false, "after": true }],  
    // 控制逗号在行尾出现还是在行首出现  
    // http://eslint.org/docs/rules/comma-style  
    "comma-style": [2, "last"],  
    // 圈复杂度  
    "complexity": [2,9],  
    // 以方括号取对象属性时,[ 后面和 ] 前面是否需要空格, 可选参数 never, always  
    "computed-property-spacing": [2,"never"],  
    // 强制方法必须返回值,TypeScript强类型,不配置  
    "consistent-return": 0,  
    // 用于指统一在回调函数中指向this的变量名,箭头函数中的this已经可以指向外层调用者,应该没卵用了  
    // e.g [0,"that"] 指定只能 var that = this. that不能指向其他任何值,this也不能赋值给that以外的其他值  
    "consistent-this": 0,  
    // 强制在子类构造函数中用super()调用父类构造函数,TypeScrip的编译器也会提示  
    "constructor-super": 0,  
    // if else while for do后面的代码块是否需要{ }包围,参数:  
    //    multi  只有块中有多行语句时才需要{ }包围  
    //    multi-line  只有块中有多行语句时才需要{ }包围, 但是块中的执行语句只有一行时,  
    //                   块中的语句只能跟和if语句在同一行。if (foo) foo++; else doSomething();  
    //    multi-or-nest 只有块中有多行语句时才需要{ }包围, 如果块中的执行语句只有一行,执行语句可以零另起一行也可以跟在if语句后面  
    //    [2, "multi", "consistent"] 保持前后语句的{ }一致  
    //    default: [2, "all"] 全都需要{ }包围  
    "curly": [2, "all"],  
    // switch语句强制default分支,也可添加 // no default 注释取消此次警告  
    "default-case": 2,  
    // 强制object.key 中 . 的位置,参数:  
    //      property,'.'号应与属性在同一行  
    //      object, '.' 号应与对象名在同一行  
    "dot-location": [2, "property"],  
    // 强制使用.号取属性  
    //    参数: allowKeywords:true 使用保留字做属性名时,只能使用.方式取属性  
    //                          false 使用保留字做属性名时, 只能使用[]方式取属性 e.g [2, {"allowKeywords": false}]  
    //           allowPattern:  当属性名匹配提供的正则表达式时,允许使用[]方式取值,否则只能用.号取值 e.g [2, {"allowPattern": "^[a-z]+(_[a-z]+)+$"}]  
    "dot-notation": [2, {"allowKeywords": true}],  
    // 文件末尾强制换行  
    "eol-last": 2,  
    // 使用 === 替代 ==  
    "eqeqeq": [2, "allow-null"],  
    // 方法表达式是否需要命名  
    "func-names": 0,  
    // 方法定义风格,参数:  
    //    declaration: 强制使用方法声明的方式,function f(){} e.g [2, "declaration"]  
    //    expression:强制使用方法表达式的方式,var f = function() {}  e.g [2, "expression"]  
    //    allowArrowFunctions: declaration风格中允许箭头函数。 e.g [2, "declaration", { "allowArrowFunctions": true }]  
    "func-style": 0,  
    "generator-star-spacing": [2, { "before": true, "after": true }],  
    "guard-for-in": 0,  
    "handle-callback-err": [2, "^(err|error)$" ],  
    "indent": [2, 2, { "SwitchCase": 1 }],  
    "key-spacing": [2, { "beforeColon": false, "afterColon": true }],  
    "linebreak-style": 0,  
    "lines-around-comment": 0,  
    "max-nested-callbacks": 0,  
    "new-cap": [2, { "newIsCap": true, "capIsNew": false }],  
    "new-parens": 2,  
    "newline-after-var": 0,  
    "no-alert": 0,  
    "no-array-constructor": 2,  
    "no-caller": 2,  
    "no-catch-shadow": 0,  
    "no-cond-assign": 2,  
    "no-console": 0,  
    "no-constant-condition": 0,  
    "no-continue": 0,  
    "no-control-regex": 2,  
    "no-debugger": 2,  
    "no-delete-var": 2,  
    "no-div-regex": 0,  
    "no-dupe-args": 2,  
    "no-dupe-keys": 2,  
    "no-duplicate-case": 2,  
    "no-else-return": 0,  
    "no-empty": 0,  
    "no-empty-character-class": 2,  
    "no-empty-label": 2,  
    "no-eq-null": 0,  
    "no-eval": 2,  
    "no-ex-assign": 2,  
    "no-extend-native": 2,  
    "no-extra-bind": 2,  
    "no-extra-boolean-cast": 2,  
    "no-extra-parens": 0,  
    "no-extra-semi": 0,  
    "no-fallthrough": 2,  
    "no-floating-decimal": 2,  
    "no-func-assign": 2,  
    "no-implied-eval": 2,  
    "no-inline-comments": 0,  
    "no-inner-declarations": [2, "functions"],  
    "no-invalid-regexp": 2,  
    "no-irregular-whitespace": 2,  
    "no-iterator": 2,  
    "no-label-var": 2,  
    "no-labels": 2,  
    "no-lone-blocks": 2,  
    "no-lonely-if": 0,  
    "no-loop-func": 0,  
    "no-mixed-requires": 0,  
    "no-mixed-spaces-and-tabs": 2,  
    "no-multi-spaces": 2,  
    "no-multi-str": 2,  
    "no-multiple-empty-lines": [2, { "max": 1 }],  
    "no-native-reassign": 2,  
    "no-negated-in-lhs": 2,  
    "no-nested-ternary": 0,  
    "no-new": 2,  
    "no-new-func": 0,  
    "no-new-object": 2,  
    "no-new-require": 2,  
    "no-new-wrappers": 2,  
    "no-obj-calls": 2,  
    "no-octal": 2,  
    "no-octal-escape": 2,  
    "no-param-reassign": 0,  
    "no-path-concat": 0,  
    "no-process-env": 0,  
    "no-process-exit": 0,  
    "no-proto": 0,  
    "no-redeclare": 2,  
    "no-regex-spaces": 2,  
    "no-restricted-modules": 0,  
    "no-return-assign": 2,  
    "no-script-url": 0,  
    "no-self-compare": 2,  
    "no-sequences": 2,  
    "no-shadow": 0,  
    "no-shadow-restricted-names": 2,  
    "no-spaced-func": 2,  
    "no-sparse-arrays": 2,  
    "no-sync": 0,  
    "no-ternary": 0,  
    "no-this-before-super": 2,  
    "no-throw-literal": 2,  
    "no-trailing-spaces": 2,  
    "no-undef": 2,  
    "no-undef-init": 2,  
    "no-undefined": 0,  
    "no-underscore-dangle": 0,  
    "no-unexpected-multiline": 2,  
    "no-unneeded-ternary": 2,  
    "no-unreachable": 2,  
    "no-unused-expressions": 0,  
    "no-unused-vars": [2, { "vars": "all", "args": "none" }],  
    "no-use-before-define": 0,  
    "no-var": 0,  
    "no-void": 0,  
    "no-warning-comments": 0,  
    "no-with": 2,  
    "object-curly-spacing": 0,  
    "object-shorthand": 0,  
    "one-var": [2, { "initialized": "never" }],  
    "operator-assignment": 0,  
    "operator-linebreak": [2, "after", { "overrides": { "?": "before", ":": "before" } }],  
    "padded-blocks": 0,  
    "prefer-const": 0,  
    "quote-props": 0,  
    "quotes": [2, "single", "avoid-escape"],  
    "radix": 2,  
    "semi": [2, "never"],  
    "semi-spacing": 0,  
    "sort-vars": 0,  
    "space-after-keywords": [2, "always"],  
    "space-before-blocks": [2, "always"],  
    "space-before-function-paren": [2, "always"],  
    "space-in-parens": [2, "never"],  
    "space-infix-ops": 2,  
    "space-return-throw-case": 2,  
    "space-unary-ops": [2, { "words": true, "nonwords": false }],  
    "spaced-comment": [2, "always", { "markers": ["global", "globals", "eslint", "eslint-disable", "*package", "!"] }],  
    "strict": 0,  
    "use-isnan": 2,  
    "valid-jsdoc": 0,  
    "valid-typeof": 2,  
    "vars-on-top": 0,  
    "wrap-iife": [2, "any"],  
    "wrap-regex": 0,  
    "yoda": [2, "never"]  
  }  
}

在很久之前就想通过工具来规范自己的代码风格,减少程序出错的概率,如果看过我的一个前端程序猿的Sublime Text3的自我修养,这篇博客的朋友,肯定知道在当时我使用SublimeLinter-jshint插件来规范风格,但是实际上一直懒癌发作也没去看它的文档,使用着它默认的规则。不过现在是时候切换到 ESLint 了!

作为一个有理想有抱负的前端工程师,只是使用默认规则,而不是看完文档了然于心,显然是不行滴 ^_^.. 团队协作时,若是团队的代码风格统一,能够大大减少沟通成本。(其实面试时和老大聊到代码规范,当时就说到用 JSHint ,或者 ESLint 等工具来统一的。。。这也算是我来填一个坑吧~)

好了,前情摘要就到这,我们开始吧!

什么是 ESLint ?

ESLint 是在 ECMAScript/JavaScript 代码中识别和报告模式匹配的工具,它的目标是保证代码的一致性和避免错误。在许多方面,它和 JSLint、JSHint 相似,除了少数的例外:

ESLint 使用 Espree 解析 JavaScript。

  • ESLint 使用 AST 去分析代码中的模式

  • ESLint 是完全插件化的。每一个规则都是一个插件并且你可以在运行时添加更多的规则。

以上来自官网。不想再说下去,反正就是一个代码风格检测工具就对了

如何使用

    安装
  1. npm install -g eslint
    

    如果你第一次使用 ESLint,你必须使用 --init 命令新建一个配置文件:

  2. eslint --init
    
    使用 ESLint 检测任何 JavaScript 文件:
    
        eslint test.js test2.js

ESLint 中一些规则运行命令它可以帮你自动修复

eslint test.js --fix

为了可以更直观的反馈,可能更多的会直接安装编辑器插件来进行错误提示,以Sublime 为例:

package control中 ,先安装在SublimeLinter,再安装SublimeLinter-contrib-eslint在项目目录下新建.eslintrc文件,自定义规则。
重新载入文件应该就生效了(不生效的话Ctrl+Shift+P调用命令面板 找到sublimelinter: toggle linter设置生效就好了),其他的编辑器异曲同工,就不再说了。

关于在如何在构建工具中使用,在这里不做说明(官网有)

规则定义

ESLint 支持几种格式的配置文件,如果同一个目录下有多个配置文件,ESLint 只会使用一个。优先级顺序如下:

  1. JavaScript- 使用 .eslintrc.js 然后输出一个配置对象。

  2. YAML- 使用 .eslintrc.yaml 或 .eslintrc.yml 去定义配置的结构。

  3. JSON-使用 .eslintrc.json 去定义配置的结构,ESLint 的 JSON 文件允许 JavaScript 风格的注释。

  4. Deprecated-使用 .eslintrc,可以使 JSON 也可以是 YAML。

  5. package.json- 在 package.json 里创建一个 eslintConfig属性,在那里定义你的配置。

下面就是规则啦,本人使用了.eslintrc格式,说明也在里面:

{
    // 环境定义了预定义的全局变量。
    "env": {
        //环境定义了预定义的全局变量。更多在官网查看
        "browser": true,
        "node": true,
        "commonjs": true,
        "amd": true,
        "es6":true,
        "mocha":true
    },
    // JavaScript 语言选项
    "parserOptions": {
        // ECMAScript 版本
        "ecmaVersion": 6,
        "sourceType": "script",//module
        // 想使用的额外的语言特性:
        "ecmaFeatures": {
            // 允许在全局作用域下使用 return 语句
            "globalReturn":true,
            // impliedStric
            "impliedStrict":true,
            // 启用 JSX
            "jsx":true
        }
    },
    /**
     *  "off" 或 0 - 关闭规则
     *  "warn" 或 1 - 开启规则,使用警告级别的错误:warn (不会导致程序退出),
     *  "error" 或 2 - 开启规则,使用错误级别的错误:error (当被触发的时候,程序会退出)
     */
    "rules": {

        ////////////////
        // 可能的错误  //
        ////////////////

        // 禁止条件表达式中出现赋值操作符
        "no-cond-assign": 2,
        // 禁用 console
        "no-console": 0,
        // 禁止在条件中使用常量表达式
        // if (false) {
        //     doSomethingUnfinished();
        // } //cuowu
        "no-constant-condition": 2,
        // 禁止在正则表达式中使用控制字符 :new RegExp("\x1f")
        "no-control-regex": 2,
        // 数组和对象键值对最后一个逗号, never参数:不能带末尾的逗号, always参数:必须带末尾的逗号,
        // always-multiline:多行模式必须带逗号,单行模式不能带逗号
        "comma-dangle": [1, "always-multiline"],
        // 禁用 debugger
        "no-debugger": 2,
        // 禁止 function 定义中出现重名参数
        "no-dupe-args": 2,
        // 禁止对象字面量中出现重复的 key
        "no-dupe-keys": 2,
        // 禁止重复的 case 标签
        "no-duplicate-case": 2,
        // 禁止空语句块
        "no-empty": 2,
        // 禁止在正则表达式中使用空字符集 (/^abc[]/)
        "no-empty-character-class": 2,
        // 禁止对 catch 子句的参数重新赋值
        "no-ex-assign": 2,
        // 禁止不必要的布尔转换
        "no-extra-boolean-cast": 2,
        //  禁止不必要的括号 //(a * b) + c;//报错
        "no-extra-parens": 0,
        // 禁止不必要的分号
        "no-extra-semi": 2,
        // 禁止对 function 声明重新赋值
        "no-func-assign": 2,
        //  禁止在嵌套的块中出现 function 或 var 声明
        "no-inner-declarations": [2, "functions"],
        // 禁止 RegExp 构造函数中无效的正则表达式字符串
        "no-invalid-regexp": 2,
        // 禁止在字符串和注释之外不规则的空白
        "no-irregular-whitespace": 2,
        // 禁止在 in 表达式中出现否定的左操作数
        "no-negated-in-lhs": 2,
        //   禁止把全局对象 (Math 和 JSON) 作为函数调用  错误:var math = Math();
        "no-obj-calls": 2,
        // 禁止直接使用 Object.prototypes 的内置属性
        "no-prototype-builtins":0,
        // 禁止正则表达式字面量中出现多个空格
        "no-regex-spaces": 2,
        // 禁用稀疏数组
        "no-sparse-arrays": 2,
        // 禁止出现令人困惑的多行表达式
        "no-unexpected-multiline": 2,
        // 禁止在return、throw、continue 和 break语句之后出现不可达代码
        /*
            function foo() {
            return true;
            console.log("done");
            }//错误
        */
        "no-unreachable": 2,
        // 要求使用 isNaN() 检查 NaN
        "use-isnan": 2,
        // 强制使用有效的 JSDoc 注释
        "valid-jsdoc": 1,
        // 强制 typeof 表达式与有效的字符串进行比较
        // typeof foo === "undefimed" 错误
        "valid-typeof": 2,


        //////////////
        // 最佳实践 //
        //////////////

        // 定义对象的set存取器属性时,强制定义get
        "accessor-pairs": 2,
        // 强制数组方法的回调函数中有 return 语句
        "array-callback-return":0,
        // 强制把变量的使用限制在其定义的作用域范围内
        "block-scoped-var": 0,
        // 限制圈复杂度,也就是类似if else能连续接多少个
        "complexity": [2, 9],
        //  要求 return 语句要么总是指定返回的值,要么不指定
        "consistent-return": 0,
        // 强制所有控制语句使用一致的括号风格
        "curly": [2, "all"],
        // switch 语句强制 default 分支,也可添加 // no default 注释取消此次警告
        "default-case": 2,
        // 强制object.key 中 . 的位置,参数:
        //      property,'.'号应与属性在同一行
        //      object, '.' 号应与对象名在同一行
        "dot-location": [2, "property"],
        // 强制使用.号取属性
        //    参数: allowKeywords:true 使用保留字做属性名时,只能使用.方式取属性
        //                          false 使用保留字做属性名时, 只能使用[]方式取属性 e.g [2, {"allowKeywords": false}]
        //           allowPattern:  当属性名匹配提供的正则表达式时,允许使用[]方式取值,否则只能用.号取值 e.g [2, {"allowPattern": "^[a-z]+(_[a-z]+)+$"}]
        "dot-notation": [2, { "allowKeywords": false }],
        // 使用 === 替代 == allow-null允许null和undefined==
        "eqeqeq": [2, "allow-null"],
        // 要求 for-in 循环中有一个 if 语句
        "guard-for-in": 2,
        // 禁用 alert、confirm 和 prompt
        "no-alert": 0,
        // 禁用 arguments.caller 或 arguments.callee
        "no-caller": 2,
        // 不允许在 case 子句中使用词法声明
        "no-case-declarations":2,
        // 禁止除法操作符显式的出现在正则表达式开始的位置
        "no-div-regex": 2,
        // 禁止 if 语句中有 return 之后有 else
        "no-else-return": 0,
        // 禁止出现空函数.如果一个函数包含了一条注释,它将不会被认为有问题。
        "no-empty-function":2,
        // 禁止使用空解构模式no-empty-pattern
        "no-empty-pattern":2,
        // 禁止在没有类型检查操作符的情况下与 null 进行比较
        "no-eq-null": 1,
        // 禁用 eval()
        "no-eval": 2,
        // 禁止扩展原生类型
        "no-extend-native": 2,
        // 禁止不必要的 .bind() 调用
        "no-extra-bind": 2,
        // 禁用不必要的标签
        "no-extra-label:":0,
        // 禁止 case 语句落空
        "no-fallthrough": 2,
        // 禁止数字字面量中使用前导和末尾小数点
        "no-floating-decimal": 2,
        // 禁止使用短符号进行类型转换(!!fOO)
        "no-implicit-coercion":0,
        // 禁止在全局范围内使用 var 和命名的 function 声明
        "no-implicit-globals":1,
        // 禁止使用类似 eval() 的方法
        "no-implied-eval": 2,
        // 禁止 this 关键字出现在类和类对象之外
        "no-invalid-this":0,
        // 禁用 __iterator__ 属性
        "no-iterator": 2,
        //  禁用标签语句
        "no-labels": 2,
        // 禁用不必要的嵌套块
        "no-lone-blocks": 2,
        // 禁止在循环中出现 function 声明和表达式
        "no-loop-func":1,
        // 禁用魔术数字(3.14什么的用常量代替)
        "no-magic-numbers":[1,{ "ignore": [0,-1,1] }],
        // 禁止使用多个空格
        "no-multi-spaces": 2,
        // 禁止使用多行字符串,在 JavaScript 中,可以在新行之前使用斜线创建多行字符串
        "no-multi-str": 2,
        // 禁止对原生对象赋值
        "no-native-reassign": 2,
        // 禁止在非赋值或条件语句中使用 new 操作符
        "no-new": 2,
        // 禁止对 Function 对象使用 new 操作符
        "no-new-func": 0,
        // 禁止对 String,Number 和 Boolean 使用 new 操作符
        "no-new-wrappers": 2,
        // 禁用八进制字面量
        "no-octal": 2,
        // 禁止在字符串中使用八进制转义序列
        "no-octal-escape": 2,
        // 不允许对 function 的参数进行重新赋值
        "no-param-reassign": 0,
        // 禁用 __proto__ 属性
        "no-proto": 2,
        // 禁止使用 var 多次声明同一变量
        "no-redeclare": 2,
        // 禁用指定的通过 require 加载的模块
        "no-return-assign": 0,
        // 禁止使用 javascript: url
        "no-script-url": 0,
        // 禁止自我赋值
        "no-self-assign":2,
        // 禁止自身比较
        "no-self-compare": 2,
        // 禁用逗号操作符
        "no-sequences": 2,
        // 禁止抛出非异常字面量
        "no-throw-literal": 2,
        // 禁用一成不变的循环条件
        "no-unmodified-loop-condition":2,
        // 禁止出现未使用过的表达式
        "no-unused-expressions": 0,
        // 禁用未使用过的标签
        "no-unused-labels":2,
        // 禁止不必要的 .call() 和 .apply()
        "no-useless-call":2,
        // 禁止不必要的字符串字面量或模板字面量的连接
        "no-useless-concat":2,
        // 禁用不必要的转义字符
        "no-useless-escape":0,
        // 禁用 void 操作符
        "no-void": 0,
        // 禁止在注释中使用特定的警告术语
        "no-warning-comments": 0,
        // 禁用 with 语句
        "no-with": 2,
        // 强制在parseInt()使用基数参数
        "radix": 2,
        // 要求所有的 var 声明出现在它们所在的作用域顶部
        "vars-on-top": 0,
        // 要求 IIFE 使用括号括起来
        "wrap-iife": [2, "any"],
        // 要求或禁止 “Yoda” 条件
        "yoda": [2, "never"],
        // 要求或禁止使用严格模式指令
        "strict": 0,


        //////////////
        //  变量声明 //
        //////////////

        // 要求或禁止 var 声明中的初始化(初值)
        "init-declarations":0,
        // 不允许 catch 子句的参数与外层作用域中的变量同名
        "no-catch-shadow": 0,
        // 禁止删除变量
        "no-delete-var": 2,
        // 不允许标签与变量同名
        "no-label-var": 2,
        // 禁用特定的全局变量
        "no-restricted-globals":0,
        // 禁止 var 声明 与外层作用域的变量同名
        "no-shadow": 0,
        // 禁止覆盖受限制的标识符
        "no-shadow-restricted-names": 2,
        // 禁用未声明的变量,除非它们在 /*global */ 注释中被提到
        "no-undef": 2,
        // 禁止将变量初始化为 undefined
        "no-undef-init": 2,
        // 禁止将 undefined 作为标识符
        "no-undefined": 0,
        // 禁止出现未使用过的变量
        "no-unused-vars": [2, { "vars": "all", "args": "none" }],
        // 不允许在变量定义之前使用它们
        "no-use-before-define": 0,

        //////////////////////////
        // Node.js and CommonJS //
        //////////////////////////

        // require return statements after callbacks
        "callback-return":0,
        // 要求 require() 出现在顶层模块作用域中
        "global-require": 1,
        // 要求回调函数中有容错处理
        "handle-callback-err": [2, "^(err|error)$"],
        // 禁止混合常规 var 声明和 require 调用
        "no-mixed-requires": 0,
        // 禁止调用 require 时使用 new 操作符
        "no-new-require": 2,
        // 禁止对 __dirname 和 __filename进行字符串连接
        "no-path-concat": 0,
        // 禁用 process.env
        "no-process-env": 0,
        // 禁用 process.exit()
        "no-process-exit": 0,
        // 禁用同步方法
        "no-sync": 0,

        //////////////
        // 风格指南  //
        //////////////

        // 指定数组的元素之间要以空格隔开(, 后面), never参数:[ 之前和 ] 之后不能带空格,always参数:[ 之前和 ] 之后必须带空格
        "array-bracket-spacing": [2, "never"],
        // 禁止或强制在单行代码块中使用空格(禁用)
        "block-spacing":[1,"never"],
        //强制使用一致的缩进 第二个参数为 "tab" 时,会使用tab,
        // if while function 后面的{必须与if在同一行,java风格。
        "brace-style": [2, "1tbs", { "allowSingleLine": true }],
        // 双峰驼命名格式
        "camelcase": 2,
        // 控制逗号前后的空格
        "comma-spacing": [2, { "before": false, "after": true }],
        // 控制逗号在行尾出现还是在行首出现 (默认行尾)
        // http://eslint.org/docs/rules/comma-style
        "comma-style": [2, "last"],
        //"SwitchCase" (默认:0) 强制 switch 语句中的 case 子句的缩进水平
        // 以方括号取对象属性时,[ 后面和 ] 前面是否需要空格, 可选参数 never, always
        "computed-property-spacing": [2, "never"],
        // 用于指统一在回调函数中指向this的变量名,箭头函数中的this已经可以指向外层调用者,应该没卵用了
        // e.g [0,"that"] 指定只能 var that = this. that不能指向其他任何值,this也不能赋值给that以外的其他值
        "consistent-this":  [1,"that"],
        // 强制使用命名的 function 表达式
        "func-names": 0,
        // 文件末尾强制换行
        "eol-last": 2,
        "indent": [2, 4, { "SwitchCase": 1 }],
        // 强制在对象字面量的属性中键和值之间使用一致的间距
        "key-spacing": [2, { "beforeColon": false, "afterColon": true }],
        // 强制使用一致的换行风格
        "linebreak-style": [1,"unix"],
        // 要求在注释周围有空行      ( 要求在块级注释之前有一空行)
        "lines-around-comment": [1,{"beforeBlockComment":true}],
        //  强制一致地使用函数声明或函数表达式,方法定义风格,参数:
        //    declaration: 强制使用方法声明的方式,function f(){} e.g [2, "declaration"]
        //    expression:强制使用方法表达式的方式,var f = function() {}  e.g [2, "expression"]
        //    allowArrowFunctions: declaration风格中允许箭头函数。 e.g [2, "declaration", { "allowArrowFunctions": true }]
        "func-style": 0,
        // 强制回调函数最大嵌套深度 5层
        "max-nested-callbacks": [1,5],
        // 禁止使用指定的标识符
        "id-blacklist":0,
        // 强制标识符的最新和最大长度
        "id-length":0,
        // 要求标识符匹配一个指定的正则表达式
        "id-match":0,
        // 强制在 JSX 属性中一致地使用双引号或单引号
        "jsx-quotes":0,
        // 强制在关键字前后使用一致的空格 (前后腰需要)
        "keyword-spacing":2,
        // 强制一行的最大长度
        "max-len":[1,200],
        // 强制最大行数
        "max-lines":0,
        // 强制 function 定义中最多允许的参数数量
        "max-params":[1,7],
        // 强制 function 块最多允许的的语句数量
        "max-statements":[1,200],
        // 强制每一行中所允许的最大语句数量
        "max-statements-per-line":0,
        // 要求构造函数首字母大写  (要求调用 new 操作符时有首字母大小的函数,允许调用首字母大写的函数时没有 new 操作符。)
        "new-cap": [2, { "newIsCap": true, "capIsNew": false }],
        // 要求调用无参构造函数时有圆括号
        "new-parens": 2,
        // 要求或禁止 var 声明语句后有一行空行
        "newline-after-var": 0,
        // 禁止使用 Array 构造函数
        "no-array-constructor": 2,
        // 禁用按位运算符
        "no-bitwise":0,
        // 要求 return 语句之前有一空行
        "newline-before-return":0,
        // 要求方法链中每个调用都有一个换行符
        "newline-per-chained-call":1,
        // 禁用 continue 语句
        "no-continue": 0,
        // 禁止在代码行后使用内联注释
        "no-inline-comments": 0,
        // 禁止 if 作为唯一的语句出现在 else 语句中
        "no-lonely-if": 0,
        // 禁止混合使用不同的操作符
        "no-mixed-operators":0,
        // 不允许空格和 tab 混合缩进
        "no-mixed-spaces-and-tabs": 2,
        // 不允许多个空行
        "no-multiple-empty-lines": [2, { "max": 2 }],
        // 不允许否定的表达式
        "no-negated-condition":0,
        // 不允许使用嵌套的三元表达式
        "no-nested-ternary": 0,
        // 禁止使用 Object 的构造函数
        "no-new-object": 2,
        // 禁止使用一元操作符 ++ 和 --
        "no-plusplus":0,
        // 禁止使用特定的语法
        "no-restricted-syntax":0,
        // 禁止 function 标识符和括号之间出现空格
        "no-spaced-func": 2,
        // 不允许使用三元操作符
        "no-ternary": 0,
        //  禁用行尾空格
        "no-trailing-spaces": 2,
        // 禁止标识符中有悬空下划线_bar
        "no-underscore-dangle": 0,
        // 禁止可以在有更简单的可替代的表达式时使用三元操作符
        "no-unneeded-ternary": 2,
        // 禁止属性前有空白
        "no-whitespace-before-property":0,
        // 强制花括号内换行符的一致性
        "object-curly-newline":0,
        // 强制在花括号中使用一致的空格
        "object-curly-spacing": 0,
        // 强制将对象的属性放在不同的行上
        "object-property-newline":0,
        // 强制函数中的变量要么一起声明要么分开声明
        "one-var": [2, { "initialized": "never" }],
        // 要求或禁止在 var 声明周围换行
        "one-var-declaration-per-line":0,
        // 要求或禁止在可能的情况下要求使用简化的赋值操作符
        "operator-assignment": 0,
        // 强制操作符使用一致的换行符
        "operator-linebreak": [2, "after", { "overrides": { "?": "before", ":": "before" } }],
        // 要求或禁止块内填充
        "padded-blocks": 0,
        // 要求对象字面量属性名称用引号括起来
        "quote-props": 0,
        // 强制使用一致的反勾号、双引号或单引号
        "quotes": [2, "single", "avoid-escape"],
        // 要求使用 JSDoc 注释
        "require-jsdoc":1,
        // 要求或禁止使用分号而不是 ASI(这个才是控制行尾部分号的,)
        "semi": [2, "always"],
        // 强制分号之前和之后使用一致的空格
        "semi-spacing": 0,
        // 要求同一个声明块中的变量按顺序排列
        "sort-vars": 0,
        // 强制在块之前使用一致的空格
        "space-before-blocks": [2, "always"],
        // 强制在 function的左括号之前使用一致的空格
        "space-before-function-paren": [2, "always"],
        // 强制在圆括号内使用一致的空格
        "space-in-parens": [2, "never"],
        // 要求操作符周围有空格
        "space-infix-ops": 2,
        // 强制在一元操作符前后使用一致的空格
        "space-unary-ops": [2, { "words": true, "nonwords": false }],
        // 强制在注释中 // 或 /* 使用一致的空格
        "spaced-comment": [2, "always", { "markers": ["global", "globals", "eslint", "eslint-disable", "*package", "!"] }],
        // 要求或禁止 Unicode BOM
        "unicode-bom": 0,
        //  要求正则表达式被括号括起来
        "wrap-regex": 0,

        //////////////
        // ES6.相关 //
        //////////////

        // 要求箭头函数体使用大括号
        "arrow-body-style": 2,
        // 要求箭头函数的参数使用圆括号
        "arrow-parens": 2,
        "arrow-spacing":[2,{ "before": true, "after": true }],
        // 强制在子类构造函数中用super()调用父类构造函数,TypeScrip的编译器也会提示
        "constructor-super": 0,
        // 强制 generator 函数中 * 号周围使用一致的空格
        "generator-star-spacing": [2, { "before": true, "after": true }],
        // 禁止修改类声明的变量
        "no-class-assign":2,
        // 不允许箭头功能,在那里他们可以混淆的比较
        "no-confusing-arrow":0,
        // 禁止修改 const 声明的变量
        "no-const-assign":2,
        // 禁止类成员中出现重复的名称
        "no-dupe-class-members":2,
        // 不允许复制模块的进口
        "no-duplicate-imports":0,
        // 禁止 Symbol  的构造函数
        "no-new-symbol":2,
        // 允许指定模块加载时的进口
        "no-restricted-imports":0,
        // 禁止在构造函数中,在调用 super() 之前使用 this 或 super
        "no-this-before-super": 2,
        // 禁止不必要的计算性能键对象的文字
        "no-useless-computed-key":0,
        // 要求使用 let 或 const 而不是 var
        "no-var": 0,
        // 要求或禁止对象字面量中方法和属性使用简写语法
        "object-shorthand": 0,
        // 要求使用箭头函数作为回调
        "prefer-arrow-callback":0,
        // 要求使用 const 声明那些声明后不再被修改的变量
        "prefer-const": 0,
        // 要求在合适的地方使用 Reflect 方法
        "prefer-reflect":0,
        // 要求使用扩展运算符而非 .apply()
        "prefer-spread":0,
        // 要求使用模板字面量而非字符串连接
        "prefer-template":0,
        // Suggest using the rest parameters instead of arguments
        "prefer-rest-params":0,
        // 要求generator 函数内有 yield
        "require-yield":0,
        // enforce spacing between rest and spread operators and their expressions
        "rest-spread-spacing":0,
        // 强制模块内的 import 排序
        "sort-imports":0,
        // 要求或禁止模板字符串中的嵌入表达式周围空格的使用
        "template-curly-spacing":1,
        // 强制在 yield* 表达式中 * 周围使用空格
        "yield-star-spacing":2
    }
}

results matching ""

    No results matching ""