来源：https://es6.ruanyifeng.com/#docs/style

本文探讨如何将 ES6 的新语法，运用到编码实践之中，与传统的 JavaScript 语法结合在一起，写出合理的、易于阅读和维护的代码。

多家公司和组织已经公开了它们的风格规范，下面的内容主要参考了 Airbnb 公司的 JavaScript 风格规范。

1. 自动化检查代码质量

1.1 ESLint 的使用

ESLint 是一个语法规则和代码风格的检查工具，可以用来保证写出语法正确、风格统一的代码。
首先，在项目的根目录安装 ESLint

  1. $npm install --save-dev eslint

然后，安装 Airbnb 语法规则，以及 import、a11y、react 插件。

  1. $ npm install --save-dev eslint-config-airbnb
  2. $ npm install --save-dev eslint-plugin-import eslint-plugin-jsx-a11y eslint-plugin-react

最后，在项目的根目录下新建一个.eslintrc文件，配置 ESLint。

  1. {
  2.   "extends": "eslint-config-airbnb"
  3. }

现在就可以检查，当前项目的代码是否符合预设的规则。
index.js文件的代码如下。

  1. var unused = 'I have no purpose!';
  2. function greet() {
  3.     var message = 'Hello, World!';
  4.     console.log(message);
  5. }
  6. greet();

使用 ESLint 检查这个文件，就会报出错误。

  1. $ npx eslint index.js
  2. index.js
  3.   1:1  error  Unexpected var, use let or const instead          no-var
  4.   1:5  error  unused is defined but never used                 no-unused-vars
  5.   4:5  error  Expected indentation of 2 characters but found 4  indent
  6.   4:5  error  Unexpected var, use let or const instead          no-var
  7.   5:5  error  Expected indentation of 2 characters but found 4  indent
  8. ✖ 5 problems (5 errors, 0 warnings)

上面代码说明，原文件有五个错误，其中两个是不应该使用var命令，而要使用let或const；一个是定义了变量，却没有使用；另外两个是行首缩进为 4 个空格，而不是规定的 2 个空格。

1.2 使用UmiJS中的插件

UmiJS将这些规则发布成了一个包 umi-fabric , 这个库提供了 eslint ，stylelint 和 prettier 的一些预设，非常适合所有人使用。所有打开的规则都是对提升代码质量有意义的。

  1. npm install eslint @umijs/fabric --save-dev

并且在根目录 .eslintrc.js 中做如下配置。

  1. const fabric = require('@umijs/fabric');
  2. module.exports = fabric.eslint;

在 vscode 中 eslint 的插件并不会默认的去 lint .ts 文件，需要在 settings.json 中设置

  1. "eslint.validate": [
  2.     "javascript",
  3.     "javascriptreact",
  4.     "typescript",
  5.     "typescriptreact"
  6.   ],

接下来就可以愉快的使用了。使用 eslint fix 一下老的 ts 代码有奇效哦。

2. 规则说明

2.1 块级作用域

（1）let 取代 var
ES6 提出了两个新的声明变量的命令：let和const。其中，let完全可以取代var，因为两者语义相同，而且let没有副作用。

  1. 'use strict';
  2. if (true) {
  3.   let x = 'hello';
  4. }
  5. for (let i = 0; i < 10; i++) {
  6.   console.log(i);
  7. }

上面代码如果用var替代let，实际上就声明了两个全局变量，这显然不是本意。变量应该只在其声明的代码块内有效，var命令做不到这一点。
var命令存在变量提升效用，let命令没有这个问题。

  1. 'use strict';
  2. if (true) {
  3.   console.log(x); // ReferenceError
  4.   let x = 'hello';
  5. }

上面代码如果使用var替代let，console.log那一行就不会报错，而是会输出undefined，因为变量声明提升到代码块的头部。这违反了变量先声明后使用的原则。
所以，建议不再使用var命令，而是使用let命令取代。

（2）全局常量和线程安全
在let和const之间，建议优先使用const，尤其是在全局环境，不应该设置变量，只应设置常量。
const优于let有几个原因。一个是const可以提醒阅读程序的人，这个变量不应该改变；另一个是const比较符合函数式编程思想，运算不改变值，只是新建值，而且这样也有利于将来的分布式运算；最后一个原因是 JavaScript 编译器会对const进行优化，所以多使用const，有利于提高程序的运行效率，也就是说let和const的本质区别，其实是编译器内部的处理不同。

  1. // bad
  2. var a = 1, b = 2, c = 3;
  3. // good
  4. const a = 1;
  5. const b = 2;
  6. const c = 3;
  7. // best
  8. const [a, b, c] = [1, 2, 3];

const声明常量还有两个好处，一是阅读代码的人立刻会意识到不应该修改这个值，二是防止了无意间修改变量值所导致的错误。
所有的函数都应该设置为常量。
长远来看，JavaScript 可能会有多线程的实现（比如 Intel 公司的 River Trail 那一类的项目），这时let表示的变量，只应出现在单线程运行的代码中，不能是多线程共享的，这样有利于保证线程安全。

2.2 字符串

静态字符串一律使用单引号或反引号，不使用双引号。动态字符串使用反引号。

  1. // bad
  2. const a = "foobar";
  3. const b = 'foo' + a + 'bar';
  4. // acceptable
  5. const c = `foobar`;
  6. // good
  7. const a = 'foobar';
  8. const b = `foo${a}bar`;

2.3 解构赋值

使用数组成员对变量赋值时，优先使用解构赋值。

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

函数的参数如果是对象的成员，优先使用解构赋值。

  1. // bad
  2. function getFullName(user) {
  3.   const firstName = user.firstName;
  4.   const lastName = user.lastName;
  5. }
  6. // good
  7. function getFullName(obj) {
  8.   const { firstName, lastName } = obj;
  9. }
  10. // best
  11. function getFullName({ firstName, lastName }) {
  12. }

如果函数返回多个值，优先使用对象的解构赋值，而不是数组的解构赋值。这样便于以后添加返回值，以及更改返回值的顺序。

  1. // bad
  2. function processInput(input) {
  3.   return [left, right, top, bottom];
  4. }
  5. // good
  6. function processInput(input) {
  7.   return { left, right, top, bottom };
  8. }
  9. const { left, right } = processInput(input);

2.4 对象

单行定义的对象，最后一个成员不以逗号结尾。多行定义的对象，最后一个成员以逗号结尾。

  1. // bad
  2. const a = { k1: v1, k2: v2, };
  3. const b = {
  4.   k1: v1,
  5.   k2: v2
  6. };
  7. // good
  8. const a = { k1: v1, k2: v2 };
  9. const b = {
  10.   k1: v1,
  11.   k2: v2,
  12. };

对象尽量静态化，一旦定义，就不得随意添加新的属性。如果添加属性不可避免，要使用Object.assign方法。

  1. // bad
  2. const a = {};
  3. a.x = 3;
  4. // if reshape unavoidable
  5. const a = {};
  6. Object.assign(a, { x: 3 });
  7. // good
  8. const a = { x: null };
  9. a.x = 3;

如果对象的属性名是动态的，可以在创造对象的时候，使用属性表达式定义。

  1. // bad
  2. const obj = {
  3.   id: 5,
  4.   name: 'San Francisco',
  5. };
  6. obj[getKey('enabled')] = true;
  7. // good
  8. const obj = {
  9.   id: 5,
  10.   name: 'San Francisco',
  11.   [getKey('enabled')]: true,
  12. };

上面代码中，对象obj的最后一个属性名，需要计算得到。这时最好采用属性表达式，在新建obj的时候，将该属性与其他属性定义在一起。这样一来，所有属性就在一个地方定义了。

另外，对象的属性和方法，尽量采用简洁表达法，这样易于描述和书写。

  1. var ref = 'some value';
  2. // bad
  3. const atom = {
  4.   ref: ref,
  5.   value: 1,
  6.   addValue: function (value) {
  7.     return atom.value + value;
  8.   },
  9. };
  10. // good
  11. const atom = {
  12.   ref,
  13.   value: 1,
  14.   addValue(value) {
  15.     return atom.value + value;
  16.   },
  17. };

2.5 数组

使用扩展运算符（…）拷贝数组。

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

使用 Array.from 方法，将类似数组的对象转为数组。

  1. const foo = document.querySelectorAll('.foo');
  2. const nodes = Array.from(foo);

2.6 函数

立即执行函数可以写成箭头函数的形式。

  1. (() => {
  2.   console.log('Welcome to the Internet.');
  3. })();

那些使用匿名函数当作参数的场合，尽量用箭头函数代替。因为这样更简洁，而且绑定了 this。

  1. // bad
  2. [1, 2, 3].map(function (x) {
  3.   return x * x;
  4. });
  5. // good
  6. [1, 2, 3].map((x) => {
  7.   return x * x;
  8. });
  9. // best
  10. [1, 2, 3].map(x => x * x);

箭头函数取代Function.prototype.bind，不应再用 self/_this/that 绑定 this。

  1. // bad
  2. const self = this;
  3. const boundMethod = function(...params) {
  4.   return method.apply(self, params);
  5. }
  6. // acceptable
  7. const boundMethod = method.bind(this);
  8. // best
  9. const boundMethod = (...params) => method.apply(this, params);

简单的、单行的、不会复用的函数，建议采用箭头函数。如果函数体较为复杂，行数较多，还是应该采用传统的函数写法。
所有配置项都应该集中在一个对象，放在最后一个参数，布尔值不可以直接作为参数。

  1. // bad
  2. function divide(a, b, option = false ) {
  3. }
  4. // good
  5. function divide(a, b, { option = false } = {}) {
  6. }

不要在函数体内使用 arguments 变量，使用 rest 运算符（…）代替。因为 rest 运算符显式表明你想要获取参数，而且 arguments 是一个类似数组的对象，而 rest 运算符可以提供一个真正的数组。

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

使用默认值语法设置函数参数的默认值。

  1. // bad
  2. function handleThings(opts) {
  3.   opts = opts || {};
  4. }
  5. // good
  6. function handleThings(opts = {}) {
  7.   // ...
  8. }

2.7 Map 结构

注意区分 Object 和 Map，只有模拟现实世界的实体对象时，才使用 Object。如果只是需要key: value的数据结构，使用 Map 结构。因为 Map 有内建的遍历机制。

  1. let map = new Map(arr);
  2. for (let key of map.keys()) {
  3.   console.log(key);
  4. }
  5. for (let value of map.values()) {
  6.   console.log(value);
  7. }
  8. for (let item of map.entries()) {
  9.   console.log(item[0], item[1]);
  10. }

2.8 Class

总是用 Class，取代需要 prototype 的操作。因为 Class 的写法更简洁，更易于理解。

  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. }
  10. // good
  11. class Queue {
  12.   constructor(contents = []) {
  13.     this._queue = [...contents];
  14.   }
  15.   pop() {
  16.     const value = this._queue[0];
  17.     this._queue.splice(0, 1);
  18.     return value;
  19.   }
  20. }

使用extends实现继承，因为这样更简单，不会有破坏instanceof运算的危险。

  1. // bad
  2. const inherits = require('inherits');
  3. function PeekableQueue(contents) {
  4.   Queue.apply(this, contents);
  5. }
  6. inherits(PeekableQueue, Queue);
  7. PeekableQueue.prototype.peek = function() {
  8.   return this._queue[0];
  9. }
  10. // good
  11. class PeekableQueue extends Queue {
  12.   peek() {
  13.     return this._queue[0];
  14.   }
  15. }

2.9 模块

首先，Module 语法是 JavaScript 模块的标准写法，坚持使用这种写法。使用import取代require。

  1. // bad
  2. const moduleA = require('moduleA');
  3. const func1 = moduleA.func1;
  4. const func2 = moduleA.func2;
  5. // good
  6. import { func1, func2 } from 'moduleA';

使用export取代module.exports。

  1. // commonJS的写法
  2. var React = require('react');
  3. var Breadcrumbs = React.createClass({
  4.   render() {
  5.     return <nav />;
  6.   }
  7. });
  8. module.exports = Breadcrumbs;
  9. // ES6的写法
  10. import React from 'react';
  11. class Breadcrumbs extends React.Component {
  12.   render() {
  13.     return <nav />;
  14.   }
  15. };
  16. export default Breadcrumbs;

如果模块只有一个输出值，就使用export default，如果模块有多个输出值，就不使用export default，export default与普通的export不要同时使用。
不要在模块输入中使用通配符。因为这样可以确保你的模块之中，有一个默认输出（export default）。

  1. // bad
  2. import * as myObject from './importModule';
  3. // good
  4. import myObject from './importModule';

如果模块默认输出一个函数，函数名的首字母应该小写。

  1. function makeStyleGuide() {
  2. }
  3. export default makeStyleGuide;

如果模块默认输出一个对象，对象名的首字母应该大写。

  1. const StyleGuide = {
  2.   es6: {
  3.   }
  4. };
  5. export default StyleGuide;

参考内容

  1. ECMAScript 6 入门 - 编码风格 https://es6.ruanyifeng.com/#docs/style
    2. Ant Design Pro - 一起来用 eslint 吧 https://pro.ant.design/blog/use-eslint-typescript-cn
    3. 风格与品位—3个前端代码规范的工具 https://segmentfault.com/a/1190000019856226
    4. Feflow - ESLint 规范 https://feflowjs.com/zh/guide/rule-eslint.html