安装及快速使用

ESLint是一个语法规则和代码风格的检查工具,可以用来保证写出语法正确、风格统一的代码。

首先,安装ESLint。

$ npm i -g eslint

创建一个配置文件

$ eslint --init

会有一个选项,帮助我们配置该文件,如下所示:

? How would you like to configure ESLint? Answer questions about your style
? Are you using ECMAScript 6 features? No
? Where will your code run? Browser, Node
? Do you use CommonJS? Yes
? Do you use JSX? No
? What style of indentation do you use? Spaces
? What quotes do you use for strings? Single
? What line endings do you use? Unix
? Do you require semicolons? Yes
? What format do you want your config file to be in? JavaScript

结束后会在当前目录自动生成一个.eslintrc配置文件,用于设置各种配置信息。具体可见后文。

上面生成的配置文件内容如下:

module.exports = {
    "env": {
        "browser": true,
        "commonjs": true,
        "node": true
    },
    "extends": "eslint:recommended",
    "rules": {
        "indent": [
            "error",
            4
        ],
        "linebreak-style": [
            "error",
            "unix"
        ],
        "quotes": [
            "error",
            "single"
        ],
        "semi": [
            "error",
            "always"
        ]
    }
};

接下来就是实战了。 新建一个文件eslint-test.js,加入如下一段测试代码:

var unused = 'I have no purpose!';

function greet() {
    var message = "Hello, World";
    alert(message);
}

greet()

然后,在命令行通过eslint工具进行规格检查

eslint eslint-test.js

其会根据.eslintrc里的配置对eslint-test.js文件中的代码进行检查。 反馈如下:

  1:5   error  'unused' is assigned a value but never used  no-unused-vars
  4:19  error  Strings must use singlequote                 quotes
  8:8   error  Missing semicolon                            semi

✖ 3 problems (3 errors, 0 warnings)

错误位置、等级、详细描述、对应rule字段等有关错误的信息,都逐条显示出来了。

results matching ""

    No results matching ""