Eslint安装使用 - 配置解析

前言

ESLint是一个ECMAScript/JavaScript语法规则和代码风格的检查工具，它的目标是保证代码的一致性和避免错误。

借助 ESLint，可将 静态代码分析 和 问题代码协助修复 集成到编码、提交和打包过程中，及早发现并协助修复代码中：

有语法错误的部分
不符合约定的样式准则的部分
不符合约定的最佳实践的部分

在项目开发中获得如下收益：

在执行代码之前发现并修复语法错误，减少调试耗时和潜在 bug
保证项目的编码风格统一，提高可维护性
督促团队成员在编码时遵守约定的最佳实践，提高代码质量

Eslint需要在node环境下才能运行，使用eslint前先安装node

安装eslint

在项目根目录终端中输入 npm init 创建 package.json 文件；
输入命令 npm install -g eslint 安装eslint
初始化 eslint --init

选择配置

1、你想如何使用eslint？

解析：

只检查语法
检查语法并发现问题
检查语法，发现问题，并执行代码样式

选择第三项检查语法，发现错误并执行代码规范风格，这是eslint规范化服务最全的一项

2、您的项目使用什么类型的模块?

解析：

js模块化（导入/导出）方案
node的CommonJS模块化（导入/导出）方案
none其他：根据自己需求来

选择第一项跟第三项都可

3、您的项目使用哪个框架(根据情况选择)

解析：

React项目
Vue项目
none其他：根据自己需求来

选择第三项

4、项目是否使用Typescript

解析：

项目是否使用Typescript（yes/no）

这里选择no，根据自己需求来

5、项目在那个引擎中运行

解析：

浏览器环境中
node环境中

这里选择Browser

6、你要如何定义项目的规范风格

解析：

使用流行的风格指南
根据自己的风格来

这里选择第一个

7、要跟随哪一个规范化风格的指导

解析：

airbnb规范
标准规范
谷歌规范
XO规范

这里选择第二个

8、eslint配置文件用什么格式

解析：

js格式
yaml格式
json格式

这里选择第一个

9、是否确认安装需求文件

解析：

是否确认安装需求文件（yes/no）

这里选择yes

10、你是否喜欢用npm来安装它们

解析：

你是否喜欢用npm来安装它们（yes/no）

这里选择yes

Eslint配置解析

配置文件中包含的相对路径和 glob 模式都是基于当前配置文件的路径进行解析的。

两种主要的配置方式

配置注释 - 在目标文件中使用注释语法嵌入配置信息。这种配置只对当前文件有效。
配置文件 - 在 JavaScript、JSON 或 YAML 文件中定义配置信息。对于这种配置方式，配置信息可以写在单独的 .eslintrc.* 文件中，或者写在 package.json 文件的 eslintConfig 字段中。这种配置对配置文件所在目录及其子目录树中的所有文件有效。

配置文件格式

JavaScript - use .eslintrc.js 文件导出一个包含配置信息的对象。
JSON - 使用 .eslintrc.json 定义配置信息，JSON 文件中支持 JavaScript 注释。
package.json - 在 package.json 文件中增加一个 eslintConfig 字段，在该字段中定义配置信息。
.eslintrc

如果有多个配置优先级如下：

.eslintrc.js
.eslintrc.json
.eslintrc
package.json

配置参数

parser

指定 ESLint 使用的语法分析器。ESLint 兼容的语法分析器有：Esprima、Babel-ESLint、@typescript-eslint/parser，ESLint 默认使用 Esprima。

parserOptions

指定语法分析器选项，默认使用的语法分析器支持如下几个选项：ecmaVersion、sourceType、ecmaFeatures。示例：

{
  "parserOptions": {
    "ecmaVersion": 6,
    "sourceType": "module",
    "ecmaFeatures": {
      "jsx": true
    }
  }
}

不同的语法分析器可能具有不同的选项。

env

指定执行环境，一个执行环境会预定义一组全局变量。示例：

使用注释配置

/* eslint-env node, mocha */

使用配置文件

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

globals

使用未在当前文件中定义的全局变量时，会命中 no-undef 规则，通过 globals 配置指定的全局变量无视 no-undef 规则。示例：

在配置文件中指定：

{
  "globals": {
    "var1": "writable",
    "var2": "readonly"
  }
}

plugins

插件是第三方定制的规则集合，plugins 参数用于指定第三方插件，插件名中的 eslint-plugin- 前缀可以省略。示例：

{
  plugins: [
    'typescript',
    '@typescript-eslint',
    "prettier"
  ]
}

使用插件时必须安装其 npm 包。

extends

配置文件可以在已有配置的基础上进行扩展，extends 用于指定基础配置。该参数的值为以下之一：

一个指定基础配置来源的字符串
一个指定基础配置来源的字符串的数组：数组中每个配置扩展它前面的配置

ESLint 支持递归扩展配置，所以基础配置中也可包含 extends 参数。

当指定基础配置时，rules 参数指定的规则可按如下几种方式进行扩展：

启用基础配置中没有规则
继承基础配置中的规则，改变其错误级别，但不改变其附加选项：
- 基础配置: "eqeqeq": ["error", "allow-null"]
- 扩展配置: "eqeqeq": "warn"
- 最终有效配置："eqeqeq": ["warn", "allow-null"]
覆盖基础配置中的规则:
- 基础配置："quotes": ["error", "single", "avoid-escape"]
- 扩展配置："quotes": ["error", "single"]
- 最终有效配置: "quotes": ["error", "single"]

使用 extends 指定的基础配置来源可以是：

eslint:recommended，启用 ESLint 内置规则集的一个子集。
共享配置包，一类导出 ESLint 配置对象的 npm 包，比如 eslint-config-standard、eslint-config-airbnb 等。共享配置包需要安装才能使用，配置时可省略报名中的 eslint-config- 前缀。

示例：

{
  "extends": ["airbnb"]
  "rules": {
    "no-set-state": "off"
  }
}

插件导出的命名配置，其配置值由以下几部分组成：
- plugin:
  - 插件包名（可省略前缀，例如：react）
  - /
  - 配置名（例如：recommended）

示例：

{
  "plugins": [
    "react"
  ],
  "extends": [
    "eslint:recommended",
    "plugin:react/recommended"
  ],
  "rules": {
    "no-set-state": "off"
  }
}

配置文件，通过配置文件的绝对路径或相对路径指定。

示例：

{
  "extends": [
    "./node_modules/coding-standard/eslintDefaults.js",
    "./node_modules/coding-standard/.eslintrc-es6",
    "./node_modules/coding-standard/.eslintrc-jsx",
    "./my-eslint-config.js"
  ],
  "rules": {
    "eqeqeq": "warn"
  }
}

eslint:all，启动所有 ESLint 内置规则，不推荐。

规则

ESLint 附带有大量的规则。你可以使用注释或配置文件修改你项目中要使用哪些规则。改变一个规则设置，你必须设置规则 ID 等于这些值之一：

"off"或0 -关闭规则
"warn" 或1 - 开启规则, 使用警告程序不会退出
"error"或2 - 开启规则, 使用错误程序退出

rule解释

"no-alert": 0,//禁止使用alert confirm prompt
"no-array-constructor": 2,//禁止使用数组构造器
"no-bitwise": 0,//禁止使用按位运算符
"no-caller": 1,//禁止使用arguments.caller或arguments.callee
"no-catch-shadow": 2,//禁止catch子句参数与外部作用域变量同名
"no-class-assign": 2,//禁止给类赋值
"no-cond-assign": 2,//禁止在条件表达式中使用赋值语句
"no-console": 2,//禁止使用console
"no-const-assign": 2,//禁止修改const声明的变量
"no-constant-condition": 2,//禁止在条件中使用常量表达式 if(true) if(1)
"no-continue": 0,//禁止使用continue
"no-control-regex": 2,//禁止在正则表达式中使用控制字符
"no-debugger": 2,//禁止使用debugger
"no-delete-var": 2,//不能对var声明的变量使用delete操作符
"no-div-regex": 1,//不能使用看起来像除法的正则表达式/=foo/
"no-dupe-keys": 2,//在创建对象字面量时不允许键重复 {a:1,a:1}
"no-dupe-args": 2,//函数参数不能重复
"no-duplicate-case": 2,//switch中的case标签不能重复
"no-else-return": 2,//如果if语句里面有return,后面不能跟else语句
"no-empty": 2,//块语句中的内容不能为空
"no-empty-character-class": 2,//正则表达式中的[]内容不能为空
"no-empty-label": 2,//禁止使用空label
"no-eq-null": 2,//禁止对null使用==或!=运算符
"no-eval": 1,//禁止使用eval
"no-ex-assign": 2,//禁止给catch语句中的异常参数赋值
"no-extend-native": 2,//禁止扩展native对象
"no-extra-bind": 2,//禁止不必要的函数绑定
"no-extra-boolean-cast": 2,//禁止不必要的bool转换
"no-extra-parens": 2,//禁止非必要的括号
"no-extra-semi": 2,//禁止多余的冒号
"no-fallthrough": 1,//禁止switch穿透
"no-floating-decimal": 2,//禁止省略浮点数中的0 .5 3.
"no-func-assign": 2,//禁止重复的函数声明
"no-implicit-coercion": 1,//禁止隐式转换
"no-implied-eval": 2,//禁止使用隐式eval
"no-inline-comments": 0,//禁止行内备注
"no-inner-declarations": [2, "functions"],//禁止在块语句中使用声明（变量或函数）
"no-invalid-regexp": 2,//禁止无效的正则表达式
"no-invalid-this": 2,//禁止无效的this，只能用在构造器，类，对象字面量
"no-irregular-whitespace": 2,//不能有不规则的空格
"no-iterator": 2,//禁止使用__iterator__ 属性
"no-label-var": 2,//label名不能与var声明的变量名相同
"no-labels": 2,//禁止标签声明
"no-lone-blocks": 2,//禁止不必要的嵌套块
"no-lonely-if": 2,//禁止else语句内只有if语句
"no-loop-func": 1,//禁止在循环中使用函数（如果没有引用外部变量不形成闭包就可以）
"no-mixed-requires": [0, false],//声明时不能混用声明类型
"no-mixed-spaces-and-tabs": [2, false],//禁止混用tab和空格
"linebreak-style": [0, "windows"],//换行风格
"no-multi-spaces": 0,//不能用多余的空格
"no-multi-str": 2,//字符串不能用\换行
"no-multiple-empty-lines": [1, {"max": 3}],//空行最多不能超过2行
"no-native-reassign": 2,//不能重写native对象
"no-negated-in-lhs": 2,//in 操作符的左边不能有!
"no-nested-ternary": 0,//禁止使用嵌套的三目运算
"no-new": 1,//禁止在使用new构造一个实例后不赋值
"no-new-func": 1,//禁止使用new Function
"no-new-object": 2,//禁止使用new Object()
"no-new-require": 2,//禁止使用new require
"no-new-wrappers": 2,//禁止使用new创建包装实例，new String new Boolean new Number
"no-obj-calls": 2,//不能调用内置的全局对象，比如Math() JSON()
"no-octal": 2,//禁止使用八进制数字
"no-octal-escape": 2,//禁止使用八进制转义序列
"no-param-reassign": 2,//禁止给参数重新赋值
"no-path-concat": 0,//node中不能使用__dirname或__filename做路径拼接
"no-plusplus": 0,//禁止使用++，--
"no-process-env": 0,//禁止使用process.env
"no-process-exit": 0,//禁止使用process.exit()
"no-proto": 2,//禁止使用__proto__属性
"no-redeclare": 2,//禁止重复声明变量
"no-regex-spaces": 2,//禁止在正则表达式字面量中使用多个空格 /foo bar/
"no-restricted-modules": 0,//如果禁用了指定模块，使用就会报错
"no-return-assign": 1,//return 语句中不能有赋值表达式
"no-script-url": 0,//禁止使用javascript:void(0)
"no-self-compare": 2,//不能比较自身
"no-sequences": 0,//禁止使用逗号运算符
"no-shadow": 2,//外部作用域中的变量不能与它所包含的作用域中的变量或参数同名
"no-shadow-restricted-names": 2,//严格模式中规定的限制标识符不能作为声明时的变量名使用
"no-spaced-func": 2,//函数调用时 函数名与()之间不能有空格
"no-sparse-arrays": 2,//禁止稀疏数组， [1,,2]
"no-sync": 0,//nodejs 禁止同步方法
"no-ternary": 0,//禁止使用三目运算符
"no-trailing-spaces": 1,//一行结束后面不要有空格
"no-this-before-super": 0,//在调用super()之前不能使用this或super
"no-throw-literal": 2,//禁止抛出字面量错误 throw "error";
"no-undef": 2,//不能有未定义的变量
"no-undef-init": 2,//变量初始化时不能直接给它赋值为undefined
"no-undefined": 2,//不能使用undefined
"no-unexpected-multiline": 2,//避免多行表达式
"no-underscore-dangle": 1,//标识符不能以_开头或结尾
"no-unneeded-ternary": 2,//禁止不必要的嵌套 var isYes = answer === 1 ? true : false;
"no-unreachable": 2,//不能有无法执行的代码
"no-unused-expressions": 2,//禁止无用的表达式
"no-unused-vars": [2, {"vars": "all", "args": "after-used"}],//不能有声明后未被使用的变量或参数
"no-use-before-define": 2,//未定义前不能使用
"no-useless-call": 2,//禁止不必要的call和apply
"no-void": 2,//禁用void操作符
"no-var": 0,//禁用var，用let和const代替
"no-warning-comments": [1, { "terms": ["todo", "fixme", "xxx"], "location": "start" }],//不能有警告备注
"no-with": 2,//禁用with

"array-bracket-spacing": [2, "never"],//是否允许非空数组里面有多余的空格
"arrow-parens": 0,//箭头函数用小括号括起来
"arrow-spacing": 0,//=>的前/后括号
"accessor-pairs": 0,//在对象中使用getter/setter
"block-scoped-var": 0,//块语句中使用var
"brace-style": [1, "1tbs"],//大括号风格
"callback-return": 1,//避免多次调用回调什么的
"camelcase": 2,//强制驼峰法命名
"comma-dangle": [2, "never"],//对象字面量项尾不能有逗号
"comma-spacing": 0,//逗号前后的空格
"comma-style": [2, "last"],//逗号风格，换行时在行首还是行尾
"complexity": [0, 11],//循环复杂度
"computed-property-spacing": [0, "never"],//是否允许计算后的键名什么的
"consistent-return": 0,//return 后面是否允许省略
"consistent-this": [2, "that"],//this别名
"constructor-super": 0,//非派生类不能调用super，派生类必须调用super
"curly": [2, "all"],//必须使用 if(){} 中的{}
"default-case": 2,//switch语句最后必须有default
"dot-location": 0,//对象访问符的位置，换行的时候在行首还是行尾
"dot-notation": [0, { "allowKeywords": true }],//避免不必要的方括号
"eol-last": 0,//文件以单一的换行符结束
"eqeqeq": 0,//必须使用全等
"func-names": 0,//函数表达式必须有名字
"func-style": [0, "declaration"],//函数风格，规定只能使用函数声明/函数表达式
"generator-star-spacing": 0,//生成器函数*的前后空格
"guard-for-in": 0,//for in循环要用if语句过滤
"handle-callback-err": 0,//nodejs 处理错误
"id-length": 0,//变量名长度
"indent": [2, 2],//缩进风格
"init-declarations": 0,//声明时必须赋初值
"key-spacing": [0, { "beforeColon": false, "afterColon": true }],//对象字面量中冒号的前后空格
"lines-around-comment": 0,//行前/行后备注
"max-depth": [0, 4],//嵌套块深度
"max-len": [0, 80, 4],//字符串最大长度
"max-nested-callbacks": [0, 2],//回调嵌套深度
"max-params": [0, 3],//函数最多只能有3个参数
"max-statements": [0, 10],//函数内最多有几个声明
"new-cap": 2,//函数名首行大写必须使用new方式调用，首行小写必须用不带new方式调用
"new-parens": 2,//new时必须加小括号
"newline-after-var": 2,//变量声明后是否需要空一行
"object-curly-spacing": [0, "never"],//大括号内是否允许不必要的空格
"object-shorthand": 0,//强制对象字面量缩写语法
"one-var": 1,//连续声明
"operator-assignment": [0, "always"],//赋值运算符 += -=什么的
"operator-linebreak": [2, "after"],//换行时运算符在行尾还是行首
"padded-blocks": 0,//块语句内行首行尾是否要空行
"prefer-const": 0,//首选const
"prefer-spread": 0,//首选展开运算
"prefer-reflect": 0,//首选Reflect的方法
"quotes": [1, "single"],//引号类型 `` "" ''
"quote-props":[2, "always"],//对象字面量中的属性名是否强制双引号
"radix": 2,//parseInt必须指定第二个参数
"id-match": 0,//命名检测
"require-yield": 0,//生成器函数必须有yield
"semi": [2, "always"],//语句强制分号结尾
"semi-spacing": [0, {"before": false, "after": true}],//分号前后空格
"sort-vars": 0,//变量声明时排序
"space-after-keywords": [0, "always"],//关键字后面是否要空一格
"space-before-blocks": [0, "always"],//不以新行开始的块{前面要不要有空格
"space-before-function-paren": [0, "always"],//函数定义时括号前面要不要有空格
"space-in-parens": [0, "never"],//小括号里面要不要有空格
"space-infix-ops": 0,//中缀操作符周围要不要有空格
"space-return-throw-case": 2,//return throw case后面要不要加空格
"space-unary-ops": [0, { "words": true, "nonwords": false }],//一元运算符的前/后要不要加空格
"spaced-comment": 0,//注释风格要不要有空格什么的
"strict": 2,//使用严格模式
"use-isnan": 2,//禁止比较时使用NaN，只能用isNaN()
"valid-jsdoc": 0,//jsdoc规则
"valid-typeof": 2,//必须使用合法的typeof的值
"vars-on-top": 2,//var必须放在作用域顶部
"wrap-iife": [2, "inside"],//立即执行函数表达式的小括号风格
"wrap-regex": 0,//正则表达式字面量用小括号包起来
"yoda": [2, "never"]//禁止尤达条件

Eslint安装使用 - 配置解析

前言

安装eslint

选择配置

1、你想如何使用eslint？

2、您的项目使用什么类型的模块?

3、您的项目使用哪个框架(根据情况选择)

4、项目是否使用Typescript

5、项目在那个引擎中运行

6、你要如何定义项目的规范风格

7、要跟随哪一个规范化风格的指导

8、eslint配置文件用什么格式

9、是否确认安装需求文件

10、你是否喜欢用npm来安装它们

Eslint配置解析

两种主要的配置方式

配置文件格式

配置参数

parser

parserOptions

env

globals

plugins

extends

规则

rule解释

你可能感兴趣的:(Eslint安装使用 - 配置解析)