ESLint 附带有大量的规则。你可以使用注释或配置文件修改你项目中要使用的规则。要改变一个规则设置,你必须将规则 ID 设置为下列值之一:
"off"
或0
- 关闭规则"warn"
或1
- 开启规则,使用警告级别的错误:warn
(不会导致程序退出)"error"
或2
- 开启规则,使用错误级别的错误:error
(当被触发的时候,程序会退出)
为了让你对规则有个更好的理解,ESLint 对其进行了分门别类。
所有的规则默认都是禁用的。在配置文件中,使用 "extends": "eslint:recommended"
来启用推荐的规则,报告一些常见的问题,在下文中这些推荐的规则都带有一个标记。
Possible Errors
这些规则与 JavaScript 代码中可能的错误或逻辑错误有关:
强制 “for” 循环中更新子句的计数器朝着正确的方向移动 | |||
强制 getter 函数中出现 | |||
禁止使用异步函数作为 Promise executor | |||
禁止在循环中出现 | |||
禁止与 -0 进行比较 | |||
禁止条件表达式中出现赋值操作符 | |||
禁用 | |||
禁止在条件中使用常量表达式 | |||
禁止在正则表达式中使用控制字符 | |||
禁用 | |||
禁止 | |||
禁止对象字面量中出现重复的 key | |||
禁止出现重复的 case 标签 | |||
禁止出现空语句块 | |||
禁止在正则表达式中使用空字符集 | |||
禁止对 | |||
禁止不必要的布尔转换 | |||
禁止不必要的括号 | |||
禁止不必要的分号 | |||
禁止对 | |||
禁止在嵌套的块中出现变量声明或 | |||
禁止 | |||
禁止不规则的空白 | |||
不允许在字符类语法中出现由多个代码点组成的字符 | |||
禁止把全局对象作为函数调用 | |||
禁止直接调用 | |||
禁止正则表达式字面量中出现多个空格 | |||
禁用稀疏数组 | |||
禁止在常规字符串中出现模板字面量占位符语法 | |||
禁止出现令人困惑的多行表达式 | |||
禁止在 | |||
禁止在 | |||
禁止对关系运算符的左操作数使用否定操作符 | |||
禁止由于 | |||
要求使用 | |||
强制 |
Best Practices
这些规则是关于最佳实践的,帮助你避免一些问题
强制 getter 和 setter 在对象中成对出现 | |||
强制数组方法的回调函数中有 | |||
强制把变量的使用限制在其定义的作用域范围内 | |||
强制类方法使用 | |||
指定程序中允许的最大环路复杂度 | |||
要求 | |||
强制所有控制语句使用一致的括号风格 | |||
要求 | |||
强制在点号之前和之后一致的换行 | |||
强制尽可能地使用点号 | |||
要求使用 | |||
要求 | |||
强制每个文件中包含的的类的最大数量 | |||
禁用 | |||
禁用 | |||
不允许在 case 子句中使用词法声明 | |||
禁止除法操作符显式的出现在正则表达式开始的位置 | |||
禁止 | |||
禁止出现空函数 | |||
禁止使用空解构模式 | |||
禁止在没有类型检查操作符的情况下与 | |||
禁用 | |||
禁止扩展原生类型 | |||
禁止不必要的 | |||
禁用不必要的标签 | |||
禁止 | |||
禁止数字字面量中使用前导和末尾小数点 | |||
禁止对原生对象或只读的全局对象进行赋值 | |||
禁止使用短符号进行类型转换 | |||
禁止在全局范围内使用变量声明和 | |||
禁止使用类似 | |||
禁止 | |||
禁用 | |||
禁用标签语句 | |||
禁用不必要的嵌套块 | |||
禁止在循环语句中出现包含不安全引用的函数声明 | |||
禁用魔术数字 | |||
禁止使用多个空格 | |||
禁止使用多行字符串 | |||
禁止使用 | |||
禁止对 | |||
禁止对 | |||
禁用八进制字面量 | |||
禁止在字符串中使用八进制转义序列 | |||
禁止对 | |||
禁用 | |||
禁止多次声明同一变量 | |||
禁止使用对象的某些属性 | |||
禁止在 | |||
禁用不必要的 | |||
禁止使用 | |||
禁止自我赋值 | |||
禁止自身比较 | |||
禁用逗号操作符 | |||
禁止抛出异常字面量 | |||
禁用一成不变的循环条件 | |||
禁止出现未使用过的表达式 | |||
禁用出现未使用过的标 | |||
禁止不必要的 | |||
禁止不必要的 | |||
禁止不必要的字符串字面量或模板字面量的连接 | |||
禁用不必要的转义字符 | |||
禁止多余的 return 语句 | |||
禁用 | |||
禁止在注释中使用特定的警告术语 | |||
禁用 | |||
建议在正则表达式中使用命名捕获组 | |||
要求使用 Error 对象作为 Promise 拒绝的原因 | |||
强制在 | |||
禁止使用不带 | |||
强制在 RegExp 上使用 | |||
要求所有的 | |||
要求 IIFE 使用括号括起来 | |||
要求或禁止 “Yoda” 条件 |
Strict Mode
该规则与使用严格模式和严格模式指令有关:
要求或禁止使用严格模式指令 |
Variables
这些规则与变量声明有关:
要求或禁止 | |||
禁止删除变量 | |||
不允许标签与变量同名 | |||
禁用特定的全局变量 | |||
禁止变量声明与外层作用域的变量同名 | |||
禁止将标识符定义为受限的名字 | |||
禁用未声明的变量,除非它们在 | |||
禁止将变量初始化为 | |||
禁止将 | |||
禁止出现未使用过的变量 | |||
禁止在变量定义之前使用它们 |
Node.js and CommonJS
这些规则是关于Node.js 或 在浏览器中使用CommonJS 的:
强制数组方法的回调函数中有 | |||
要求 | |||
要求回调函数中有容错处理 | |||
禁用 | |||
禁止混合常规变量声明和 | |||
禁止调用 | |||
禁止对 | |||
禁用 | |||
禁用 | |||
禁用通过 | |||
禁用同步方法 |
Stylistic Issues
这些规则是关于风格指南的,而且是非常主观的:
在数组开括号后和闭括号前强制换行 | |||
强制数组方括号中使用一致的空格 | |||
强制数组元素间出现换行 | |||
禁止或强制在代码块中开括号前和闭括号后有空格 | |||
强制在代码块中使用一致的大括号风格 | |||
强制使用骆驼拼写法命名约定 | |||
强制或禁止对注释的第一个字母大写 | |||
要求或禁止末尾逗号 | |||
强制在逗号前后使用一致的空格 | |||
强制使用一致的逗号风格 | |||
强制在计算的属性的方括号中使用一致的空格 | |||
当获取当前执行环境的上下文时,强制使用一致的命名 | |||
要求或禁止文件末尾存在空行 | |||
要求或禁止在函数标识符和其调用之间有空格 | |||
要求函数名与赋值给它们的变量名或属性名相匹配 | |||
要求或禁止使用命名的 | |||
强制一致地使用 | |||
强制在函数括号内使用一致的换行 | |||
禁用指定的标识符 | |||
强制标识符的最小和最大长度 | |||
要求标识符匹配一个指定的正则表达式 | |||
强制隐式返回的箭头函数体的位置 | |||
强制使用一致的缩进 | |||
强制在 JSX 属性中一致地使用双引号或单引号 | |||
强制在对象字面量的属性中键和值之间使用一致的间距 | |||
强制在关键字前后使用一致的空格 | |||
强制行注释的位置 | |||
强制使用一致的换行风格 | |||
要求在注释周围有空行 | |||
要求或禁止类成员之间出现空行 | |||
强制可嵌套的块的最大深度 | |||
强制一行的最大长度 | |||
强制最大行数 | |||
强制函数最大代码行数 | |||
强制回调函数最大嵌套深度 | |||
强制函数定义中最多允许的参数数量 | |||
强制函数块最多允许的的语句数量 | |||
强制每一行中所允许的最大语句数量 | |||
强制对多行注释使用特定风格 | |||
要求或禁止在三元操作数中间换行 | |||
要求构造函数首字母大写 | |||
强制或禁止调用无参构造函数时有圆括号 | |||
要求方法链中每个调用都有一个换行符 | |||
禁用 | |||
禁用按位运算符 | |||
禁用 | |||
禁止在代码后使用内联注释 | |||
禁止 | |||
禁止混合使用不同的操作符 | |||
禁止空格和 tab 的混合缩进 | |||
禁止连续赋值 | |||
禁止出现多行空行 | |||
禁用否定的表达式 | |||
禁用嵌套的三元表达式 | |||
禁用 | |||
禁用一元操作符 | |||
禁用特定的语法 | |||
禁用 tab | |||
禁用三元操作符 | |||
禁用行尾空格 | |||
禁止标识符中有悬空下划线 | |||
禁止可以在有更简单的可替代的表达式时使用三元操作符 | |||
禁止属性前有空白 | |||
强制单个语句的位置 | |||
强制大括号内换行符的一致性 | |||
强制在大括号中使用一致的空格 | |||
强制将对象的属性放在不同的行上 | |||
强制函数中的变量要么一起声明要么分开声明 | |||
要求或禁止在变量声明周围换行 | |||
要求或禁止在可能的情况下使用简化的赋值操作符 | |||
强制操作符使用一致的换行符 | |||
要求或禁止块内填充 | |||
要求或禁止在语句间填充空行 | |||
禁止使用以对象字面量作为第一个参数的 Object.assign,优先使用对象扩展。 | |||
要求对象字面量属性名称用引号括起来 | |||
强制使用一致的反勾号、双引号或单引号 | |||
要求或禁止使用分号代替 ASI | |||
强制分号之前和之后使用一致的空格 | |||
强制分号的位置 | |||
要求对象属性按序排列 | |||
要求同一个声明块中的变量按顺序排列 | |||
强制在块之前使用一致的空格 | |||
强制在 | |||
强制在圆括号内使用一致的空格 | |||
要求操作符周围有空格 | |||
强制在一元操作符前后使用一致的空格 | |||
强制在注释中 | |||
强制在 switch 的冒号左右有空格 | |||
要求或禁止在模板标记和它们的字面量之间有空格 | |||
要求或禁止 Unicode 字节顺序标记 (BOM) | |||
要求正则表达式被括号括起来 |
ECMAScript 6
这些规则只与 ES6 有关, 即通常所说的 ES2015:
要求箭头函数体使用大括号 | |||
要求箭头函数的参数使用圆括号 | |||
强制箭头函数的箭头前后使用一致的空格 | |||
要求在构造函数中有 | |||
强制 generator 函数中 | |||
禁止修改类声明的变量 | |||
禁止在可能与比较操作符相混淆的地方使用箭头函数 | |||
禁止修改 | |||
禁止类成员中出现重复的名称 | |||
禁止重复模块导入 | |||
禁止 | |||
禁止使用指定的 | |||
禁止在构造函数中,在调用 | |||
禁止在对象中使用不必要的计算属性 | |||
禁用不必要的构造函数 | |||
禁止在 import 和 export 和解构赋值时将引用重命名为相同的名字 | |||
要求使用 | |||
要求或禁止对象字面量中方法和属性使用简写语法 | |||
要求回调函数使用箭头函数 | |||
要求使用 | |||
优先使用数组和对象解构 | |||
禁用 | |||
要求使用剩余参数而不是 | |||
要求使用扩展运算符而非 | |||
要求使用模板字面量而非字符串连接 | |||
要求 generator 函数内有 | |||
强制剩余和扩展运算符及其表达式之间有空格 | |||
强制模块内的 import 排序 | |||
要求 symbol 描述 | |||
要求或禁止模板字符串中的嵌入表达式周围空格的使用 | |||
强制在 |
Deprecated
Deprecated rule | Replaced by |
---|---|
(no replacement) | |
(no replacement) | |
(no replacement) |
Removed
These rules from older versions of ESLint (before the deprecation policy existed) have been replaced by newer rules:
Removed rule | Replaced by |
---|---|
- 中文文档同步自 eslint/cn.eslint.org 仓库