Facebook 的 CSS 代码质量保障之道

Facebook 的 CSS 代码质量保障之道

在 Facebook 里,上千名工程师工作在不同的产品线上,为全世界的用户提供可靠优质的服务,而我们在代码质量管理方面也面临着独一无二的挑战。不仅仅是因为我们面对的是一个庞大的代码基库,还有日渐增加的各种各样的特性,有时候如果你想去重构提高某一个模块,往往会影响到其他很多模块。具体在 CSS 而言,我们需要处理上千份不停变化的 CSS 文件。之前我们着力于通过 Code Review、代码样式规范以及重构等手段协同工作,而保障代码质量,但是还是会有很多的错误悄悄从眼皮底下溜走,被提交进入到代码库里。我们一直用自建的 CSS Linter 来检测基本的代码错误与保证一致的编码风格,尽管它基本上已经满足了我们的目标,但还是存在很多的问题,因此我也想在这篇文章里对如何保障 CSS 的代码质量进行一些讨论。

Regex is not Enough:之前用的是正则匹配,不咋的啊

老的 Linter 主要是基于很多个正则表达式对 CSS 中的语法进行提取,大概是这个样子的:
1
preg_match_all(
2
// This pattern matches [attr] selectors with no preceding selector.
3
'/\/\*.*?\*\/|\{[^}]*\}|\s(\[[^\]]+\])/s',
4
$data,
5
$matches,
6
PREG_SET_ORDER | PREG_OFFSET_CAPTURE);
7
foreach ($matches as $match) {
8
if (isset($match[1])) {
9
raiseError(...);
10
}
Copied!
基本上一个检测规则就需要添加一个专门的匹配规则,非常不好维护,在性能上也有很大的问题。对于每个规则俺们都需要遍历整个文件,性能差得很。

Abstract Syntax Tree

受够了正则表达式,我们想搞一个更好用的也是更细致的 CSS 解释器。CSS 本身也是一门语言,老把它当做纯文本文件处理也不好,因此我们打算用 AST,即抽象语法树的方式构建一个解析器。这种新的处理方式在性能上面有个很不错的提升,譬如我们的代码库中有这么一段 CSS 代码:
1
{
2
display: none:
3
background-color: #8B1D3;
4
padding: 10px,10px,0,0;
5
opacity: 1.0f;
6
}
Copied!
眼神好的估计才能看出这个代码片段中存在的问题,譬如某个属性名错了、十六进制的颜色代码写错的,分隔符写错了等等。浏览器才不会主动给你报错呢,这样开发者自己也就很难找到错误了。在具体实现上,我们发现PostCSS 是个不错的工具,因此我们选择了Stylelint作为我们新的 Linter 工具,它是基于 PostCSS 构建的,非常的灵活,社区也不错。 就像 JavaScript 中的 Esprima 以及 ESLint 一样,Stylelint 提供了对于完整的 AST 的访问方式,能够让你根据不同的情况更快速简单的访问具体的代码节点,譬如现在我们的检测规则写成了这个样子:
1
root.walkDecls(node => {
2
if (node.prop === 'text-transform' && node.value === 'uppercase') {
3
report({
4
...
5
});
6
}
7
});
Copied!
我们也可以传入一些基本的函数,譬如linear-gradient,就像这个样子:
1
// disallow things like linear-gradient(top, blue, green) w. incorrect first valueroot.walkDecls(node => {
2
const parsedValue = styleParser(node.value);
3
parsedValue.walk(valueNode => {
4
if (valueNode.type === 'function' && valueNode.value === 'linear-gradient') {
5
const firstValueInGradient = styleParser.stringify(valueNode.nodes[0]);
6
if (disallowedFirstValuesInGradient.indexOf(firstValueInGradient) > -1) {
7
report({
8
...
9
});
10
}
11
}
12
});
13
});
Copied!
这样子写出来的检测规则可读性更好,也更好去理解与维护,并且这种方式无论是在怎样的 CSS 格式化的情况下,以及不管规则和声明放在哪边,都能正常地工作。

Custom rules:自定义规则

我们默认使用了一些 Stylelint 内置的规则,譬如declaration-no-important,selector-no-universal, 以及 selector-class-pattern。如何添加自定义规则的方法可以参考built-in plugin mechanism,而我们使用的譬如:
-
  • slow-css-properties 来告警一些性能较差的属性,譬如 opacity 或者 box-shadow
  • filters-with-svg-files 来告警 Edge 中不支持 SVG 的过滤
  • use-variables 来告警那些可以被内置的常量替换的一些变量
  • common-properties-whitelist 来检测是否有些误写的其实不存在的属性
  • mobile-flexbox 来检测一些不被老版本手机浏览器支持的属性
  • text-transform-uppercase 来告警 "text-transform: uppercase",这个在某些语言表现的不友好
我们也贡献了部分规则 以及 ad 插件 itions 给 Stylelint。

Automatic replacement:自动替换

我们检测过程中有一个重要的工作就是自动格式化,Linter 会在发现某些问题的时候问你是否需要根据规则进行替换,这个功能会节约你大量的手动修改校正的时间。一般来说,我们提交代码之前都会审视下 Linter 报出的错误,然后去修复这些错误。可惜的是 Stylelint 并没有内嵌的自动格式化与修复机制,因此我们重写了部分的 Stylelint 的规则来增加一个自动替换与修复的功能。
Could not load image

Test all the things

我们老的 Linter 还有个问题就是没有单元测试,这点就好像代码上线前不进行单元测试一样不靠谱。我们面对的可能是任意格式的处理文本,因此我们也要保证我们的检测规则能够适用于真实有效的环境,这里我们是选择了 Jest 这个测试框架,Stylelint 对它的支持挺好的,然后大概一个单元测试是这个样子:
1
test.ok('div { background-image: linear-gradient( 0deg, blue, green 40%, red ); }','linear gradient with valid syntax');
2
test.notOk('a { background: linear-gradient(top, blue, green); }',
3
message,'linear-gradient with invalid syntax');
Copied!

What‘s next

换一个靠谱的 CSS Linter 工具只是保证高质量的 CSS 的代码的第一步,我们还打算添加很多自定义的检测规则来捕获一些常见的错误,保证使用规定的最佳实践以及统一代码约定规范。我们已经在 JavaScript 的校验中进行了这一工作。 另外对于 React 社区中存在的 CSS-in-JS 这种写法,对于 CSS Linter 也是个不小的挑战,现在的大部分的 Linter 都是着眼于处理传统的 CSS 文件,以后会添加对于 JSX 的处理规范吧。
Last modified 2yr ago