Rules
为了让你对规则有个更好的理解,ESLint 对其进行了分门别类。
所有的规则默认都是禁用的。在配置文件中,使用 "extends": "eslint:recommended"
来启用推荐的规则,报告一些常见的问题,在下文中这些推荐的规则都带有一个标记。
命令行的 --fix
选项用来自动修复规则所报告的问题(目前,大部分是对空白的修复),在下文中会有一个的图标。
Possible Errors
这些规则与 JavaScript 代码中可能的错误或逻辑错误有关:
for-direction |
enforce “for” loop update clause moving the counter in the right direction. |
||
no-await-in-loop |
disallow |
||
no-compare-neg-zero |
disallow comparing against -0 |
||
no-cond-assign |
禁止条件表达式中出现赋值操作符 |
||
no-console |
禁用 |
||
no-constant-condition |
禁止在条件中使用常量表达式 |
||
no-control-regex |
禁止在正则表达式中使用控制字符 |
||
no-debugger |
禁用 |
||
no-dupe-args |
禁止 |
||
no-dupe-keys |
禁止对象字面量中出现重复的 key |
||
no-duplicate-case |
禁止出现重复的 case 标签 |
||
no-empty |
禁止出现空语句块 |
||
no-empty-character-class |
禁止在正则表达式中使用空字符集 |
||
no-ex-assign |
禁止对 |
||
no-extra-boolean-cast |
禁止不必要的布尔转换 |
||
no-extra-parens |
禁止不必要的括号 |
||
no-extra-semi |
禁止不必要的分号 |
||
no-func-assign |
禁止对 |
||
no-inner-declarations |
禁止在嵌套的块中出现变量声明或 |
||
no-invalid-regexp |
禁止 |
||
no-irregular-whitespace |
禁止在字符串和注释之外不规则的空白 |
||
no-obj-calls |
禁止把全局对象作为函数调用 |
||
no-prototype-builtins |
禁止直接调用 |
||
no-regex-spaces |
禁止正则表达式字面量中出现多个空格 |
||
no-sparse-arrays |
禁用稀疏数组 |
||
no-template-curly-in-string |
disallow template literal placeholder syntax in regular strings |
||
no-unexpected-multiline |
禁止出现令人困惑的多行表达式 |
||
no-unreachable |
禁止在 |
||
no-unsafe-finally |
禁止在 |
||
no-unsafe-negation |
disallow negating the left operand of relational operators |
||
use-isnan |
要求使用 |
||
valid-jsdoc |
强制使用有效的 JSDoc 注释 |
||
valid-typeof |
强制 |
Best Practices
这些规则是关于最佳实践的,帮助你避免一些问题:
accessor-pairs |
强制 getter 和 setter 在对象中成对出现 |
||
array-callback-return |
强制数组方法的回调函数中有 |
||
block-scoped-var |
强制把变量的使用限制在其定义的作用域范围内 |
||
class-methods-use-this |
enforce that class methods utilize |
||
complexity |
指定程序中允许的最大环路复杂度 |
||
consistent-return |
要求 |
||
curly |
强制所有控制语句使用一致的括号风格 |
||
default-case |
要求 |
||
dot-location |
强制在点号之前和之后一致的换行 |
||
dot-notation |
强制尽可能地使用点号 |
||
eqeqeq |
要求使用 |
||
guard-for-in |
要求 |
||
no-alert |
禁用 |
||
no-caller |
禁用 |
||
no-case-declarations |
不允许在 case 子句中使用词法声明 |
||
no-div-regex |
禁止除法操作符显式的出现在正则表达式开始的位置 |
||
no-else-return |
禁止 |
||
no-empty-function |
禁止出现空函数 |
||
no-empty-pattern |
禁止使用空解构模式 |
||
no-eq-null |
禁止在没有类型检查操作符的情况下与 |
||
no-eval |
禁用 |
||
no-extend-native |
禁止扩展原生类型 |
||
no-extra-bind |
禁止不必要的 |
||
no-extra-label |
禁用不必要的标签 |
||
no-fallthrough |
禁止 |
||
no-floating-decimal |
禁止数字字面量中使用前导和末尾小数点 |
||
no-global-assign |
disallow assignments to native objects or read-only global variables |
||
no-implicit-coercion |
禁止使用短符号进行类型转换 |
||
no-implicit-globals |
禁止在全局范围内使用变量声明和 |
||
no-implied-eval |
禁止使用类似 |
||
no-invalid-this |
禁止 |
||
no-iterator |
禁用 |
||
no-labels |
禁用标签语句 |
||
no-lone-blocks |
禁用不必要的嵌套块 |
||
no-loop-func |
禁止在循环中出现 |
||
no-magic-numbers |
禁用魔术数字 |
||
no-multi-spaces |
禁止使用多个空格 |
||
no-multi-str |
禁止使用多行字符串 |
||
no-new |
disallow |
||
no-new-func |
禁止对 |
||
no-new-wrappers |
禁止对 |
||
no-octal |
禁用八进制字面量 |
||
no-octal-escape |
禁止在字符串中使用八进制转义序列 |
||
no-param-reassign |
禁止对 |
||
no-proto |
禁用 |
||
no-redeclare |
禁止多次声明同一变量 |
||
no-restricted-properties |
disallow certain properties on certain objects |
||
no-return-assign |
禁止在 |
||
no-return-await |
disallow unnecessary |
||
no-script-url |
禁止使用 |
||
no-self-assign |
禁止自我赋值 |
||
no-self-compare |
禁止自身比较 |
||
no-sequences |
禁用逗号操作符 |
||
no-throw-literal |
禁止抛出异常字面量 |
||
no-unmodified-loop-condition |
禁用一成不变的循环条件 |
||
no-unused-expressions |
禁止出现未使用过的表达式 |
||
no-unused-labels |
禁用出现未使用过的标 |
||
no-useless-call |
禁止不必要的 |
||
no-useless-concat |
禁止不必要的字符串字面量或模板字面量的连接 |
||
no-useless-escape |
禁用不必要的转义字符 |
||
no-useless-return |
disallow redundant return statements |
||
no-void |
禁用 |
||
no-warning-comments |
禁止在注释中使用特定的警告术语 |
||
no-with |
禁用 |
||
prefer-promise-reject-errors |
require using Error objects as Promise rejection reasons |
||
radix |
强制在 |
||
require-await |
disallow async functions which have no |
||
vars-on-top |
要求所有的 |
||
wrap-iife |
要求 IIFE 使用括号括起来 |
||
yoda |
要求或禁止 “Yoda” 条件 |
Strict Mode
该规则与使用严格模式和严格模式指令有关:
strict |
要求或禁止使用严格模式指令 |
Variables
这些规则与变量声明有关:
init-declarations |
要求或禁止 |
||
no-catch-shadow |
禁止 |
||
no-delete-var |
禁止删除变量 |
||
no-label-var |
不允许标签与变量同名 |
||
no-restricted-globals |
禁用特定的全局变量 |
||
no-shadow |
禁止变量声明与外层作用域的变量同名 |
||
no-shadow-restricted-names |
禁止将标识符定义为受限的名字 |
||
no-undef |
禁用未声明的变量,除非它们在 |
||
no-undef-init |
disallow initializing variables to |
||
no-undefined |
禁止将 |
||
no-unused-vars |
禁止出现未使用过的变量 |
||
no-use-before-define |
禁止在变量定义之前使用它们 |
Node.js and CommonJS
这些规则是关于Node.js 或 在浏览器中使用CommonJS 的:
callback-return |
require |
||
global-require |
要求 |
||
handle-callback-err |
要求回调函数中有容错处理 |
||
no-buffer-constructor |
|||
no-mixed-requires |
禁止混合常规变量声明和 |
||
no-new-require |
禁止调用 |
||
no-path-concat |
禁止对 |
||
no-process-env |
禁用 |
||
no-process-exit |
禁用 |
||
no-restricted-modules |
禁用通过 |
||
no-sync |
禁用同步方法 |
Stylistic Issues
这些规则是关于风格指南的,而且是非常主观的:
array-bracket-newline |
enforce linebreaks after opening and before closing array brackets |
||
array-bracket-spacing |
强制数组方括号中使用一致的空格 |
||
array-element-newline |
enforce line breaks after each array element |
||
block-spacing |
强制在单行代码块中使用一致的空格 |
||
brace-style |
强制在代码块中使用一致的大括号风格 |
||
camelcase |
强制使用骆驼拼写法命名约定 |
||
capitalized-comments |
enforce or disallow capitalization of the first letter of a comment |
||
comma-dangle |
要求或禁止末尾逗号 |
||
comma-spacing |
强制在逗号前后使用一致的空格 |
||
comma-style |
强制使用一致的逗号风格 |
||
computed-property-spacing |
强制在计算的属性的方括号中使用一致的空格 |
||
consistent-this |
当获取当前执行环境的上下文时,强制使用一致的命名 |
||
eol-last |
要求或禁止文件末尾存在空行 |
||
func-call-spacing |
require or disallow spacing between function identifiers and their invocations |
||
func-name-matching |
require function names to match the name of the variable or property to which they are assigned |
||
func-names |
要求或禁止使用命名的 |
||
func-style |
强制一致地使用 |
||
id-blacklist |
禁用指定的标识符 |
||
id-length |
强制标识符的最小和最大长度 |
||
id-match |
要求标识符匹配一个指定的正则表达式 |
||
indent |
强制使用一致的缩进 |
||
jsx-quotes |
强制在 JSX 属性中一致地使用双引号或单引号 |
||
key-spacing |
强制在对象字面量的属性中键和值之间使用一致的间距 |
||
keyword-spacing |
强制在关键字前后使用一致的空格 |
||
line-comment-position |
enforce position of line comments |
||
linebreak-style |
强制使用一致的换行风格 |
||
lines-around-comment |
要求在注释周围有空行 |
||
max-depth |
强制可嵌套的块的最大深度 |
||
max-len |
强制一行的最大长度 |
||
max-lines |
强制最大行数 |
||
max-nested-callbacks |
强制回调函数最大嵌套深度 |
||
max-params |
强制函数定义中最多允许的参数数量 |
||
max-statements |
强制函数块最多允许的的语句数量 |
||
max-statements-per-line |
强制每一行中所允许的最大语句数量 |
||
multiline-ternary |
enforce newlines between operands of ternary expressions |
||
new-cap |
要求构造函数首字母大写 |
||
new-parens |
要求调用无参构造函数时有圆括号 |
||
newline-per-chained-call |
要求方法链中每个调用都有一个换行符 |
||
no-array-constructor |
禁用 |
||
no-bitwise |
禁用按位运算符 |
||
no-continue |
禁用 |
||
no-inline-comments |
禁止在代码后使用内联注释 |
||
no-lonely-if |
禁止 |
||
no-mixed-operators |
禁止混合使用不同的操作符 |
||
no-mixed-spaces-and-tabs |
禁止空格和 tab 的混合缩进 |
||
no-multi-assign |
disallow use of chained assignment expressions |
||
no-multiple-empty-lines |
禁止出现多行空行 |
||
no-negated-condition |
禁用否定的表达式 |
||
no-nested-ternary |
禁用嵌套的三元表达式 |
||
no-new-object |
禁用 |
||
no-plusplus |
禁用一元操作符 |
||
no-restricted-syntax |
禁用特定的语法 |
||
no-tabs |
disallow all tabs |
||
no-ternary |
禁用三元操作符 |
||
no-trailing-spaces |
禁用行尾空格 |
||
no-underscore-dangle |
禁止标识符中有悬空下划线 |
||
no-unneeded-ternary |
禁止可以在有更简单的可替代的表达式时使用三元操作符 |
||
no-whitespace-before-property |
禁止属性前有空白 |
||
nonblock-statement-body-position |
enforce the location of single-line statements |
||
object-curly-newline |
强制大括号内换行符的一致性 |
||
object-curly-spacing |
强制在大括号中使用一致的空格 |
||
object-property-newline |
强制将对象的属性放在不同的行上 |
||
one-var |
强制函数中的变量要么一起声明要么分开声明 |
||
one-var-declaration-per-line |
require or disallow newlines around variable declarations |
||
operator-assignment |
要求或禁止在可能的情况下使用简化的赋值操作符 |
||
operator-linebreak |
强制操作符使用一致的换行符 |
||
padded-blocks |
要求或禁止块内填充 |
||
padding-line-between-statements |
require or disallow padding lines between statements |
||
quote-props |
要求对象字面量属性名称用引号括起来 |
||
quotes |
强制使用一致的反勾号、双引号或单引号 |
||
require-jsdoc |
要求使用 JSDoc 注释 |
||
semi |
require or disallow semicolons instead of ASI |
||
semi-spacing |
强制分号之前和之后使用一致的空格 |
||
semi-style |
强制分号的位置 |
||
sort-keys |
require object keys to be sorted |
||
sort-vars |
要求同一个声明块中的变量按顺序排列 |
||
space-before-blocks |
强制在块之前使用一致的空格 |
||
space-before-function-paren |
强制在 |
||
space-in-parens |
强制在圆括号内使用一致的空格 |
||
space-infix-ops |
要求操作符周围有空格 |
||
space-unary-ops |
强制在一元操作符前后使用一致的空格 |
||
spaced-comment |
强制在注释中 |
||
switch-colon-spacing |
enforce spacing around colons of switch statements |
||
template-tag-spacing |
require or disallow spacing between template tags and their literals |
||
unicode-bom |
要求或禁止 Unicode 字节顺序标记 (BOM) |
||
wrap-regex |
要求正则表达式被括号括起来 |
ECMAScript 6
这些规则只与 ES6 有关, 即通常所说的 ES2015:
arrow-body-style |
要求箭头函数体使用大括号 |
||
arrow-parens |
要求箭头函数的参数使用圆括号 |
||
arrow-spacing |
强制箭头函数的箭头前后使用一致的空格 |
||
constructor-super |
要求在构造函数中有 |
||
generator-star-spacing |
强制 generator 函数中 |
||
no-class-assign |
禁止修改类声明的变量 |
||
no-confusing-arrow |
disallow arrow functions where they could be confused with comparisons |
||
no-const-assign |
禁止修改 |
||
no-dupe-class-members |
禁止类成员中出现重复的名称 |
||
no-duplicate-imports |
disallow duplicate module imports |
||
no-new-symbol |
disallow |
||
no-restricted-imports |
disallow specified modules when loaded by |
||
no-this-before-super |
禁止在构造函数中,在调用 |
||
no-useless-computed-key |
disallow unnecessary computed property keys in object literals |
||
no-useless-constructor |
禁用不必要的构造函数 |
||
no-useless-rename |
disallow renaming import, export, and destructured assignments to the same name |
||
no-var |
要求使用 |
||
object-shorthand |
要求或禁止对象字面量中方法和属性使用简写语法 |
||
prefer-arrow-callback |
要求使用箭头函数作为回调 |
||
prefer-const |
要求使用 |
||
prefer-destructuring |
require destructuring from arrays and/or objects |
||
prefer-numeric-literals |
disallow |
||
prefer-rest-params |
require rest parameters instead of |
||
prefer-spread |
要求使用扩展运算符而非 |
||
prefer-template |
要求使用模板字面量而非字符串连接 |
||
require-yield |
要求 generator 函数内有 |
||
rest-spread-spacing |
enforce spacing between rest and spread operators and their expressions |
||
sort-imports |
强制模块内的 import 排序 |
||
symbol-description |
require symbol descriptions |
||
template-curly-spacing |
要求或禁止模板字符串中的嵌入表达式周围空格的使用 |
||
yield-star-spacing |
强制在 |
Deprecated
Deprecated rule | Replaced by |
---|---|
indent-legacy |
indent |
lines-around-directive |
padding-line-between-statements |
newline-after-var |
padding-line-between-statements |
newline-before-return |
padding-line-between-statements |
no-native-reassign |
no-global-assign |
no-negated-in-lhs |
no-unsafe-negation |
no-spaced-func |
func-call-spacing |
prefer-reflect |
(no replacement) |