语言规范

JavaScript 是一种客户端脚本语言，这里列出了编写 JavaScript 时需要遵守的规则。

类型

  • 基本类型

    • 字符串
    • 数值
    • 布尔类型
    • null
    • undefined
    1. const foo = 1
    2. let bar = foo
    4. bar = 9
    6. console.log(foo, bar) // 1, 9

  • 复杂类型

    • object
    • array
    • function
    1. const foo = [1, 2, 3]
    2. const bar = foo
    4. bar[0] = 9
    6. console.log(foo[0], bar[0]) // 9, 9

引用

const 和 let 都是块级作用域，var 是函数级作用域

  • 对所有引用都使用 const，不要使用 var

    1. // bad
    2. var a = 1
    3. var b = 2
    5. // good
    6. const a = 1
    7. const b = 2

  • 如果引用是可变的，则使用 let

    1. // bad
    2. var count = 1
    3. if (count < 10) {
    4.   count += 1
    5. }
    7. // good
    8. let count = 1
    9. if (count < 10) {
    10.   count += 1
    11. }

对象

  • 请使用字面量值创建对象

    1. // bad
    2. const a = new Object{}
    4. // good
    5. const a = {}

  • 别使用保留字作为对象的键值，这样在 IE8 下不会运行

    1. // bad
    2. const a = {
    3.   default: {},  // default 是保留字
    4.   common: {}
    5. }
    7. // good
    8. const a = {
    9.   defaults: {},
    10.   common: {}
    11. }

  • 请使用对象方法的简写方式

    1. // bad
    2. const item = {
    3.   value: 1,
    5.   addValue: function (val) {
    6.     return item.value + val
    7.   }
    8. }
    10. // good
    11. const item = {
    12.   value: 1,
    14.   addValue(val) {
    15.     return item.value + val
    16.   }
    17. }

  • 请使用对象属性值的简写方式

    1. const job = 'FrontEnd'
    3. // bad
    4. const item = {
    5.   job: job
    6. }
    8. // good
    9. const item = {
    10.   job
    11. }

  • 对象属性值的简写方式要和声明式的方式分组

    1. const job = 'FrontEnd'
    2. const department = 'JDC'
    4. // bad
    5. const item = {
    6.   sex: 'male',
    7.   job,
    8.   age: 25,
    9.   department
    10. }
    12. // good
    13. const item = {
    14.   job,
    15.   department,
    16.   sex: 'male',
    17.   age: 25
    18. }

数组

  • 请使用字面量值创建数组

    1. // bad
    2. const items = new Array()
    4. // good
    5. const items = []

  • 向数组中添加元素时，请使用 push 方法

    1. const items = []
    3. // bad
    4. items[items.length] = 'test'
    6. // good
    7. items.push('test')

  • 使用拓展运算符 ... 复制数组

    1. // bad
    2. const items = []
    3. const itemsCopy = []
    4. const len = items.length
    5. let i
    7. // bad
    8. for (i = 0; i < len; i++) {
    9.   itemsCopy[i] = items[i]
    10. }
    12. // good
    13. itemsCopy = [...items]

  • 使用数组的 map 等方法时，请使用 return 声明，如果是单一声明语句的情况，可省略 return

    1. // good
    2. [1, 2, 3].map(x => {
    3.   const y = x + 1
    4.   return x * y
    5. })
    7. // good
    8. [1, 2, 3].map(x => x + 1)
    10. // bad
    11. const flat = {}
    12. [[0, 1], [2, 3], [4, 5]].reduce((memo, item, index) => {
    13.   const flatten = memo.concat(item)
    14.   flat[index] = flatten
    15. })
    17. // good
    18. const flat = {}
    19. [[0, 1], [2, 3], [4, 5]].reduce((memo, item, index) => {
    20.   const flatten = memo.concat(item)
    21.   flat[index] = flatten
    22.   return flatten
    23. })
    25. // bad
    26. inbox.filter((msg) => {
    27.   const { subject, author } = msg
    28.   if (subject === 'Mockingbird') {
    29.     return author === 'Harper Lee'
    30.   } else {
    31.     return false
    32.   }
    33. })
    35. // good
    36. inbox.filter((msg) => {
    37.   const { subject, author } = msg
    38.   if (subject === 'Mockingbird') {
    39.     return author === 'Harper Lee'
    40.   }
    42.   return false
    43. })

解构赋值

  • 当需要使用对象的多个属性时，请使用解构赋值

    1. // bad
    2. function getFullName (user) {
    3.   const firstName = user.firstName
    4.   const lastName = user.lastName
    6.   return `${firstName} ${lastName}`
    7. }
    9. // good
    10. function getFullName (user) {
    11.   const { firstName, lastName } = user
    13.   return `${firstName} ${lastName}`
    14. }
    16. // better
    17. function getFullName ({ firstName, lastName }) {
    18.   return `${firstName} ${lastName}`
    19. }

  • 当需要使用数组的多个值时，请同样使用解构赋值

    1. const arr = [1, 2, 3, 4]
    3. // bad
    4. const first = arr[0]
    5. const second = arr[1]
    7. // good
    8. const [first, second] = arr

  • 函数需要回传多个值时，请使用对象的解构，而不是数组的解构

    1. // bad
    2. function doSomething () {
    3.   return [top, right, bottom, left]
    4. }
    6. // 如果是数组解构，那么在调用时就需要考虑数据的顺序
    7. const [top, xx, xxx, left] = doSomething()
    9. // good
    10. function doSomething () {
    11.   return { top, right, bottom, left }
    12. }
    14. // 此时不需要考虑数据的顺序
    15. const { top, left } = doSomething()

字符串

  • 字符串统一使用单引号的形式 ''

    1. // bad
    2. const department = "JDC"
    4. // good
    5. const department = 'JDC'

  • 字符串太长的时候，请不要使用字符串连接符换行 \，而是使用 +

    1. const str = '大象集团信息技术部 大象集团信息技术部 大象集团信息技术部' +
    2.   '大象集团信息技术部 大象集团信息技术部 大象集团信息技术部' +
    3.   '大象集团信息技术部 大象集团信息技术部'

  • 程序化生成字符串时，请使用模板字符串

    1. const test = 'test'
    3. // bad
    4. const str = ['a', 'b', test].join()
    6. // bad
    7. const str = 'a' + 'b' + test
    9. // good
    10. const str = `ab${test}`

函数

  • 请使用函数声明，而不是函数表达式

    1. // bad
    2. const foo = function () {
    3.   // do something
    4. }
    6. // good
    7. function foo () {
    8.   // do something
    9. }

  • 不要在非函数代码块中声明函数

    1. // bad
    2. if (isUse) {
    3.   function test () {
    4.     // do something
    5.   }
    6. }
    8. // good
    9. let test
    10. if (isUse) {
    11.   test = () => {
    12.     // do something
    13.   }
    14. }

  • 不要使用 arguments，可以选择使用 ...

    arguments 只是一个类数组，而 ... 是一个真正的数组

    1. // bad
    2. function test () {
    3.   const args = Array.prototype.slice.call(arguments)
    4.   return args.join('')
    5. }
    7. // good
    8. function test (...args) {
    9.   return args.join('')
    10. }

  • 不要更改函数参数的值

    1. // bad
    2. function test (opts) {
    3.   opts = opts || {}
    4. }
    6. // good
    7. function test (opts = {}) {
    8.   // ...
    9. }

原型

  • 使用 class，避免直接操作 prototype

    1. // bad
    2. function Queue (contents = []) {
    3.   this._queue = [..contents]
    4. }
    5. Queue.prototype.pop = function () {
    6.   const value = this._queue[0]
    7.   this._queue.splice(0, 1)
    8.   return value
    9. }
    11. // good
    12. class Queue {
    13.   constructor (contents = []) {
    14.     this._queue = [...contents]
    15.   }
    17.   pop () {
    18.     const value = this._queue[0]
    19.     this._queue.splice(0, 1)
    20.     return value
    21.   }
    22. }

模块

  • 使用标准的 ES6 模块语法 import 和 export

    1. // bad
    2. const util = require('./util')
    3. module.exports = util
    5. // good
    6. import Util from './util'
    7. export default Util
    9. // better
    10. import { Util } from './util'
    11. export default Util

  • 不要使用 import 的通配符 *，这样可以确保你只有一个默认的 export

    1. // bad
    2. import * as Util from './util'
    4. // good
    5. import Util from './util'

迭代器

  • 不要使用 iterators

    1. const numbers = [1, 2, 3, 4, 5]
    3. // bad
    4. let sum = 0
    5. for (let num of numbers) {
    6.   sum += num
    7. }
    9. // good
    10. let sum = 0
    11. numbers.forEach(num => sum += num)
    13. // better
    14. const sum = numbers.reduce((total, num) => total + num, 0)

对象属性

  • 使用 . 来访问对象属性

    1. const joke = {
    2.   name: 'haha',
    3.   age: 28
    4. }
    6. // bad
    7. const name = joke['name']
    9. // good
    10. const name = joke.name

变量声明

  • 声明变量时，请使用 const、let 关键字，如果没有写关键字，变量就会暴露在全局上下文中，这样很可能会和现有变量冲突，另外，也很难明确该变量的作用域是什么。这里推荐使用 const 来声明变量，我们需要避免全局命名空间的污染。

    1. // bad
    2. demo = new Demo()
    4. // good
    5. const demo = new Demo()

  • 将所有的 const 和 let 分组

    1. // bad
    2. let a
    3. const b
    4. let c
    5. const d
    6. let e
    8. // good
    9. const b
    10. const d
    11. let a
    12. let c
    13. let e

Hoisting

  • var 存在变量提升的情况，即 var 声明会被提升至该作用域的顶部，但是他们的赋值并不会。而 const 和 let 并不存在这种情况，他们被赋予了 Temporal Dead Zones, TDZ

    1. function example () {
    2.   console.log(notDefined)   // => throws a ReferenceError
    3. }
    5. function example () {
    6.   console.log(declareButNotAssigned)  // => undefined
    7.   var declaredButNotAssigned = true
    8. }
    10. function example () {
    11.   let declaredButNotAssigned
    12.   console.log(declaredButNotAssigned)   // => undefined
    13.   declaredButNotAssigned = true
    14. }
    16. function example () {
    17.   console.log(declaredButNotAssigned)   // => throws a ReferenceError
    18.   console.log(typeof declaredButNotAssigned)  // => throws a ReferenceError
    19.   const declaredButNotAssigned = true
    20. }

  • 匿名函数的变量名会提升，但函数内容不会

    1. function example () {
    2.   console.log(anonymous)  // => undefined
    4.   anonymous()
    6.   var anonymous = function () {
    7.     console.log('test')
    8.   }
    9. }

  • 命名的函数表达式的变量名会被提升，但函数名和函数函数内容并不会

    1. function example() {
    2.   console.log(named)  // => undefined
    4.   named()   // => TypeError named is not a function
    6.   superPower()  // => ReferenceError superPower is not defined
    8.   var named = function superPower () {
    9.     console.log('Flying')
    10.   }
    11. }
    13. function example() {
    14.   console.log(named)  // => undefined
    16.   named()   // => TypeError named is not a function
    18.   var named = function named () {
    19.     console.log('named')
    20.   }
    21. }

分号

  • 我们遵循 Standard 的规范，不使用分号。

    关于应不应该使用分号的讨论有很多，本规范认为非必要的时候，应该不使用分号，好的 JS 程序员应该清楚场景下是一定要加分号的，相信你也是名好的开发者。

    1. // bad
    2. const test = 'good';
    3. (function () {
    4.   const str = 'hahaha';
    5. })()
    7. // good
    8. const test = 'good'
    9. ;(() => {
    10.   const str = 'hahaha'
    11. })();

标准特性

为了代码的可移植性和兼容性，我们应该最大化的使用标准方法，例如优先使用 string.charAt(3) 而不是 string[3]

eval()

由于 eval 方法比较 evil，所以我们约定禁止使用该方法

with() {}

由于 with 方法会产生神奇的作用域，所以我们也是禁止使用该方法的

for-in 循环

推荐使用 for in 语法，但是在对对象进行操作时，容易忘了检测 hasOwnProperty(key)，所以我们启用了 ESLint 的 guard-for-in 选项

对数组进行 for in 的时候，顺序是不固定的

修改内置对象的原型

不要修改内置对象，如 Object 和 Array