JavaScript 规范
前言
JavaScript 在前端一直有着广泛的应用,特别是在浏览器端的行为管理。本文档的目标是使 JavaScript 代码风格保持一致,容易被理解和被维护。
虽然本文档是针对 JavaScript 设计的,但是在使用各种 JavaScript 的预编译语言时(如 TypeScript 等)时,适用的部分也应尽量遵循本文档的约定。
代码文件
- JavaScript 文件使用无
BOM
的UTF-8
编码 - 在文件结尾处,保留一个空行
更加详细的编辑器及代码文件推荐传送门open in new window
细则
使用两个空格进行缩进。
eslint:
indent
open in new windowfunction hello (name) { console.log('hi', name) }
1
2
3除需要转义的情况外,字符串统一使用单引号。
eslint:
quotes
open in new windowconsole.log('hello there') $("<div class='box'>")
1
2不要定义未使用的变量。
eslint:
no-unused-vars
open in new windowfunction myFunction () { var result = something() // ✗ avoid }
1
2
3关键字后面加空格。
eslint:
keyword-spacing
open in new windowif (condition) { ... } // ✓ ok if(condition) { ... } // ✗ avoid
1
2函数声明时括号与函数名间加空格。
eslint:
space-before-function-paren
open in new windowfunction name (arg) { ... } // ✓ ok function name(arg) { ... } // ✗ avoid run(function () { ... }) // ✓ ok run(function() { ... }) // ✗ avoid
1
2
3
4
5始终使用
===
替代==
。 例外:obj == null
可以用来检查null || undefined
。eslint:
eqeqeq
open in new windowif (name === 'John') // ✓ ok if (name == 'John') // ✗ avoid
1
2if (name !== 'John') // ✓ ok if (name != 'John') // ✗ avoid
1
2字符串拼接操作符 (Infix operators) 之间要留空格。
eslint:
space-infix-ops
open in new window// ✓ ok var x = 2 var message = 'hello, ' + name + '!'
1
2
3// ✗ avoid var x=2 var message = 'hello, '+name+'!'
1
2
3逗号后面加空格。
eslint:
comma-spacing
open in new window// ✓ ok var list = [1, 2, 3, 4] function greet (name, options) { ... }
1
2
3// ✗ avoid var list = [1,2,3,4] function greet (name,options) { ... }
1
2
3else 关键字要与花括号保持在同一行。
eslint:
brace-style
open in new window// ✓ ok if (condition) { // ... } else { // ... }
1
2
3
4
5
6// ✗ avoid if (condition) { // ... } else { // ... }
1
2
3
4
5
6
7
8
9多行 if 语句的的括号不能省。
eslint:
curly
open in new window// ✓ ok if (options.quiet !== true) console.log('done')
1
2// ✓ ok if (options.quiet !== true) { console.log('done') }
1
2
3
4// ✗ avoid if (options.quiet !== true) console.log('done')
1
2
3不要丢掉异常处理中
err
参数。eslint:
handle-callback-err
open in new window// ✓ ok run(function (err) { if (err) throw err window.alert('done') })
1
2
3
4
5// ✗ avoid run(function (err) { window.alert('done') })
1
2
3
4使用浏览器全局变量时加上
window.
前缀。 Exceptions are:document
,console
andnavigator
.eslint:
no-undef
open in new windowwindow.alert('hi') // ✓ ok
1不允许有连续多行空行。
eslint:
no-multiple-empty-lines
open in new window// ✓ ok var value = 'hello world' console.log(value)
1
2
3// ✗ avoid var value = 'hello world' console.log(value)
1
2
3
4
5对于三元运算符
?
和:
与他们所负责的代码处于同一行eslint:
operator-linebreak
open in new window// ✓ ok var location = env.development ? 'localhost' : 'www.api.com' // ✓ ok var location = env.development ? 'localhost' : 'www.api.com' // ✗ avoid var location = env.development ? 'localhost' : 'www.api.com'
1
2
3
4
5
6
7
8
9
10
11
12每个 var 关键字单独声明一个变量。
eslint:
one-var
open in new window// ✓ ok var silent = true var verbose = true // ✗ avoid var silent = true, verbose = true // ✗ avoid var silent = true, verbose = true
1
2
3
4
5
6
7
8
9
10条件语句中赋值语句使用括号包起来。这样使得代码更加清晰可读,而不会认为是将条件判断语句的全等号(
===
)错写成了等号(=
)。eslint:
no-cond-assign
open in new window// ✓ ok while ((m = text.match(expr))) { // ... } // ✗ avoid while (m = text.match(expr)) { // ... }
1
2
3
4
5
6
7
8
9单行代码块两边加空格。
eslint:
block-spacing
open in new windowfunction foo () {return true} // ✗ avoid function foo () { return true } // ✓ ok
1
2对于变量和函数名统一使用驼峰命名法。
eslint:
camelcase
open in new windowfunction my_function () { } // ✗ avoid function myFunction () { } // ✓ ok var my_var = 'hello' // ✗ avoid var myVar = 'hello' // ✓ ok
1
2
3
4
5不允许有多余的行末逗号。
eslint:
comma-dangle
open in new windowvar obj = { message: 'hello', // ✗ avoid }
1
2
3始终将逗号置于行末。
eslint:
comma-style
open in new windowvar obj = { foo: 'foo' ,bar: 'bar' // ✗ avoid } var obj = { foo: 'foo', bar: 'bar' // ✓ ok }
1
2
3
4
5
6
7
8
9点号操作符须与属性需在同一行。
eslint:
dot-location
open in new windowconsole. log('hello') // ✗ avoid console .log('hello') // ✓ ok
1
2
3
4
5文件末尾留一空行。
eslint:
eol-last
open in new window函数调用时标识符与括号间不留间隔。
eslint:
func-call-spacing
open in new windowconsole.log ('hello') // ✗ avoid console.log('hello') // ✓ ok
1
2键值对当中冒号与值之间要留空白。
eslint:
key-spacing
open in new windowvar obj = { 'key' : 'value' } // ✗ avoid var obj = { 'key' :'value' } // ✗ avoid var obj = { 'key':'value' } // ✗ avoid var obj = { 'key': 'value' } // ✓ ok
1
2
3
4构造函数要以大写字母开头。
eslint:
new-cap
open in new windowfunction animal () {} var dog = new animal() // ✗ avoid function Animal () {} var dog = new Animal() // ✓ ok
1
2
3
4
5无参的构造函数调用时要带上括号。
eslint:
new-parens
open in new windowfunction Animal () {} var dog = new Animal // ✗ avoid var dog = new Animal() // ✓ ok
1
2
3对象中定义了存值器,一定要对应的定义取值器。
eslint:
accessor-pairs
open in new windowvar person = { set name (value) { // ✗ avoid this._name = value } } var person = { set name (value) { this._name = value }, get name () { // ✓ ok return this._name } }
1
2
3
4
5
6
7
8
9
10
11
12
13
14子类的构造器中一定要调用 super
eslint:
constructor-super
open in new windowclass Dog { constructor () { super() // ✗ avoid } } class Dog extends Mammal { constructor () { super() // ✓ ok } }
1
2
3
4
5
6
7
8
9
10
11使用数组字面量而不是构造器。
eslint:
no-array-constructor
open in new windowvar nums = new Array(1, 2, 3) // ✗ avoid var nums = [1, 2, 3] // ✓ ok
1
2避免使用 arguments.callee 和 arguments.caller。
eslint:
no-caller
open in new windowfunction foo (n) { if (n <= 0) return arguments.callee(n - 1) // ✗ avoid } function foo (n) { if (n <= 0) return foo(n - 1) }
1
2
3
4
5
6
7
8
9
10
11避免对类名重新赋值。
eslint:
no-class-assign
open in new windowclass Dog {} Dog = 'Fido' // ✗ avoid
1
2避免修改使用 const 声明的变量。
eslint:
no-const-assign
open in new windowconst score = 100 score = 125 // ✗ avoid
1
2避免使用常量作为条件表达式的条件(循环语句除外)。
eslint:
no-constant-condition
open in new windowif (false) { // ✗ avoid // ... } if (x === 0) { // ✓ ok // ... } while (true) { // ✓ ok // ... }
1
2
3
4
5
6
7
8
9
10
11正则中不要使用控制符。
eslint:
no-control-regex
open in new windowvar pattern = /\x1f/ // ✗ avoid var pattern = /\x20/ // ✓ ok
1
2不要使用 debugger。
eslint:
no-debugger
open in new windowfunction sum (a, b) { debugger // ✗ avoid return a + b }
1
2
3
4不要对变量使用 delete 操作。
eslint:
no-delete-var
open in new windowvar name delete name // ✗ avoid
1
2不要定义冗余的函数参数。
eslint:
no-dupe-args
open in new windowfunction sum (a, b, a) { // ✗ avoid // ... } function sum (a, b, c) { // ✓ ok // ... }
1
2
3
4
5
6
7类中不要定义冗余的属性。
eslint:
no-dupe-class-members
open in new windowclass Dog { bark () {} bark () {} // ✗ avoid }
1
2
3
4对象字面量中不要定义重复的属性。
eslint:
no-dupe-keys
open in new windowvar user = { name: 'Jane Doe', name: 'John Doe' // ✗ avoid }
1
2
3
4switch 语句中不要定义重复的 case 分支。
eslint:
no-duplicate-case
open in new windowswitch (id) { case 1: // ... case 1: // ✗ avoid }
1
2
3
4
5同一模块有多个导入时一次性写完。
eslint:
no-duplicate-imports
open in new windowimport { myFunc1 } from 'module' import { myFunc2 } from 'module' // ✗ avoid import { myFunc1, myFunc2 } from 'module' // ✓ ok
1
2
3
4正则中不要使用空字符。
eslint:
no-empty-character-class
open in new windowconst myRegex = /^abc[]/ // ✗ avoid const myRegex = /^abc[a-z]/ // ✓ ok
1
2不要解构空值。
eslint:
no-empty-pattern
open in new windowconst { a: {} } = foo // ✗ avoid const { a: { b } } = foo // ✓ ok
1
2不要使用 eval()。
eslint:
no-eval
open in new windoweval( "var result = user." + propName ) // ✗ avoid var result = user[propName] // ✓ ok
1
2catch 中不要对错误重新赋值。
eslint:
no-ex-assign
open in new windowtry { // ... } catch (e) { e = 'new value' // ✗ avoid } try { // ... } catch (e) { const newVal = 'new value' // ✓ ok }
1
2
3
4
5
6
7
8
9
10
11不要扩展原生对象。
eslint:
no-extend-native
open in new windowObject.prototype.age = 21 // ✗ avoid
1避免多余的函数上下文绑定。
eslint:
no-extra-bind
open in new windowconst name = function () { getName() }.bind(user) // ✗ avoid const name = function () { this.getName() }.bind(user) // ✓ ok
1
2
3
4
5
6
7避免不必要的布尔转换。
eslint:
no-extra-boolean-cast
open in new windowconst result = true if (!!result) { // ✗ avoid // ... } const result = true if (result) { // ✓ ok // ... }
1
2
3
4
5
6
7
8
9不要使用多余的括号包裹函数。
eslint:
no-extra-parens
open in new windowconst myFunc = (function () { }) // ✗ avoid const myFunc = function () { } // ✓ ok
1
2switch 一定要使用 break 来将条件分支正常中断。
eslint:
no-fallthrough
open in new windowswitch (filter) { case 1: doSomething() // ✗ avoid case 2: doSomethingElse() } switch (filter) { case 1: doSomething() break // ✓ ok case 2: doSomethingElse() } switch (filter) { case 1: doSomething() // fallthrough // ✓ ok case 2: doSomethingElse() }
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22不要省去小数点前面的0。
eslint:
no-floating-decimal
open in new windowconst discount = .5 // ✗ avoid const discount = 0.5 // ✓ ok
1
2避免对声明过的函数重新赋值。
eslint:
no-func-assign
open in new windowfunction myFunc () { } myFunc = myOtherFunc // ✗ avoid
1
2不要对全局只读对象重新赋值。
eslint:
no-global-assign
open in new windowwindow = {} // ✗ avoid
1注意隐式的 eval()。
eslint:
no-implied-eval
open in new windowsetTimeout("alert('Hello world')") // ✗ avoid setTimeout(function () { alert('Hello world') }) // ✓ ok
1
2嵌套的代码块中禁止再定义函数。
eslint:
no-inner-declarations
open in new windowif (authenticated) { function setAuthUser () {} // ✗ avoid }
1
2
3不要向 RegExp 构造器传入非法的正则表达式。
eslint:
no-invalid-regexp
open in new windowRegExp('[a-z') // ✗ avoid RegExp('[a-z]') // ✓ ok
1
2不要使用非法的空白符。
eslint:
no-irregular-whitespace
open in new windowfunction myFunc () /*<NBSP>*/{} // ✗ avoid
1禁止使用 iterator。
eslint:
no-iterator
open in new windowFoo.prototype.__iterator__ = function () {} // ✗ avoid
1外部变量不要与对象属性重名。
eslint:
no-label-var
open in new windowvar score = 100 function game () { score: while (true) { // ✗ avoid score -= 10 if (score > 0) continue score break } }
1
2
3
4
5
6
7
8不要使用标签语句。
eslint:
no-labels
open in new windowlabel: while (true) { break label // ✗ avoid }
1
2
3
4不要书写不必要的嵌套代码块。
eslint:
no-lone-blocks
open in new windowfunction myFunc () { { // ✗ avoid myOtherFunc() } } function myFunc () { myOtherFunc() // ✓ ok }
1
2
3
4
5
6
7
8
9不要混合使用空格与制表符作为缩进。
除了缩进,不要使用多个空格。
eslint:
no-multi-spaces
open in new windowconst id = 1234 // ✗ avoid const id = 1234 // ✓ ok
1
2不要使用多行字符串。
eslint:
no-multi-str
open in new windowconst message = 'Hello \ world' // ✗ avoid
1
2new 创建对象实例后需要赋值给变量。
eslint:
no-new
open in new windownew Character() // ✗ avoid const character = new Character() // ✓ ok
1
2禁止使用 Function 构造器。
eslint:
no-new-func
open in new windowvar sum = new Function('a', 'b', 'return a + b') // ✗ avoid
1禁止使用 Object 构造器。
eslint:
no-new-object
open in new windowlet config = new Object() // ✗ avoid
1禁止使用 new require。
eslint:
no-new-require
open in new windowconst myModule = new require('my-module') // ✗ avoid
1禁止使用 Symbol 构造器。
eslint:
no-new-symbol
open in new windowconst foo = new Symbol('foo') // ✗ avoid
1禁止使用原始包装器。
eslint:
no-new-wrappers
open in new windowconst message = new String('hello') // ✗ avoid
1不要将全局对象的属性作为函数调用。
eslint:
no-obj-calls
open in new windowconst math = Math() // ✗ avoid
1不要使用八进制字面量。
eslint:
no-octal
open in new windowconst num = 042 // ✗ avoid const num = '042' // ✓ ok
1
2字符串字面量中也不要使用八进制转义字符。
eslint:
no-octal-escape
open in new windowconst copyright = 'Copyright \251' // ✗ avoid
1使用 __dirname 和 __filename 时尽量避免使用字符串拼接。
eslint:
no-path-concat
open in new windowconst pathToFile = __dirname + '/app.js' // ✗ avoid const pathToFile = path.join(__dirname, 'app.js') // ✓ ok
1
2使用
getPrototypeOf
来替代 proto。eslint:
no-proto
open in new windowconst foo = obj.__proto__ // ✗ avoid const foo = Object.getPrototypeOf(obj) // ✓ ok
1
2不要重复声明变量。
eslint:
no-redeclare
open in new windowlet name = 'John' let name = 'Jane' // ✗ avoid let name = 'John' name = 'Jane' // ✓ ok
1
2
3
4
5正则中避免使用多个空格。
eslint:
no-regex-spaces
open in new windowconst regexp = /test value/ // ✗ avoid const regexp = /test {3}value/ // ✓ ok const regexp = /test value/ // ✓ ok
1
2
3
4return 语句中的赋值必需有括号包裹。
eslint:
no-return-assign
open in new windowfunction sum (a, b) { return result = a + b // ✗ avoid } function sum (a, b) { return (result = a + b) // ✓ ok }
1
2
3
4
5
6
7避免将变量赋值给自己。
eslint:
no-self-assign
open in new windowname = name // ✗ avoid
1避免将变量与自己进行比较操作。
esint:
no-self-compare
open in new windowif (score === score) {} // ✗ avoid
1避免使用逗号操作符。
eslint:
no-sequences
open in new windowif (doSomething(), !!test) {} // ✗ avoid
1不要随意更改关键字的值。
eslint:
no-shadow-restricted-names
open in new windowlet undefined = 'value' // ✗ avoid
1禁止使用稀疏数组(Sparse arrays)。
eslint:
no-sparse-arrays
open in new windowlet fruits = ['apple',, 'orange'] // ✗ avoid
1不要使用制表符。
eslint:
no-tabs
open in new window正确使用 ES6 中的字符串模板。
eslint:
no-template-curly-in-string
open in new windowconst message = 'Hello ${name}' // ✗ avoid const message = `Hello ${name}` // ✓ ok
1
2使用 this 前请确保 super() 已调用。
eslint:
no-this-before-super
open in new windowclass Dog extends Animal { constructor () { this.legs = 4 // ✗ avoid super() } }
1
2
3
4
5
6用 throw 抛错时,抛出 Error 对象而不是字符串。
eslint:
no-throw-literal
open in new windowthrow 'error' // ✗ avoid throw new Error('error') // ✓ ok
1
2行末不留空格。
不要使用 undefined 来初始化变量。
eslint:
no-undef-init
open in new windowlet name = undefined // ✗ avoid let name name = 'value' // ✓ ok
1
2
3
4循环语句中注意更新循环变量。
eslint:
no-unmodified-loop-condition
open in new windowfor (let i = 0; i < items.length; j++) {...} // ✗ avoid for (let i = 0; i < items.length; i++) {...} // ✓ ok
1
2如果有更好的实现,尽量不要使用三元表达式。
eslint:
no-unneeded-ternary
open in new windowlet score = val ? val : 0 // ✗ avoid let score = val || 0 // ✓ ok
1
2return,throw,continue 和 break 后不要再跟代码。
eslint:
no-unreachable
open in new windowfunction doSomething () { return true console.log('never called') // ✗ avoid }
1
2
3
4finally 代码块中不要再改变程序执行流程。
eslint:
no-unsafe-finally
open in new windowtry { // ... } catch (e) { // ... } finally { return 42 // ✗ avoid }
1
2
3
4
5
6
7关系运算符的左值不要做取反操作。
eslint:
no-unsafe-negation
open in new windowif (!key in obj) {} // ✗ avoid
1避免不必要的 .call() 和 .apply()。
eslint:
no-useless-call
open in new windowsum.call(null, 1, 2, 3) // ✗ avoid
1避免使用不必要的计算值作对象属性。
eslint:
no-useless-computed-key
open in new windowconst user = { ['name']: 'John Doe' } // ✗ avoid const user = { name: 'John Doe' } // ✓ ok
1
2禁止多余的构造器。
eslint:
no-useless-constructor
open in new windowclass Car { constructor () { // ✗ avoid } }
1
2
3
4禁止不必要的转义。
eslint:
no-useless-escape
open in new windowlet message = 'Hell\o' // ✗ avoid
1import, export 和解构操作中,禁止赋值到同名变量。
eslint:
no-useless-rename
open in new windowimport { config as config } from './config' // ✗ avoid import { config } from './config' // ✓ ok
1
2属性前面不要加空格。
eslint:
no-whitespace-before-property
open in new windowuser .name // ✗ avoid user.name // ✓ ok
1
2禁止使用 with。
eslint:
no-with
open in new windowwith (val) {...} // ✗ avoid
1对象属性换行时注意统一代码风格。
eslint:
object-property-newline
open in new windowconst user = { name: 'Jane Doe', age: 30, username: 'jdoe86' // ✗ avoid } const user = { name: 'Jane Doe', age: 30, username: 'jdoe86' } // ✓ ok const user = { name: 'Jane Doe', age: 30, username: 'jdoe86' } // ✓ ok
1
2
3
4
5
6
7
8
9
10
11
12代码块中避免多余留白。
eslint:
padded-blocks
open in new windowif (user) { // ✗ avoid const name = getName() } if (user) { const name = getName() // ✓ ok }
1
2
3
4
5
6
7
8
9展开运算符与它的表达式间不要留空白。
eslint:
rest-spread-spacing
open in new windowfn(... args) // ✗ avoid fn(...args) // ✓ ok
1
2遇到分号时空格要后留前不留。
eslint:
semi-spacing
open in new windowfor (let i = 0 ;i < items.length ;i++) {...} // ✗ avoid for (let i = 0; i < items.length; i++) {...} // ✓ ok
1
2代码块首尾留空格。
eslint:
space-before-blocks
open in new windowif (admin){...} // ✗ avoid if (admin) {...} // ✓ ok
1
2圆括号间不留空格。
eslint:
space-in-parens
open in new windowgetName( name ) // ✗ avoid getName(name) // ✓ ok
1
2一元运算符后面跟一个空格。
eslint:
space-unary-ops
open in new windowtypeof!admin // ✗ avoid typeof !admin // ✓ ok
1
2注释首尾留空格。
eslint:
spaced-comment
open in new window//comment // ✗ avoid // comment // ✓ ok /*comment*/ // ✗ avoid /* comment */ // ✓ ok
1
2
3
4
5模板字符串中变量前后不加空格。
eslint:
template-curly-spacing
open in new windowconst message = `Hello, ${ name }` // ✗ avoid const message = `Hello, ${name}` // ✓ ok
1
2检查 NaN 的正确姿势是使用 isNaN()。
eslint:
use-isnan
open in new windowif (price === NaN) { } // ✗ avoid if (isNaN(price)) { } // ✓ ok
1
2用合法的字符串跟 typeof 进行比较操作。
eslint:
valid-typeof
open in new windowtypeof name === 'undefimed' // ✗ avoid typeof name === 'undefined' // ✓ ok
1
2自调用匿名函数 (IIFEs) 使用括号包裹。
eslint:
wrap-iife
open in new windowconst getName = function () { }() // ✗ avoid const getName = (function () { }()) // ✓ ok const getName = (function () { })() // ✓ ok
1
2
3
4yield * 中的 * 前后都要有空格。
eslint:
yield-star-spacing
open in new windowyield* increment() // ✗ avoid yield * increment() // ✓ ok
1
2请书写优雅的条件语句(avoid Yoda conditions)。
eslint:
yoda
open in new windowif (42 === age) { } // ✗ avoid if (age === 42) { } // ✓ ok
1
2
关于分号
不要使用分号。 (参见:1open in new window,2open in new window,3open in new window)
eslint:
semi
open in new windowwindow.alert('hi') // ✓ ok window.alert('hi'); // ✗ avoid
1
2不要使用
(
,[
, or ``` 等作为一行的开始。在没有分号的情况下代码压缩后会导致报错,而坚持这一规范则可避免出错。eslint:
no-unexpected-multiline
open in new window// ✓ ok ;(function () { window.alert('ok') }()) // ✗ avoid (function () { window.alert('ok') }())
1
2
3
4
5
6
7
8
9// ✓ ok ;[1, 2, 3].forEach(bar) // ✗ avoid [1, 2, 3].forEach(bar)
1
2
3
4
5// ✓ ok ;`hello`.indexOf('o') // ✗ avoid `hello`.indexOf('o')
1
2
3
4
5备注:上面的写法只能说聪明过头了。
相比更加可读易懂的代码,那些看似投巧的写法是不可取的。
譬如:
;[1, 2, 3].forEach(bar)
1建议的写法是:
var nums = [1, 2, 3] nums.forEach(bar)
1
2