JavaScript Standard 风格代码规范

关于分号

• 不要使用分号。

  window.alert('hi')   // ✓ 可以
  window.alert('hi');  // ✗ 避免使用
  

• 不要使用 (, [, or ` 等作为一行的开始。在没有分号的情况下代码压缩后会导致报错，而坚持这一规范则可避免出错。

   // ✓ 可以
  ;(function () {
    window.alert('ok')
  }())
  
  // ✗ 避免使用
  (function () {
    window.alert('ok')
  }())
  
  // ✓ 可以
  ;[1, 2, 3].forEach(bar)
  
  // ✗ 避免使用
  [1, 2, 3].forEach(bar)
  
  // ✓ 可以
  ;`hello`.indexOf('o')
  
  // ✗ 避免使用
  `hello`.indexOf('o')
  

细则

1. 使用两个空格进行缩进。

function hello (name) {
  console.log('hi', name)  // 缩进两个空格
}

2. 除需要转义的情况外，字符串统一使用单引号。

console.log('hello there')

3. 不要定义未使用的变量。

function myFunction () {
  var result = something()   // ✗ 避免使用
}

4. 关键字后面加空格。

if (condition) { ... }   // ✓ 可以
if(condition) { ... }    // ✗ 避免使用

5. 函数声明时括号与函数名间加空格。

function name (arg) { ... }   // ✓ 可以
function name(arg) { ... }    // ✗ 避免使用

run(function () { ... })      // ✓ 可以
run(function() { ... })       // ✗ 避免使用

6. 始终使用 === 替代 ==。 例外： obj == null 可以用来检查 null || undefined。

if (name === 'John')   // ✓ 可以
if (name == 'John')    // ✗ 避免使用

if (name !== 'John')   // ✓ 可以
if (name != 'John')    // ✗ 避免使用

7. 字符串拼接操作符 (Infix operators) 之间要留空格。

// ✓ 可以
var x = 2
var message = 'hello, ' + name + '!'

// ✗ 避免使用
var x=2
var message = 'hello, '+name+'!'

8. 逗号后面加空格。

// ✓ 可以
var list = [1, 2, 3, 4]
function greet (name, options) { ... }

// ✗ 避免使用
var list = [1,2,3,4]
function greet (name,options) { ... }

9. else 关键字要与花括号保持在同一行。

// ✓ 可以
if (condition) {
  // ...
} else {
  // ...
}

// ✗ 避免使用
if (condition)
{
  // ...
}
else
{
  // ...
}

10. 多行 if 语句的的括号不能省。

// ✓ 可以
if (options.quiet !== true) console.log('done')

// ✓ 可以
if (options.quiet !== true) {
  console.log('done')
}

// ✗ 避免使用
if (options.quiet !== true)
  console.log('done')

11. 不要丢掉异常处理中err参数。

// ✓ 可以
run(function (err) {
  if (err) throw err
  window.alert('done')
})

// ✗ 避免使用
run(function (err) {
  window.alert('done')
})

12. 使用浏览器全局变量时加上 window. 前缀。document、console 和 navigator 除外。

window.alert('hi')   // ✓ 可以

13. 不允许有连续多行空行。

// ✓ 可以
var value = 'hello world'
console.log(value)

// ✗ 避免使用
var value = 'hello world'


console.log(value)

14. 对于三元运算符 ? 和 : 与他们所负责的代码处于同一行

// ✓ 可以
var location = env.development ? 'localhost' : 'www.api.com'

// ✓ 可以
var location = env.development
  ? 'localhost'
  : 'www.api.com'

// ✗ 避免使用
var location = env.development ?
  'localhost' :
  'www.api.com'

15. 每个 var 关键字单独声明一个变量。

// ✓ 可以
var silent = true
var verbose = true

// ✗ 避免使用
var silent = true, verbose = true

// ✗ 避免使用
var silent = true,
    verbose = true

16. 条件语句中赋值语句使用括号包起来。这样使得代码更加清晰可读，而不会认为是将条件判断语句的全等号（===）错写成了等号（=）。

// ✓ 可以
while ((m = text.match(expr))) {
  // ...
}

// ✗ 避免使用
while (m = text.match(expr)) {
  // ...
}

17. 单行代码块两边加空格。

  function foo () {return true}    // ✗ 避免使用
  function foo () { return true }  // ✓ 可以

18. 对于变量和函数名统一使用驼峰命名法。

  function my_function () { }    // ✗ 避免使用
  function myFunction () { }     // ✓ 可以

  var my_var = 'hello'           // ✗ 避免使用
  var myVar = 'hello'            // ✓ 可以

19. 不允许有多余的行末逗号。

  var obj = {
    message: 'hello',   // ✗ 避免使用
  }

20. 始终将逗号置于行末。

  var obj = {
    foo: 'foo'
    ,bar: 'bar'   // ✗ 避免使用
  }

  var obj = {
    foo: 'foo',
    bar: 'bar'   // ✓ 可以
  }

21. 点号操作符须与属性需在同一行。

  console.
    log('hello')  // ✗ 避免使用

  console
    .log('hello') // ✓ 可以

22. 文件末尾留一空行。
23. 函数调用时标识符与括号间不留间隔。

console.log ('hello') // ✗ 避免使用
console.log('hello')  // ✓ 可以

24. 键值对当中冒号与值之间要留空白。

var obj = { 'key' : 'value' }    // ✗ 避免使用
var obj = { 'key' :'value' }     // ✗ 避免使用
var obj = { 'key':'value' }      // ✗ 避免使用
var obj = { 'key': 'value' }     // ✓ 可以

25. 构造函数要以大写字母开头。

function animal () {}
var dog = new animal()    // ✗ 避免使用

function Animal () {}
var dog = new Animal()    // ✓ 可以

26. 无参的构造函数调用时要带上括号。

function Animal () {}
var dog = new Animal    // ✗ 避免使用
var dog = new Animal()  // ✓ 可以

27. 对象中定义了存值器，一定要对应的定义取值器。

var person = {
  set name (value) {    // ✗ 避免使用
    this._name = value
  }
}

var person = {
  set name (value) {
    this._name = value
  },
  get name () {         // ✓ 可以
    return this._name
  }
}

28. 子类的构造器中一定要调用 super

class Dog {
  constructor () {
    super()   // ✗ 避免使用
  }
}

class Dog extends Mammal {
  constructor () {
    super()   // ✓ 可以
  }
}

29. 使用数组字面量而不是构造器。

var nums = new Array(1, 2, 3)   // ✗ 避免使用
var nums = [1, 2, 3]            // ✓ 可以

30. 避免使用 arguments.callee 和 arguments.caller。

function foo (n) {
  if (n <= 0) return

  arguments.callee(n - 1)   // ✗ 避免使用
}

function foo (n) {
  if (n <= 0) return

  foo(n - 1)
}

31. 避免对类名重新赋值。

class Dog {}
Dog = 'Fido'    // ✗ 避免使用

32. 避免修改使用 const 声明的变量。

const score = 100
score = 125       // ✗ 避免使用

33. 避免使用常量作为条件表达式的条件（循环语句除外） 。

if (false) {    // ✗ 避免使用
  // ...
}

if (x === 0) {  // ✓ 可以
  // ...
}

while (true) {  // ✓ 可以
  // ...
}

34. 正则中不要使用控制符。

var pattern = /\x1f/    // ✗ 避免使用
var pattern = /\x20/    // ✓ 可以

35. 不要使用 debugger。

function sum (a, b) {
  debugger      // ✗ 避免使用
  return a + b
}

36. 不要对变量使用 delete 操作。

var name
delete name     // ✗ 避免使用

37. 不要定义冗余的函数参数。

function sum (a, b, a) {  // ✗ 避免使用
  // ...
}

function sum (a, b, c) {  // ✓ 可以
  // ...
}

38. 类中不要定义冗余的属性。

class Dog {
  bark () {}
  bark () {}    // ✗ 避免使用
}

39. 对象字面量中不要定义重复的属性。

var user = {
  name: 'Jane Doe',
  name: 'John Doe'    // ✗ 避免使用
}

40. switch 语句中不要定义重复的 case 分支。

switch (id) {
  case 1:
    // ...
  case 1:     // ✗ 避免使用
}

41. 同一模块有多个导入时一次性写完。

import { myFunc1 } from 'module'
import { myFunc2 } from 'module'          // ✗ 避免使用

import { myFunc1, myFunc2 } from 'module' // ✓ 可以

42. 正则中不要使用空字符。

const myRegex = /^abc[]/      // ✗ 避免使用
const myRegex = /^abc[a-z]/   // ✓ 可以

43. 不要解构空值。

const { a: {} } = foo         // ✗ 避免使用
const { a: { b } } = foo      // ✓ 可以

44. 不要使用 eval() 。

eval( "var result = user." + propName ) // ✗ 避免使用
var result = user[propName]             // ✓ 可以

45. catch 中不要对错误重新赋值。

try {
  // ...
} catch (e) {
  e = 'new value'             // ✗ 避免使用
}

try {
  // ...
} catch (e) {
  const newVal = 'new value'  // ✓ 可以
}

46. 不要扩展原生对象。

Object.prototype.age = 21     // ✗ 避免使用

47. 避免多余的函数上下文绑定。

const name = function () {
  getName()
}.bind(user)    // ✗ 避免使用

const name = function () {
  this.getName()
}.bind(user)    // ✓ 可以

48. 避免不必要的布尔转换。

const result = true
if (!!result) {   // ✗ 避免使用
  // ...
}

const result = true
if (result) {     // ✓ 可以
  // ...
}

49. 不要使用多余的括号包裹函数。

const myFunc = (function () { })   // ✗ 避免使用
const myFunc = function () { }     // ✓ 可以

50. switch 一定要使用 break 来将条件分支正常中断。

switch (filter) {
  case 1:
    doSomething()    // ✗ 避免使用
  case 2:
    doSomethingElse()
}

switch (filter) {
  case 1:
    doSomething()
    break           // ✓ 可以
  case 2:
    doSomethingElse()
}

switch (filter) {
  case 1:
    doSomething()
    // fallthrough  // ✓ 可以
  case 2:
    doSomethingElse()
}

51. 不要省去小数点前面的0。

const discount = .5      // ✗ 避免使用
const discount = 0.5     // ✓ 可以

52. 避免对声明过的函数重新赋值。

function myFunc () { }
myFunc = myOtherFunc    // ✗ 避免使用

53. 不要对全局只读对象重新赋值。

window = {}     // ✗ 避免使用

54. 注意隐式的 eval() 。

setTimeout("alert('Hello world')")                   // ✗ 避免使用
setTimeout(function () { alert('Hello world') })     // ✓ 可以

55. 嵌套的代码块中禁止再定义函数。

if (authenticated) {
  function setAuthUser () {}    // ✗ 避免使用
}

56. 不要向 RegExp 构造器传入非法的正则表达式。

RegExp('[a-z')    // ✗ 避免使用
RegExp('[a-z]')   // ✓ 可以

57. 不要使用非法的空白符。

function myFunc () /*<NBSP>*/{}   // ✗ 避免使用

58. 禁止使用 __iterator__ 。

Foo.prototype.__iterator__ = function () {}   // ✗ 避免使用

59. 外部变量不要与对象属性重名。

var score = 100
function game () {
  score: while (true) {      // ✗ 避免使用
    score -= 10
    if (score > 0) continue score
    break
  }
}

60. 不要使用标签语句。

label:
  while (true) {
    break label     // ✗ 避免使用
  }

61. 不要书写不必要的嵌套代码块。

function myFunc () {
  {                   // ✗ 避免使用
    myOtherFunc()
  }
}

function myFunc () {
  myOtherFunc()       // ✓ 可以
}

62. 不要混合使用空格与制表符作为缩进。
63. 除了缩进，不要使用多个空格。

const id =    1234    // ✗ 避免使用
const id = 1234       // ✓ 可以

64. 不要使用多行字符串。

const message = 'Hello \
                 world'     // ✗ 避免使用

65. new 创建对象实例后需要赋值给变量。

new Character()                     // ✗ 避免使用
const character = new Character()   // ✓ 可以

66. 禁止使用 Function 构造器。

var sum = new Function('a', 'b', 'return a + b')    // ✗ 避免使用

67. 禁止使用 Object 构造器。

let config = new Object()   // ✗ 避免使用

68. 禁止使用 new require。

const myModule = new require('my-module')    // ✗ 避免使用

69. 禁止使用 Symbol 构造器。

const foo = new Symbol('foo')   // ✗ 避免使用

70. 禁止使用原始包装器。

const message = new String('hello')   // ✗ 避免使用

71. 不要将全局对象的属性作为函数调用。

const math = Math()   // ✗ 避免使用

72. 不要使用八进制字面量。

const octal = 042         // ✗ 避免使用
const decimal = 34        // ✓ 可以
const octalString = '042' // ✓ 可以

73. 字符串字面量中也不要使用八进制转义字符。

const copyright = 'Copyright \251'  // ✗ 避免使用

74. 使用 __dirname 和 __filename 时尽量避免使用字符串拼接。

const pathToFile = __dirname + '/app.js'            // ✗ 避免使用
const pathToFile = path.join(__dirname, 'app.js')   // ✓ 可以

75. 使用 getPrototypeOf 来替代 __proto__ 。

const foo = obj.__proto__               // ✗ 避免使用
const foo = Object.getPrototypeOf(obj)  // ✓ 可以

76. 不要重复声明变量。

let name = 'John'
let name = 'Jane'     // ✗ 避免使用

let name = 'John'
name = 'Jane'         // ✓ 可以

77. 正则中避免使用多个空格。

const regexp = /test   value/   // ✗ 避免使用

const regexp = /test {3}value/  // ✓ 可以
const regexp = /test value/     // ✓ 可以

78. return 语句中的赋值必需有括号包裹。

function sum (a, b) {
  return result = a + b     // ✗ 避免使用
}

function sum (a, b) {
  return (result = a + b)   // ✓ 可以
}

79. 避免将变量赋值给自己。

name = name   // ✗ 避免使用

80. 避免将变量与自己进行比较操作。

if (score === score) {}   // ✗ 避免使用

81. 避免使用逗号操作符。

if (doSomething(), !!test) {}   // ✗ 避免使用

82. 不要随意更改关键字的值。

let undefined = 'value'     // ✗ 避免使用

83. 禁止使用稀疏数组（Sparse arrays） 。

let fruits = ['apple',, 'orange']       // ✗ 避免使用

84. 不要使用制表符。
85. 正确使用 ES6 中的字符串模板。

const message = 'Hello ${name}'   // ✗ 避免使用
const message = `Hello ${name}`   // ✓ 可以

86. 使用 this 前请确保 super() 已调用。

class Dog extends Animal {
  constructor () {
    this.legs = 4     // ✗ 避免使用
    super()
  }
}

87. 用 throw 抛错时，抛出 Error 对象而不是字符串。

throw 'error'               // ✗ 避免使用
throw new Error('error')    // ✓ 可以

88. 行末不留空格。
89. 不要使用 undefined 来初始化变量。

let name = undefined    // ✗ 避免使用

let name
name = 'value'          // ✓ 可以

90. 循环语句中注意更新循环变量。

for (let i = 0; i < items.length; j++) {...}    // ✗ 避免使用
for (let i = 0; i < items.length; i++) {...}    // ✓ 可以

91. 如果有更好的实现，尽量不要使用三元表达式。

let score = val ? val : 0     // ✗ 避免使用
let score = val || 0          // ✓ 可以

92. return，throw，continue 和 break 后不要再跟代码。

function doSomething () {
  return true
  console.log('never called')     // ✗ 避免使用
}

93. finally 代码块中不要再改变程序执行流程。

try {
  // ...
} catch (e) {
  // ...
} finally {
  return 42     // ✗ 避免使用
}

94. 关系运算符的左值不要做取反操作。

if (!key in obj) {}       // ✗ 避免使用

95. 避免不必要的 .call() 和 .apply() 。

sum.call(null, 1, 2, 3)   // ✗ 避免使用

96. 避免使用不必要的计算值作对象属性。

const user = { ['name']: 'John Doe' }   // ✗ 避免使用
const user = { name: 'John Doe' }       // ✓ 可以

97. 禁止多余的构造器。

class Car {
  constructor () {      // ✗ 避免使用
  }
}

98. 禁止不必要的转义。

let message = 'Hell\o'  // ✗ 避免使用

99. import, export 和解构操作中，禁止赋值到同名变量。

import { config as config } from './config'     // ✗ 避免使用
import { config } from './config'               // ✓ 可以

100. 属性前面不要加空格。

user .name      // ✗ 避免使用
user.name       // ✓ 可以

101. 禁止使用 with。

with (val) {...}    // ✗ 避免使用

102. 对象属性换行时注意统一代码风格。

const user = {
  name: 'Jane Doe', age: 30,
  username: 'jdoe86'            // ✗ 避免使用
}

const user = { name: 'Jane Doe', age: 30, username: 'jdoe86' }    // ✓ 可以

const user = {
  name: 'Jane Doe',
  age: 30,
  username: 'jdoe86'
}                                                                 // ✓ 可以

103. 代码块中避免多余留白。

if (user) {
                            // ✗ 避免使用
  const name = getName()

}

if (user) {
  const name = getName()    // ✓ 可以
}

104. 展开运算符与它的表达式间不要留空白。

fn(... args)    // ✗ 避免使用
fn(...args)     // ✓ 可以

105. 遇到分号时空格要后留前不留。

for (let i = 0 ;i < items.length ;i++) {...}    // ✗ 避免使用
for (let i = 0; i < items.length; i++) {...}    // ✓ 可以

106. 代码块首尾留空格。

if (admin){...}     // ✗ 避免使用
if (admin) {...}    // ✓ 可以

107. 圆括号间不留空格。

getName( name )     // ✗ 避免使用
getName(name)       // ✓ 可以

108. 一元运算符后面跟一个空格。

typeof!admin        // ✗ 避免使用
typeof !admin        // ✓ 可以

109. 注释首尾留空格。

//comment           // ✗ 避免使用
// comment          // ✓ 可以

/*comment*/         // ✗ 避免使用
/* comment */       // ✓ 可以

110. 模板字符串中变量前后不加空格。

const message = `Hello, ${ name }`    // ✗ 避免使用
const message = `Hello, ${name}`      // ✓ 可以

111. 检查 NaN 的正确姿势是使用 isNaN() 。

if (price === NaN) { }      // ✗ 避免使用
if (isNaN(price)) { }       // ✓ 可以

112. 用合法的字符串跟 typeof 进行比较操作。

typeof name === 'undefimed'     // ✗ 避免使用
typeof name === 'undefined'     // ✓ 可以

113. 自调用匿名函数 (IIFEs) 使用括号包裹。

const getName = function () { }()     // ✗ 避免使用

const getName = (function () { }())   // ✓ 可以
const getName = (function () { })()   // ✓ 可以

114. yield * 中的 * 前后都要有空格。

yield* increment()    // ✗ 避免使用
yield * increment()   // ✓ 可以

115. 请书写优雅的条件语句（avoid Yoda conditions） 。

if (42 === age) { }    // ✗ 避免使用
if (age === 42) { }    // ✓ 可以