- camelcase
- func-names
- func-style
- id-blacklist
- id-length
- line-comment-position
- linebreak-style
- lines-between-class-members
- max-depth
- max-lines
- max-lines-per-function
- max-nested-callbacks
- max-params
- max-statements-per-line
- new-cap
- no-array-constructor
- no-bitwise
- no-continue
- no-inline-comments
- no-lonely-if
- no-multi-assign
- no-negated-condition
- no-nested-ternary
- no-new-object
- no-plusplus
- no-restricted-syntax
- no-underscore-dangle
- no-unneeded-ternary
- one-var
- operator-assignment
- spaced-comment
-
规则含义
变量命名要求驼峰式
检查变量是否中间有_, 有的话报错
-
规则含义
禁止出现匿名函数
-
规则原因
为了更好的debug和定位错误
-
规则含义
强制使用函数表达式,不要用函数声明
-
规则原因
- 函数声明会悬置，在块作用域下根据strict模式有不同的表现，可以重新分配索引，这都是错误的隐患
- 不利于重构：因为函数声明可以悬置，一般把它放到运行代码的下面，看不到就不会去重构。如果使用表达式，强制你先定义,后使用，
这样在读代码的时候,会先读到定义函数的代码,
如果他很大很复杂,你会有欲望把它重构或把他提取出
一个模块,因为太碍事了
-
规则含义
变量黑名单,禁止使用data,e,cb,callback
-
规则原因
这些变量名降低可读性
-
规则含义
变量名长度在2到20之间
-
规则原因
非常短的变量名和非常长的变量名会让程序难以阅读和维护
-
规则含义
强制要求单行注释必须在代码上方
-
规则含义
强制要求换行必须是unix的\n
-
规则原因
为了统一unix和windows下的源代码
因为有的时候你在linux下读文件然后进行匹配end换行start字符如下：
/end.\nstart/
在windows下这段代码可能就不正确了，因为换行是\r\n
保持一致，减少出错几率
-
规则含义
要求类方法之间必须有空格分割
-
规则原因
提高可读性
-
规则含义
代码嵌套最多5层
-
规则原因
过深的嵌套降低可读性
-
规则含义
文件去除空行和注释行的行数<=300
-
规则原因
过大的文件说明功能不止一个,不利于维护
鼓励重构成多个小文件 单一职责原则
-
规则含义
函数去除注释和空行的行数<=50
-
规则原因
理由同max-lines
-
规则含义
回调函数嵌套数<=3
-
规则原因
降低可读性，使用promise或async
-
规则含义
函数参数个数<=3
-
规则原因
- 函数参数越多，这个函数就越难读懂，测试就越复杂
- 参数多，也说明函数做了不止一件事，鼓励让函数只做一件事，对函数进行重构
-
规则含义
一行只允许写一个执行语句
-
规则原因
一行写太多内容降低可读性
-
错误例子
var bar; var baz; if (condition) { bar = 1; }
-
规则含义
所有用new创建的函数,类,首字母大写
-
规则原因
类首字母大写
-
规则含义
不允许直接调用Array创建数组,使用new Array
-
规则原因
Array全局可能被更改引用
-
规则含义
禁止使用按位运算符|
-
规则原因
前端很少使用bit运算符（除了面试可能）
用的时候一般都是||忘了敲一个|
-
规则含义
禁止使用continue
-
规则原因
降低代码可读性，不易debug
-
规则含义
禁止注释和代码放到同一行
-
规则含义
禁止if语句是else语句中的唯一语句
-
规则含义
禁止使用链式分配 a = b = c
-
规则原因
会造成意外的全局变量
function x() {
var a = b = c = 5;
}
x()
console.log(b) -
错误例子
var a = b = c = 5; -
正确例子
const a = 5; const b = 5; const c = 5;
-
规则含义
禁止在if else和三目运算符中的判断条件出现否定表达(
! !=) -
规则原因
否定句式降低可读性：
下面第一种比第二种更难以理解
if (!notHigh) else {}
if (low) else {} -
错误例子
if (!a) { doSomething(); } else { doSomethingElse(); } if (a != b) { doSomething(); } else { doSomethingElse(); } !a ? c : b
-
规则含义
禁止嵌套三目运算符
-
规则原因
降低可读性
-
错误例子
var thing = foo ? bar : baz === qux ? quxx : foobar; foo ? baz === qux ? quxx() : foobar() : bar();
-
规则含义
使用字面量创建新对象,不要用new Object
-
规则原因
更简洁，少敲代码
-
错误例子
var myObject = new Object(); -
正确例子
var myObject = {};
-
规则含义
不允许使用自增减一元运算符
-
规则原因
++--会影响asi行为。
asi规定：当本行除了换行符和空白外只有++或--，那么换行符不自动插入\n
所以：
var i = 10;
var j = 20;
i
++
j
//等价于 i;++j; i = 10, j = 21 -
错误例子
i++ -
正确例子
i += 1; i -= 1
-
规则含义
禁止使用for in,with,label语法
-
规则原因
for..in遍历原型链，容易出错
label和with容易混淆
-
规则含义
禁止使用悬挂下划线(第一个字母是_)
-
规则原因
悬挂下划线一般表示私有成员
但是变量的含义应该通过名称来表示而不是约定符号，这样降低可读性
-
规则含义
禁止使用无效的三目运算符
-
错误例子
var isYes = answer === 1 ? true : false; -
正确例子
var isYes = answer === 1;
-
规则含义
一个声明符只声明一个变量
-
规则原因
一个声明符声明多个的坏处是：
- 添加新变量的时需要费心在哪个位置添加：在中间，需要添加逗号。在底部必须更改之前最后一个变量的;变成,否则会产生意外的全局变量.
- debug时候一次跳到声明结束，没法对每一个声明语句debug。
-
错误例子
let a,b,c -
正确例子
let a; let b; let c;
-
规则含义
尽可能使用简写赋值运算符 +=
-
规则原因
更简洁
-
错误例子
x = x + y -
正确例子
x += y;
-
规则含义
要求注释开头空一格