开发代码规范文档

代码规范是程序员的根本,入门第一步,从规范代码开始。

ESLint 就是一款专门用于 Javascript/ESscript 代码一致性的“插件”,基于 node.js,或者你可以看做是项目构建系统的一部分。它根本目的是统一项目的代码风格规范,养成规范的写代码习惯,减少不必要的错误和隐患。

所以项目中引入并配置了相关的代码规范约定,用来统一代码风格和规范团队协作开发。

配置文件官方说明,点这里

  1. extends 继承官方推荐的规则
  2. 确定规则使用的环境(可略)
  3. parserOptions 属性配置,一般用于支持 es6
  4. parser,globals,plugins 都可略
  5. 最重要的是”rule”属性,配置了我们需要的具体规则

ESLint 附带有大量的规则。你可以使用注释或配置文件修改你项目中要使用的规则。

其中 rules 就是配置规则的

1
2
3
rules: {
"规则名": [规则值, 规则配置]
}

规则值:

1
2
3
"off"0    // 关闭规则
"warn"1 // 开启规则,使用警告级别的错误:warn (不会导致程序退出)
"error"2 // 开启规则,使用错误级别的错误:error (当被触发的时候,程序会退出)

官方默认规则: 点这里

下面是 tinyweb 规则,供参考(也可针对项目的不同,修改规则)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
'rules': {
'accessor-pairs': 2, // 强制 getter 和 setter 在对象中成对出现
'arrow-spacing': [2, { // 强制箭头函数的箭头前后使用一致的空格
'before': true,
'after': true
}],
'block-spacing': [2, 'always'], // 禁止或强制在代码块中开括号前和闭括号后有空格
'brace-style': [2, '1tbs', { // 强制在代码块中使用一致的大括号风格
'allowSingleLine': true
}],
'camelcase': [0, { // 强制使用骆驼拼写法命名约定
'properties': 'always'
}],
'comma-dangle': [2, 'never'], // 要求或禁止末尾逗号
'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': 0, // 要求或禁止文件末尾存在空行
'eqeqeq': [2, 'allow-null'], // 要求使用 === 和 !==
'generator-star-spacing': [2, { // 强制 generator 函数中 * 号周围使用一致的空格
'before': true,
'after': true
}],
'handle-callback-err': [2, '^(err|error)$'], // 要求回调函数中有容错处理
'indent': [0, 2, { // 强制使用一致的缩进
'SwitchCase': 1
}],
'jsx-quotes': [2, 'prefer-single'], // 强制在 JSX 属性中一致地使用双引号或单引号
'key-spacing': [2, { // 强制在对象字面量的属性中键和值之间使用一致的间距
'beforeColon': false,
'afterColon': true
}],
'keyword-spacing': [2, { // 强制在关键字前后使用一致的空格
'before': true,
'after': true
}],
'new-cap': [2, { // 要求构造函数首字母大写
'newIsCap': true,
'capIsNew': false
}],
'new-parens': 2, // 要求调用无参构造函数时有圆括号
'no-array-constructor': 2, // 禁用 Array 构造函数
'no-caller': 2, // 禁用 arguments.caller 或 arguments.callee
'no-console': 'off', // 禁用 console
'no-class-assign': 2, // 禁止修改类声明的变量
'no-cond-assign': 2, // 禁止条件表达式中出现赋值操作符
'no-const-assign': 2, // 禁止修改 const 声明的变量
'no-control-regex': 0, // 禁止在正则表达式中使用控制字符
'no-delete-var': 2, // 禁止删除变量
'no-dupe-args': 2, // 禁止 function 定义中出现重名参数
'no-dupe-class-members': 2, // 禁止类成员中出现重复的名称
'no-dupe-keys': 2, // 禁止对象字面量中出现重复的 key
'no-duplicate-case': 2, // 禁止出现重复的 case 标签
'no-empty-character-class': 2, // 禁止在正则表达式中使用空字符集
'no-empty-pattern': 2, // 禁止使用空解构模式
'no-eval': 2, // 禁用 eval()
'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-implied-eval': 2, // 禁止使用类似 eval() 的方法
'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-mixed-spaces-and-tabs': 2, // 禁止空格和 tab 的混合缩进
'no-multi-spaces': 2, // 禁止使用多个空格
'no-multi-str': 2, // 禁止使用多行字符串
'no-multiple-empty-lines': [2, { // 禁止出现多行空行
'max': 1
}],
'no-native-reassign': 2,
'no-negated-in-lhs': 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-redeclare': 2, // 禁止多次声明同一变量
'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, // 禁止将标识符定义为受限的名字
'no-spaced-func': 0,
'no-sparse-arrays': 2, // 禁用稀疏数组
'no-this-before-super': 2, // 禁止在构造函数中,在调用 super() 之前使用 this 或 super
'no-throw-literal': 2, // 禁止抛出异常字面量
'no-trailing-spaces': 2, // 禁用行尾空格
'no-undef': 0, // 禁用未声明的变量,除非它们在 /*global */ 注释中被提到
'no-undef-init': 2, // 禁止将变量初始化为 undefined
'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, { // 禁止出现未使用过的变量
'vars': 'all',
'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, // 禁止属性前有空白
'no-with': 2, // 禁用 with 语句
'one-var': [2, { // 强制函数中的变量要么一起声明要么分开声明
'initialized': 'never'
}],
'operator-linebreak': [2, 'after', { // 强制操作符使用一致的换行符
'overrides': {
'?': 'before',
':': 'before'
}
}],
'padded-blocks': [2, 'never'], // 要求或禁止块内填充
'quotes': [2, 'single', { // 强制使用一致的反勾号、双引号或单引号
'avoidEscape': true,
'allowTemplateLiterals': true
}],
'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” 条件
'prefer-const': 2, // 要求使用 const 声明那些声明后不再被修改的变量
'no-debugger': process.env.NODE_ENV === 'production' ? 2 : 0, // 禁用 debugger
'object-curly-spacing': [2, 'always', { // 强制在大括号中使用一致的空格
objectsInObjects: false
}],
'array-bracket-spacing': [2, 'never'] // 强制数组方括号中使用一致的空格
}
}