(给前端大全加星标,提升前端技能)
英文:AirBnB,翻译:Kakaka Hou
为什么要在前端大全推送这个系列?
前段时间有读者通过我的个人微信,提议能不能推送一些编程规范的文章。我们以前关注过 Airbnb 在 GitHub 上开源的 JS 编程规范(现在有10万+ star,可见受欢迎程度),但因为篇幅太长,一直没有推送过。现在化整为零,设立这个每天学点 JS 编程规范
系列,把长篇的规范划分成小节推送,方便大家讨论和掌握。
以下就是今天要推荐的 JS 编码规范,欢迎大家结合自己的实践到评论中来探讨。相信有更多前端开发者参与讨论的规范,会更加精彩。
- 以下是正文 -
注意:这个指南假定你正在使用 Babel, 并且需要你使用或等效的使用 babel-preset-airbnb
。同时假定你在你的应用里安装了带有或等效的 airbnb-browser-shims
的shims/polyfills
。
Objects
3.1 使用字面值创建对象. eslint:
no-new-object
// bad const item = new Object(); // good const item = {};
3.2 当创建一个带有动态属性名的对象时,用计算后属性名
Why? 这可以使你将定义的所有属性放在对象的一个地方.
function getKey(k) { return `a key named ${k}`; } // bad const obj = { id: 5, name: 'San Francisco', }; obj[getKey('enabled')] = true; // good getKey('enabled')是动态属性名 const obj = { id: 5, name: 'San Francisco', [getKey('enabled')]: true, };
3.3 用对象方法简写. eslint:
object-shorthand
// bad const atom = { value: 1, addValue: function (value) { return atom.value + value; }, }; // good const atom = { value: 1, // 对象的方法 addValue(value) { return atom.value + value; }, };
3.4 用属性值缩写. eslint:
object-shorthand
Why? 这样写的更少且更可读
const lukeSkywalker = 'Luke Skywalker'; // bad const obj = { lukeSkywalker: lukeSkywalker, }; // good const obj = { lukeSkywalker, };
3.5 将你的所有缩写放在对象声明的开始.
Why? 这样也是为了更方便的知道有哪些属性用了缩写.
const anakinSkywalker = 'Anakin Skywalker'; const lukeSkywalker = 'Luke Skywalker'; // bad const obj = { episodeOne: 1, twoJediWalkIntoACantina: 2, lukeSkywalker, episodeThree: 3, mayTheFourth: 4, anakinSkywalker, }; // good const obj = { lukeSkywalker, anakinSkywalker, episodeOne: 1, twoJediWalkIntoACantina: 2, episodeThree: 3, mayTheFourth: 4, };
3.6 只对那些无效的标示使用引号
''
. eslint:quote-props
Why? 通常我们认为这种方式主观上易读。他优化了代码高亮,并且页更容易被许多JS引擎压缩。
// bad const bad = { 'foo': 3, 'bar': 4, 'data-blah': 5, }; // good const good = { foo: 3, bar: 4, 'data-blah': 5, };
3.7 不要直接调用
Object.prototype
上的方法,如hasOwnProperty
,propertyIsEnumerable
,isPrototypeOf
。Why? 在一些有问题的对象上, 这些方法可能会被屏蔽掉 - 如:
{ hasOwnProperty: false }
- 或这是一个空对象Object.create(null)
// bad console.log(object.hasOwnProperty(key)); // good console.log(Object.prototype.hasOwnProperty.call(object, key)); // best const has = Object.prototype.hasOwnProperty; // 在模块作用内做一次缓存 /* or */ import has from 'has'; // https://www.npmjs.com/package/has // ... console.log(has.call(object, key));
- 3.8 对象浅拷贝时,更推荐使用扩展运算符[就是
...
运算符],而不是Object.assign
。获取对象指定的几个属性时,用对象的rest解构运算符[也是...
运算符]更好。
- 这一段不太好翻译出来, 大家看下面的例子就懂了。^.^
// very bad
const original = { a: 1, b: 2 };
const copy = Object.assign(original, { c: 3 }); // this mutates `original` ಠ_ಠ
delete copy.a; // so does this
// bad
const original = { a: 1, b: 2 };
const copy = Object.assign({}, original, { c: 3 }); // copy => { a: 1, b: 2, c: 3 }
// good es6扩展运算符 ...
const original = { a: 1, b: 2 };
// 浅拷贝
const copy = { ...original, c: 3 }; // copy => { a: 1, b: 2, c: 3 }
// rest 赋值运算符
const { a, ...noA } = copy; // noA => { b: 2, c: 3 }