Frontend Guidelines
HTML
Semantics（语义化）
为了更精确地描述我们的网页内容，HTML5提供了许多语义化标签，你应该确保从丰富的词汇中受益：
<!-- bad -->
<div id="main">
<div class="article">
<div class="header">
<h1>Blog post</h1>
<p>Published: <span>21st Feb, 2015</span></p>
</div>
<p>…</p>
</div>
</div>
<!-- good -->
<main>
<article>
<header>
<h1>Blog post</h1>
<p>Published: <time datetime="2015-02-21">21st Feb, 2015</time></p>
</header>
<p>…</p>
</article>
</main>
确保理解你使用的元素的语义，错误地使用一个语义比不用更糟糕。
<!-- bad -->
<h1>
<figure>
<img alt=Company src=logo.png>
</figure>
</h1>
<!-- good -->
<h1>
<img alt=Company src=logo.png>
</h1>
Brevity（简介）
让你的代码简洁。忘记你的旧的XHTML的习惯。
<!-- bad -->
<!doctype html>
<html lang=en>
<head>
<meta http-equiv=Content-Type content="text/html; charset=utf-8" />
<title>Contact</title>
<link rel=stylesheet href=style.css type=text/css />
</head>
<body>
<h1>Contact me</h1>
<label>
Email address:
<input type=email placeholder=you@email.com required=required />
</label>
<script src=main.js type=text/javascript></script>
</body>
</html>
<!-- good -->
<!doctype html>
<html lang=en>
<meta charset=utf-8>
<title>Contact</title>
<link rel=stylesheet href=style.css>
<h1>Contact me</h1>
<label>
Email address:
<input type=email placeholder=you@email.com required>
</label>
<script src=main.js></script>
</html>
Accessibility（可访问性）
可访问性不是个事后想法，你不必是一个WCAG专家来改善你的
网站，你可以立即开始通过固定的小东西，达到一个巨大的效果，如：
- 学会合理的使用
alt属性 - 不是完全依赖颜色来进行信息交流
*显式标记窗体控件
<!-- bad -->
<h1><img alt="Logo" src="logo.png"></h1>
<!-- good -->
<h1><img alt="My Company, Inc." src="logo.png"></h1>
Language（语言）
定义语言和字符编码是可选的，建议总是声明它们为文档级别的，即使他们在你的HTTP标头中指定。在任何其他支持UTF-8字符编码
<!-- bad -->
<!doctype html>
<title>Hello, world.</title>
<!-- good -->
<!doctype html>
<html lang=en>
<meta charset=utf-8>
<title>Hello, world.</title>
</html>
Performance（性能）
除非有必要的理由，否则不要让你的script文件阻止渲染你的页面。如果你的样式表是沉重的，隔离最初的风格绝对必需，并将二次声明的延迟加载在一个单独的样式表中。
两个HTTP请求比明显变慢，但速度的感知是最重要的因素。
<!-- bad -->
<!doctype html>
<meta charset=utf-8>
<script src=analytics.js></script>
<title>Hello, world.</title>
<p>...</p>
<!-- good -->
<!doctype html>
<meta charset=utf-8>
<title>Hello, world.</title>
<p>...</p>
<script src=analytics.js></script>
CSS
Semicolons（分号）
当分号是CSS技术上的分离器时，应该总是用它来结束语句。
/* bad */
div {
color: red
}
/* good */
div {
color: red;
}
Box model（盒子模型）
盒子模型应该为整个文档是一样的。一个全局的 “* { box-sizing:border-box;}” 是可以的,但，如果你能避免的话，请不要在特定元素里面改变它的默认盒模型。
/* bad */
div {
width: 100%;
padding: 10px;
box-sizing: border-box;
}
/* good */
div {
padding: 10px;
}
Flow
能避免的话，不要改变一个元素的默认行为。尽可能保持它的自然文本流。例如，移除图片下面的空白间隙不应该改变图片的默认显示。
/* bad */
img {
display: block;
}
/* good */
img {
vertical-align: middle;
}
同样，尽量不要使元素脱离文本流。
/* bad */
div {
width: 100px;
position: absolute;
right: 0;
}
/* good */
div {
width: 100px;
margin-left: auto;
}
Positioning（定位）
There are many ways to position elements in CSS but try to restrict yourself to the properties/values below. By order of preference:
在CSS有很多方法来定位元素，但是尽可能限制自己的属性/值在下面。按优先顺序:
display: block;
display: flex;
position: relative;
position: sticky;
position: absolute;
position: fixed;
Selectors（选择器）
减少紧密耦合DOM的选择器。当您的选择器超过了3个结构的伪类、后代或兄弟选择器，考虑添加一个类到要匹配的元素。
/* bad */
div:first-of-type :last-child > p ~ *
/* good */
div:first-of-type .info
Avoid overloading your selectors when you don't need to.
/* bad */
img[src$=svg], ul > li:first-child {
opacity: 0;
}
/* good */
[src$=svg], ul > :first-child {
opacity: 0;
}
Specificity（专一性）
不要使属性值和选择器难以覆盖，减少使用“id”和避免使用“!important”。
/* bad */
.bar {
color: green !important;
}
.foo {
color: red;
}
/* good */
.foo.bar {
color: green;
}
.foo {
color: red;
}
Overriding
覆盖样式使选择器和调试变得困难，尽量避免
/* bad */
li {
visibility: hidden;
}
li:first-child {
visibility: visible;
}
/* good */
li + li {
visibility: hidden;
}
Inheritance
不要重复可以继承的样式。
/* bad */
div h1, div p {
text-shadow: 0 1px 0 #fff;
}
/* good */
div {
text-shadow: 0 1px 0 #fff;
}
Brevity（简洁）
保持你代码的简洁性。使用简写属性，并避免使用多个属性在非必要时。
/* bad */
div {
transition: all 1s;
top: 50%;
margin-top: -10px;
padding-top: 5px;
padding-right: 10px;
padding-bottom: 20px;
padding-left: 10px;
}
/* good */
div {
transition: 1s;
top: calc(50% - 10px);
padding: 5px 10px 20px;
}
Language（语言）
喜欢英语胜过数学。
/* bad */
:nth-child(2n + 1) {
transform: rotate(360deg);
}
/* good */
:nth-child(odd) {
transform: rotate(1turn);
}
Vendor prefixes（前缀）
Kill obsolete vendor prefixes aggressively. If you need to use them, insert them before the
standard property.
不要使用过时的前缀。如果你需要使用它们,把它们插入标准属性之前。
/* bad */
div {
transform: scale(2);
-webkit-transform: scale(2);
-moz-transform: scale(2);
-ms-transform: scale(2);
transition: 1s;
-webkit-transition: 1s;
-moz-transition: 1s;
-ms-transition: 1s;
}
/* good */
div {
-webkit-transform: scale(2);
transform: scale(2);
transition: 1s;
}
Animations（动画）
transitions 好于 animations. 避免使opacity and transform以外的属性产生动画效果.
/* bad */
div:hover {
animation: move 1s forwards;
}
@keyframes move {
100% {
margin-left: 100px;
}
}
/* good */
div:hover {
transition: 1s;
transform: translateX(100px);
}
Units
可以的话，使用无单位属性值，如果使用相对单位，更青睐于‘rem’，秒好于毫秒。
/* bad */
div {
margin: 0px;
font-size: .9em;
line-height: 22px;
transition: 500ms;
}
/* good */
div {
margin: 0;
font-size: .9rem;
line-height: 1.5;
transition: .5s;
}
Colors（颜色）
如果你需要透明效果,使用rgba”。否则,总是使用十六进制格式。
/* bad */
div {
color: hsl(103, 54%, 43%);
}
/* good */
div {
color: #5a3;
}
Drawing（绘）
当资源容易用css代替的话，避免HTTP请求
/* bad */
div::before {
content: url(white-circle.svg);
}
/* good */
div::before {
content: "";
display: block;
width: 20px;
height: 20px;
border-radius: 50%;
background: #fff;
}
Hacks
不要使用它们。
/* bad */
div {
// position: relative;
transform: translateZ(0);
}
/* good */
div {
/* position: relative; */
will-change: transform;
}
JavaScript
Performance（性能）
可读性、正确性和表现性比性能更重要，JavaScript基本上永远不会成为你的性能瓶颈，优化一些东西，像图像压缩、网络访问,而不是DOM回流。如果你还记得一个指导方针从这个文档,选择这一个。
// bad (albeit way faster)
const arr = [1, 2, 3, 4];
const len = arr.length;
var i = -1;
var result = [];
while (++i < len) {
var n = arr[i];
if (n % 2 > 0) continue;
result.push(n * n);
}
// good
const arr = [1, 2, 3, 4];
const isEven = n => n % 2 == 0;
const square = n => n * n;
const result = arr.filter(isEven).map(square);
Statelessness
尽量保持你函数的纯净. 所有的功能都应该没有产生其他副作用,使用没有外部数据并返回新对象而不是改变现有的。
// bad
const merge = (target, ...sources) => Object.assign(target, ...sources);
merge({ foo: "foo" }, { bar: "bar" }); // => { foo: "foo", bar: "bar" }
// good
const merge = (...sources) => Object.assign({}, ...sources);
merge({ foo: "foo" }, { bar: "bar" }); // => { foo: "foo", bar: "bar" }
Natives
尽可能使用原生的方法。
// bad
const toArray = obj => [].slice.call(obj);
// good
const toArray = (() =>
Array.from ? Array.from : obj => [].slice.call(obj)
)();
Coercion
Embrace implicit coercion when it makes sense. Avoid it otherwise. Don't cargo-cult.
// bad
if (x === undefined || x === null) { ... }
// good
if (x == undefined) { ... }
Loops
Don't use loops as they force you to use mutable objects. Rely on array.prototype methods.
不要使用循环,如果他们强迫你使用可变的对象。依赖array.prototype方法。
// bad
const sum = arr => {
var sum = 0;
var i = -1;
for (;arr[++i];) {
sum += arr[i];
}
return sum;
};
sum([1, 2, 3]); // => 6
// good
const sum = arr =>
arr.reduce((x, y) => x + y);
sum([1, 2, 3]); // => 6
如果你不能，或者如果使用array.prototype被认为是滥用的，那么使用递归。
// bad
const createDivs = howMany => {
while (howMany--) {
document.body.insertAdjacentHTML("beforeend", "<div></div>");
}
};
createDivs(5);
// bad
const createDivs = howMany =>
[...Array(howMany)].forEach(() =>
document.body.insertAdjacentHTML("beforeend", "<div></div>")
);
createDivs(5);
// good
const createDivs = howMany => {
if (!howMany) return;
document.body.insertAdjacentHTML("beforeend", "<div></div>");
return createDivs(howMany - 1);
};
createDivs(5);
Arguments
忘记 arguments 对象， rest参数是更好地选择，因为:
- 他的名字更容易让你知道该函数所希望的参数是什么。
- 这是一个真正的数组, 更容易使用.
// bad
const sortNumbers = () =>
Array.prototype.slice.call(arguments).sort();
// good
const sortNumbers = (...numbers) => numbers.sort();
Apply
忘记 apply(). 使用扩展运算符代替。
const greet = (first, last) => `Hi ${first} ${last}`;
const person = ["John", "Doe"];
// bad
greet.apply(null, person);
// good
greet(...person);
Bind
不要使用bind() 当有更好的方法时.
// bad
["foo", "bar"].forEach(func.bind(this));
// good
["foo", "bar"].forEach(func, this);
// bad
const person = {
first: "John",
last: "Doe",
greet() {
const full = function() {
return `${this.first} ${this.last}`;
}.bind(this);
return `Hello ${full()}`;
}
}
// good
const person = {
first: "John",
last: "Doe",
greet() {
const full = () => `${this.first} ${this.last}`;
return `Hello ${full()}`;
}
}
Higher-order functions（高阶函数）
不要嵌套函数，当非必要时
// bad
[1, 2, 3].map(num => String(num));
// good
[1, 2, 3].map(String);
Composition
Avoid multiple nested function calls. Use composition instead.
避免调用多个嵌套函数。使用组合代替。
const plus1 = a => a + 1;
const mult2 = a => a * 2;
// bad
mult2(plus1(5)); // => 12
// good
const pipeline = (...funcs) => val => funcs.reduce((a, b) => b(a), val);
const addThenMult = pipeline(plus1, mult2);
addThenMult(5); // => 12
Caching
缓存功能测试、大数据结构和复杂的操作
// bad
const contains = (arr, value) =>
Array.prototype.includes
? arr.includes(value)
: arr.some(el => el === value);
contains(["foo", "bar"], "baz"); // => false
// good
const contains = (() =>
Array.prototype.includes
? (arr, value) => arr.includes(value)
: (arr, value) => arr.some(el => el === value)
)();
contains(["foo", "bar"], "baz"); // => false
Variables（变量）
使用 const 好于 let ，而 let 好于 var.
// bad
var me = new Map();
me.set("name", "Ben").set("country", "Belgium");
// good
const me = new Map();
me.set("name", "Ben").set("country", "Belgium");
Conditions（条件）
用IIFE's来返回语句好于if, else if, else 和switch 语句.
// bad
var grade;
if (result < 50)
grade = "bad";
else if (result < 90)
grade = "good";
else
grade = "excellent";
// good
const grade = (() => {
if (result < 50)
return "bad";
if (result < 90)
return "good";
return "excellent";
})();
Object iteration
尽可能避免使用for...in 。
const shared = { foo: "foo" };
const obj = Object.create(shared, {
bar: {
value: "bar",
enumerable: true
}
});
// bad
for (var prop in obj) {
if (obj.hasOwnProperty(prop))
console.log(prop);
}
// good
Object.keys(obj).forEach(prop => console.log(prop));
Objects as Maps
当对象合法使用情况下,maps通常是一个更好的,更强大的选择。有困惑时,请使用一个“Map”。
// bad
const me = {
name: "Ben",
age: 30
};
var meSize = Object.keys(me).length;
meSize; // => 2
me.country = "Belgium";
meSize++;
meSize; // => 3
// good
const me = new Map();
me.set("name", "Ben");
me.set("age", 30);
me.size; // => 2
me.set("country", "Belgium");
me.size; // => 3
Curry
Currying 是一个非常强大的但对于很多开发者来说却很陌生的范式. 不要滥用它，但合理地使用它却往往给人意想不到的效果
// bad
const sum = a => b => a + b;
sum(5)(3); // => 8
// good
const sum = (a, b) => a + b;
sum(5, 3); // => 8
Readability
不要通过看似聪明的技巧混淆代码的意图。
// bad
foo || doSomething();
// good
if (!foo) doSomething();
// bad
void function() { /* IIFE */ }();
// good
(function() { /* IIFE */ }());
// bad
const n = ~~3.14;
// good
const n = Math.floor(3.14);
Code reuse
不要害怕去创建很多小的、高度可组合的、可重用的功能。
// bad
arr[arr.length - 1];
// good
const first = arr => arr[0];
const last = arr => first(arr.slice(-1));
last(arr);
// bad
const product = (a, b) => a * b;
const triple = n => n * 3;
// good
const product = (a, b) => a * b;
const triple = product.bind(null, 3);
Dependencies
减少依赖关系，第三方代码你不知道,不要为了几个容易复制的方法而去加载一整个库。
// bad
var _ = require("underscore");
_.compact(["foo", 0]));
_.unique(["foo", "foo"]);
_.union(["foo"], ["bar"], ["foo"]);
// good
const compact = arr => arr.filter(el => el);
const unique = arr => [...Set(arr)];
const union = (...arr) => unique([].concat(...arr));
compact(["foo", 0]);
unique(["foo", "foo"]);
union(["foo"], ["bar"], ["foo"]);
