ESLint

可组装的JavaScript和JSX检查工具

ESLint

安装

先决条件：Node.js (>=6.14), npm version 3+。

• npm 安装 ESLint：

$ npm install eslint --save-dev

• 设置一个配置文件

$ ./node_modules/.bin/eslint --init

• 在任何文件或目录上运行ESLint

$ ./node_modules/.bin/eslint yourfile.js

配置

配置方式

Configuration Comments 配置注释

使用 JavaScript 注释把配置信息直接嵌入到一个代码源文件中。

Configuration Files 配置文件

【常用】使用 JavaScript、JSON 或者 YAML 文件为整个目录（处理你的主目录）和它的子目录指定配置信息。

• 可以配置一个独立的 .eslintrc.* 文件

• 或者直接在 package.json 文件里的 eslintConfig 字段指定配置，ESLint 会查找和自动读取它们，

• 再者，你可以在命令行运行时指定一个任意的配置文件。（-c, --config）

eslint -c ~/my-eslint.json file.js

这个例子使用了 ~/my-eslint.json 作为配置文件。如果 .eslintrc.* 和/或 package.json 文件也用于配置（比如，不指定 --no-eslintrc），配置将被合并。此配置文件中的选项优先于 .eslintrc.* 和 package.json 文件中的选项。

Eslint配置

Eslint配置

Rule规则

Eslint规则

命令行

Eslint 命令行

忽略

• 通过配置文件.eslintignore指定需要忽略的文件或目录

• 通过命令行参数--ignore-path、--no-ignore、--ignore-pattern 指定

  • --ignore-path

    允许你指定一个文件作为 .eslintignore。默认情况下，ESLint 在当前工作目录下查找 .eslintignore。你可以通过提供另一个文件的路径改变这种行为。

    eslint --ignore-path tmp/.eslintignore file.js
    eslint --ignore-path .gitignore file.js
    

  • --no-ignore

    禁止排除 .eslintignore、--ignore-path 和 --ignore-pattern 文件中指定的文件。

  • --ignore-pattern

    允许你指定要忽略的文件模式(除了 .eslintignore 中的模式之外)。你可以重复该选项以提供多个模式。所支持的语法同 .eslintignore 文件 中的相同，即使用同 .gitignore 规范 相同的模式。

  eslint --ignore-pattern '/lib/' --ignore-pattern '/src/vendor/*' .
  

• 使用 --ext 命令行选项指定一个逗号分隔的扩展名列表，从而达到忽略其他文件的作用。注意，该标记只在与目录（eslint命令后的参数是目录）一起使用时有效，如果使用文件名或 glob 模式，它将会被忽略。