前言
最近在做一些CI的事情，整理了一些校验规则，记录一下避免忘记，当然以下的是基础规则设置，ts、js、vue、react也都有属于自己的规则
Eslint基础规则
0: 不校验; 1: warning; 2: error
| 规则 | 描述 | 默认 |
|---|---|---|
indent | 强制使用一致的缩进 | 四个空格; 2 |
quotes | 强制使用一致的反勾号、双引号或单引号 | 单引号; 2 |
no-mixed-spaces-and-tabs | 禁止空格和 tab 的混合缩进 | 2 |
jsx-quotes | 强制在 JSX 属性中一致地使用双引号或单引号 | prefer-single; 2 |
comma-dangle | 要求或禁止末尾逗号 | never; 2 |
no-dupe-keys | 禁止对象字面量中出现重复的 key | 2 |
no-eval | 禁用 eval() | 1 |
no-implied-eval | 禁止使用类似 eval() 的方法 | 2 |
no-with | 禁用 with 语句 | 2 |
no-redeclare | 禁止多次声明同一变量 | 2 |
no-undef | 禁用未声明的变量，除非它们在 /*global */ 注释中被提到 | 2 |
no-undef-init | 禁止将变量初始化为 undefined | 2 |
nprefer-const | 要求使用 const 声明那些声明后不再被修改的变量 | 1 |
no-debugger | 禁用 debugger | 生产环境: 2 开发环境: 0 |
no-console | 禁用 console | 生产环境: 2 开发环境: 0 |
accessor-pairs | 强制 getter 和 setter 在对象中成对出现 | 2 |
arrow-spacing | 强制箭头函数的箭头前后使用一致的空格 | 1 |
block-spacing | 禁止或强制在代码块中开括号前和闭括号后有空格 | always; 2 |
brace-style | 强制在代码块中使用一致的大括号风格 | 1tbs; 2 |
camelcase | 强制使用骆驼拼写法命名约定 | 0 |
comma-spacing | 强制在逗号前后使用一致的空格 | 2 |
comma-style | 强制使用一致的逗号风格 | 2 |
constructor-super | 要求在构造函数中有 super() 的调用 | 2 |
curly | 强制所有控制语句使用一致的括号风格 | 2 |
dot-location | 强制在点号之前和之后一致的换行 | 2 |
eol-last | 要求或禁止文件末尾存在空行 | 2 |
generator-star-spacing | 强制 generator 函数中 * 号周围使用一致的空格 | 2 |
handle-callback-err | 要求回调函数中有容错处理 | 0 |
key-spacing | 强制在对象字面量的属性中键和值之间使用一致的间距 | 2 |
keyword-spacing | 强制在关键字前后使用一致的空格 | 2 |
new-cap | 要求构造函数首字母大写 | 2 |
new-parens | 要求调用无参构造函数时有圆括号 | 2 |
no-array-constructor | 禁用 Array 构造函数 | 2 |
no-caller | 禁用 arguments.caller 或 arguments.callee | 2 |
no-class-assign | 禁止修改类声明的变量 | 2 |
no-cond-assign | 禁止条件表达式中出现赋值操作符 | 0 |
no-const-assign | 禁止修改 const 声明的变量 | 2 |
no-control-regex | 禁止在正则表达式中使用控制字符 | 2 |
no-delete-var | 禁止删除变量 | 2 |
no-dupe-args | 禁止 function 定义中出现重名参数 | 2 |
no-dupe-class-members | 禁止类成员中出现重复的名称 | 2 |
no-duplicate-case | 禁止出现重复的 case 标签 | 2 |
no-empty-character-class | 禁止在正则表达式中使用空字符集 | 2 |
no-empty-pattern | 禁止使用空解构模式 | 2 |
no-ex-assign | 禁止对 catch 子句的参数重新赋值 | 2 |
no-extend-native | 禁止扩展原生类型 | 2 |
no-extra-bind | 禁止不必要的 .bind() 调用 | 2 |
no-extra-boolean-cast | 禁止不必要的布尔转换 | 2 |
no-extra-parens | 禁止不必要的括号 | 2 |
no-fallthrough | 禁止 case 语句落空 | 2 |
no-floating-decimal | 禁止数字字面量中使用前导和末尾小数点 | 2 |
no-func-assign | 禁止对 function 声明重新赋值 | 2 |
no-inner-declarations | 禁止在嵌套的块中出现变量声明或 function 声明 | 2 |
no-invalid-regexp | 禁止 RegExp 构造函数中存在无效的正则表达式字符串 | 2 |
no-irregular-whitespace | 禁止在字符串和注释之外不规则的空白 | 2 |
no-iterator | 禁用 __iterator__ 属性 | 2 |
no-label-var | 不允许标签与变量同名 | 2 |
no-labels | 禁用标签语句 | 2 |
no-lone-blocks | 禁用不必要的嵌套块 | 2 |
no-multi-spaces | 禁止使用多个空格 | 2 |
no-multi-str | 禁止使用多行字符串 | 2 |
no-multiple-empty-lines | 禁止出现多行空行 | 2 |
no-global-assign | 禁止对原生对象或只读的全局对象进行赋值 | 2 |
no-unsafe-negation | 禁止对关系运算符的左操作数使用否定操作符 | 2 |
no-new-object | 禁用 Object 的构造函数 | 2 |
no-new-require | 禁止调用 require 时使用 new 操作符 | 2 |
no-new-symbol | 禁止 Symbolnew 操作符和 new 一起使用 | 2 |
no-new-wrappers | 禁止对 String，Number 和 Boolean 使用 new 操作符 | 2 |
no-obj-calls | 禁止把全局对象作为函数调用 | 2 |
no-octal | 禁用八进制字面量 | 2 |
no-octal-escape | 禁止在字符串中使用八进制转义序列 | 2 |
no-path-concat | 禁止对 __dirname 和 __filename 进行字符串连接 | 2 |
no-proto | 禁用 __proto__ 属性 | 2 |
no-regex-spaces | 禁止正则表达式字面量中出现多个空格 | 2 |
no-return-assign | 禁止在 return 语句中使用赋值语句 | 2 |
no-self-assign | 禁止自我赋值 | 2 |
no-self-compare | 禁止自身比较 | 2 |
no-sequences | 禁用逗号操作符 | 2 |
no-shadow-restricted-names | 禁止将标识符定义为受限的名字 | 2 |
func-call-spacing | 要求或禁止在函数标识符和其调用之间有空格 | 2 |
no-sparse-arrays | 禁用稀疏数组 | 2 |
no-this-before-super | 禁止在构造函数中，在调用 super() 之前使用 this 或 super | 2 |
no-throw-literal | 禁止抛出异常字面量 | 2 |
no-trailing-spaces | 禁用行尾空格 | 2 |
no-unexpected-multiline | 禁止出现令人困惑的多行表达式 | 2 |
no-unmodified-loop-condition | 禁用一成不变的循环条件 | 2 |
no-unneeded-ternary | 禁止可以在有更简单的可替代的表达式时使用三元操作符 | 2 |
no-unreachable | 禁止在return、throw、continue 和 break 语句之后出现不可达代码 | 2 |
no-unsafe-finally | 禁止在 finally 语句块中出现控制流语句 | 2 |
no-unused-vars | 禁止出现未使用过的变量 | 2 |
no-useless-call | 禁止不必要的 .call() 和 .apply() | 2 |
no-useless-computed-key | 禁止在对象中使用不必要的计算属性 | 2 |
no-useless-constructor | 禁用不必要的构造函数 | 2 |
no-useless-escape | 禁用不必要的转义字符 | 0 |
no-whitespace-before-property | 禁止属性前有空白 | 2 |
one-var | 强制函数中的变量要么一起声明要么分开声明 | 2 |
operator-linebreak | 强制操作符使用一致的换行符 | 2 |
padded-blocks | 要求或禁止块内填充 | 2 |
semi | 要求或禁止使用分号代替 ASI | 2 |
semi-spacing | 强制分号之前和之后使用一致的空格 | 2 |
space-before-blocks | 强制在块之前使用一致的空格 | 2 |
space-before-function-paren | 强制在 function 的左括号之前使用一致的空格 | 2 |
space-in-parens | 强制在圆括号内使用一致的空格 | 2 |
space-infix-ops | 要求操作符周围有空格 | 2 |
space-unary-ops | 强制在一元操作符前后使用一致的空格 | 2 |
spaced-comment | 强制在注释中 // 或 /* 使用一致的空格 | 2 |
template-curly-spacing | 要求或禁止模板字符串中的嵌入表达式周围空格的使用 | 2 |
use-isnan | 要求使用 isNaN() 检查 NaN | 2 |
valid-typeof | 强制 typeof 表达式与有效的字符串进行比较 | 2 |
wrap-iife | 要求 IIFE 使用括号括起来 | 2 |
yield-star-spacing | 强制在 yield* 表达式中 * 周围使用空格 | 2 |
yoda | 要求或禁止 “Yoda” 条件 | 2 |
object-curly-spacing | 强制在大括号中使用一致的空格 | 2 |
array-bracket-spacing | 强制数组方括号中使用一致的空格 | 2 |
规则配置方式
module.exports = {
'indent': [2, 4, {
'SwitchCase': 2 // case 子句将相对于 switch 语句缩进 2 个空格
}], // 强制使用一致的缩进
'quotes': [2, 'single', {
'avoidEscape': true,
'allowTemplateLiterals': true
}], // 强制使用一致的反勾号、双引号或单引号
'no-mixed-spaces-and-tabs': 2, // 禁止空格和 tab 的混合缩进
'jsx-quotes': [2, 'prefer-single'], // 强制在 JSX 属性中一致地使用双引号或单引号
'comma-dangle': [2, 'never'], // 要求或禁止末尾逗号
'no-dupe-keys': 2, // 禁止对象字面量中出现重复的 key
'no-eval': 1, // 禁用 eval()
'no-implied-eval': 2, // 禁止使用类似 eval() 的方法
'no-with': 2, // 禁用 with 语句
'no-redeclare': 2, // 禁止多次声明同一变量
'no-undef': 2, // 禁用未声明的变量，除非它们在 /*global */ 注释中被提到
'no-undef-init': 2, // 禁止将变量初始化为 undefined
'prefer-const': 1, // 要求使用 const 声明那些声明后不再被修改的变量
'no-debugger': process.env.NODE_ENV === 'production' ? 2 : 0, // 禁用 debugger
'no-console': process.env.NODE_ENV === 'production' ? 2 : 0, // 禁用 console
'accessor-pairs': 2, // 强制 getter 和 setter 在对象中成对出现
'arrow-spacing': [1, {
'before': true,
'after': true
}], // 强制箭头函数的箭头前后使用一致的空格
'block-spacing': [2, 'always'], // 禁止或强制在代码块中开括号前和闭括号后有空格
'brace-style': [2, '1tbs', {
'allowSingleLine': true // （默认 false) 允许块的开括号和闭括号在 同一行
}], // 强制在代码块中使用一致的大括号风格
'camelcase': [0, {
'properties': 'always' // (默认) 强制属性名称为驼峰风格
}], // 强制使用骆驼拼写法命名约定
'comma-spacing': [2, {
'before': false,
'after': true
}], // 强制在逗号前后使用一致的空格
'comma-style': [2, 'last'], // 强制使用一致的逗号风格
'constructor-super': 2, // 要求在构造函数中有 super() 的调用
'curly': [2, 'multi-line'], // 强制所有控制语句使用一致的括号风格
'dot-location': [2, 'property'], // 强制在点号之前和之后一致的换行
'eol-last': 2, // 要求或禁止文件末尾存在空行
'generator-star-spacing': [2, {
'before': true,
'after': true
}], // 强制 generator 函数中 * 号周围使用一致的空格
'handle-callback-err': [0, '^(err|error)$'], // 要求回调函数中有容错处理
'key-spacing': [2, {
'beforeColon': false,
'afterColon': true
}], // 强制在对象字面量的属性中键和值之间使用一致的间距
'keyword-spacing': [2, {
'before': true,
'after': true
}], // 强制在关键字前后使用一致的空格
'new-cap': [2, {
'newIsCap': true, // (默认true) 要求调用 new 操作符时有首字母大小的函数
'capIsNew': false // 允许调用首字母大写的函数时没有 new 操作符
}], // 要求构造函数首字母大写
'new-parens': 2, // 要求调用无参构造函数时有圆括号
'no-array-constructor': 2, // 禁用 Array 构造函数
'no-caller': 2, // 禁用 arguments.caller 或 arguments.callee
'no-class-assign': 2, // 禁止修改类声明的变量
'no-cond-assign': 0, // 禁止条件表达式中出现赋值操作符
'no-const-assign': 2, // 禁止修改 const 声明的变量
'no-control-regex': 2, // 禁止在正则表达式中使用控制字符
'no-delete-var': 2, // 禁止删除变量
'no-dupe-args': 2, // 禁止 function 定义中出现重名参数
'no-dupe-class-members': 2, // 禁止类成员中出现重复的名称
'no-duplicate-case': 2, // 禁止出现重复的 case 标签
'no-empty-character-class': 2, // 禁止在正则表达式中使用空字符集
'no-empty-pattern': 2, // 禁止使用空解构模式
'no-ex-assign': 2, // 禁止对 catch 子句的参数重新赋值
'no-extend-native': 2, // 禁止扩展原生类型
'no-extra-bind': 2, // 禁止不必要的 .bind() 调用
'no-extra-boolean-cast': 2, // 禁止不必要的布尔转换
'no-extra-parens': [2, 'functions'], // 禁止不必要的括号
'no-fallthrough': 2, // 禁止 case 语句落空
'no-floating-decimal': 2, // 禁止数字字面量中使用前导和末尾小数点
'no-func-assign': 2, // 禁止对 function 声明重新赋值
'no-inner-declarations': [2, 'functions'], // 禁止在嵌套的块中出现变量声明或 function 声明
'no-invalid-regexp': 2, // 禁止 RegExp 构造函数中存在无效的正则表达式字符串
'no-irregular-whitespace': 2, // 禁止在字符串和注释之外不规则的空白
'no-iterator': 2, // 禁用 __iterator__ 属性
'no-label-var': 2, // 不允许标签与变量同名
'no-labels': [2, {
'allowLoop': false,
'allowSwitch': false
}], // 禁用标签语句
'no-lone-blocks': 2, // 禁用不必要的嵌套块
'no-multi-spaces': 2, // 禁止使用多个空格
'no-multi-str': 2, // 禁止使用多行字符串
'no-multiple-empty-lines': [2, {
'max': 1
}], // 禁止出现多行空行
'no-global-assign': 2, // 禁止对原生对象或只读的全局对象进行赋值
'no-unsafe-negation': 2, // 禁止对关系运算符的左操作数使用否定操作符
'no-new-object': 2, // 禁用 Object 的构造函数
'no-new-require': 2, // 禁止调用 require 时使用 new 操作符
'no-new-symbol': 2, // 禁止 Symbolnew 操作符和 new 一起使用
'no-new-wrappers': 2, // 禁止对 String，Number 和 Boolean 使用 new 操作符
'no-obj-calls': 2, // 禁止把全局对象作为函数调用
'no-octal': 2, // 禁用八进制字面量
'no-octal-escape': 2, // 禁止在字符串中使用八进制转义序列
'no-path-concat': 2, // 禁止对 __dirname 和 __filename 进行字符串连接
'no-proto': 2, // 禁用 __proto__ 属性
'no-regex-spaces': 2, // 禁止正则表达式字面量中出现多个空格
'no-return-assign': [2, 'except-parens'], // 禁止在 return 语句中使用赋值语句
'no-self-assign': 2, // 禁止自我赋值
'no-self-compare': 2, // 禁止自身比较
'no-sequences': 2, // 禁用逗号操作符
'no-shadow-restricted-names': 2, // 禁止将标识符定义为受限的名字
'func-call-spacing': 2, // 要求或禁止在函数标识符和其调用之间有空格
'no-sparse-arrays': 2, // 禁用稀疏数组
'no-this-before-super': 2, // 禁止在构造函数中，在调用 super() 之前使用 this 或 super
'no-throw-literal': 2, // 禁止抛出异常字面量
'no-trailing-spaces': 2, // 禁用行尾空格
'no-unexpected-multiline': 2, // 禁止出现令人困惑的多行表达式
'no-unmodified-loop-condition': 2, // 禁用一成不变的循环条件
'no-unneeded-ternary': [2, {
'defaultAssignment': false
}], // 禁止可以在有更简单的可替代的表达式时使用三元操作符
'no-unreachable': 2, // 禁止在return、throw、continue 和 break 语句之后出现不可达代码
'no-unsafe-finally': 2, // 禁止在 finally 语句块中出现控制流语句
'no-unused-vars': [2, {
'args': 'none'
}], // 禁止出现未使用过的变量
'no-useless-call': 2, // 禁止不必要的 .call() 和 .apply()
'no-useless-computed-key': 2, // 禁止在对象中使用不必要的计算属性
'no-useless-constructor': 2, // 禁用不必要的构造函数
'no-useless-escape': 0, // 禁用不必要的转义字符
'no-whitespace-before-property': 2, // 禁止属性前有空白
'one-var': [2, {
'initialized': 'never'
}], // 强制函数中的变量要么一起声明要么分开声明
'operator-linebreak': [2, 'after', {
'overrides': {
'?': 'before',
':': 'before'
}
}], // 强制操作符使用一致的换行符
'padded-blocks': [2, 'never'], // 要求或禁止块内填充
'semi': [2, 'always'], // 要求或禁止使用分号代替 ASI
'semi-spacing': [2, {
'before': false,
'after': true
}], // 强制分号之前和之后使用一致的空格
'space-before-blocks': [2, 'always'], // 强制在块之前使用一致的空格
'space-before-function-paren': [2, 'never'], // 强制在 function的左括号之前使用一致的空格
'space-in-parens': [2, 'never'], // 强制在圆括号内使用一致的空格
'space-infix-ops': 2, // 要求操作符周围有空格
'space-unary-ops': [2, {
'words': true,
'nonwords': false
}], // 强制在一元操作符前后使用一致的空格
'spaced-comment': [2, 'always', {
'markers': ['global', 'globals', 'eslint', 'eslint-disable', '*package', '!', ',']
}], // 强制在注释中 // 或 /* 使用一致的空格
'template-curly-spacing': [2, 'never'], // 要求或禁止模板字符串中的嵌入表达式周围空格的使用
'use-isnan': 2, // 要求使用 isNaN() 检查 NaN
'valid-typeof': 2, // 强制 typeof 表达式与有效的字符串进行比较
'wrap-iife': [2, 'any'], // 要求 IIFE 使用括号括起来
'yield-star-spacing': [2, 'both'], // 强制在 yield* 表达式中 * 周围使用空格
'yoda': [2, 'never'], // 要求或禁止 “Yoda” 条件
'object-curly-spacing': [2, 'always', {
objectsInObjects: false
}], // 强制在大括号中使用一致的空格
'array-bracket-spacing': [2, 'never'] // 强制数组方括号中使用一致的空格
}
