小而合理的前端理论：rscss和rsjs

摘要：对命名方式的解释推荐的短横线作为前缀的名可能会让你有一点惊讶，可以这样写的吗答案是的确可以，而且搭配得还相当巧妙。如果是多个组件使用的数据，可以使用里的标签。所有第三方库的代码可以集中到一个类似的文件，并和站点本身的代码各自独立。

在前端开发中，我们会尝试去定一些规则和约定，来让项目质量更高，更易于维护。而对于这些规则和约定，我们也会希望它内容简单，容易理解。

rscss和rsjs是一套比较新，也比较小巧的前端开发规则和约定，其中rs代表Reasonable System，所以可以理解为，追求“合理”的css和js。本文除了介绍它们，还会有一点补充以及我自己的看法，也推荐你点击链接阅读原作者给出的完整内容。

rscss希望有效地改善写css中的这样几个常见问题（css哲学三问）：

这个class到底什么意思？

这个class还有地方用到吗？

我新写的这个class，会有冲突吗？

rscss首先推崇的是以组件（Components）为基础的思考方式。在各类前端框架中，几乎都可以看到组件，如Bootstrap和Materialize：

一个组件是这样的感觉：

小到一个按钮，大到整个web应用，可见的视觉元素都可以这样当做一个组件。

rscss推荐组件至少使用两个单词的命名，中间用短横线（-）连接：

.search-form { /* ... */ }
.article-card { /* ... */ }

组件内部的更细小的部分，当做组件的元素（Elements）。

为了和前面的组件区分开来，元素的命名只使用一个单词。

显然，只有一个单词是很容易冲突的，因此rscss建议以关系选择符把元素和组件关联起来：

.search-form > .field { /* ... */ }
.search-form > .action { /* ... */ }

推荐子选择符 > 而不是包含选择符 (空格)，以更好地避免冲突：

.article-card .title { /* okay */ }
.article-card > .author { /* ✓ better */ }

如果确实需要用到多个单词，直接连接它们（不使用短横线等分隔符），以体现区别：

.profile-box > .firstname { /* ... */ }

为每一个组件的元素使用class名，不要使用标签选择符。有名字的元素会更有语义。

无论是组件还是元素，都可以有多种属性或状态（Variants，也可以叫变体）：

使用短横线（-）开头来命名表示属性或状态的class。

/* component variants */
.like-button.-wide { /* ... */ }
.like-button.-disabled { /* ... */ }

/* element variants */
.shopping-card > .title.-small { /* ... */ }

rscss推荐的短横线作为前缀的class名可能会让你有一点惊讶，可以这样写的吗？答案是的确可以，而且搭配得还相当巧妙。为什么这么说呢？请看w3c对css标识符的解释：

In CSS, identifiers (including element names, classes, and IDs in selectors) can contain only the characters [a-zA-Z0-9] and ISO 10646 characters U+0080 and higher, plus the hyphen (-) and the underscore (_); they cannot start with a digit, two hyphens, or a hyphen followed by a digit.

其中ISO 10646等同于Unicode。可以看到，w3c特意在css标识符一般使用的英文字母、数字以及一部分Unicode字符（U+0080以上）之外，提到了短横线（-）和下划线（_）也是可用的。

以短横线作为前缀的class名相当于有了一个特殊的标记，一眼就可以提醒你这是一个表示属性或状态的class。

组件是可以嵌套的。

对应html类似这样：

  

    ...
  
  
...
  
...

当一个组件位于另一个组件内部的时候，可能会想要这个组件表现得特别一点。这个时候，建议不要使用关系选择符把它们耦合在一起：

.article-header > .vote-box > .up { /* ✗ avoid this */ }

建议的做法是为组件增加一个属性或状态class：

  

    ...
  
  ...

然后以这个class为基础来定义特别的样式：

.vote-box.-highlight > .up { /* ... */ }

这样做的目的是让一个组件的样式不依赖其所处的位置。OOCSS的原则之一，Separate container and content，也是这样的理念。

rscss推荐除一些具有固定宽高的特定元素（如头像，logo）外，
组件本身不定义任何影响布局位置的属性：

定位（position、top、left、right、bottom）

浮动（float、clear）

外边距（margin）

尺寸（width、height）

这样做的意思是说，如果把组件看做一个整体，它应该是自适应的。

如果要定义组件的影响布局位置的属性，建议使用关系选择符把组件和它所处的环境关联起来：

.article-list > .article-card {
    width: 33.3%;
    float: left;
}

.article-card { /* ... */ }
.article-card > .image { /* ... */ }
.article-card > .title { /* ... */ }
.article-card > .category { /* ... */ }

在上面这段代码可以注意到，“组件本身的外观”与“组件在某一环境中的位置”被明确地分离了。

rscss推荐辅助类（Helpers）多带带存放一个文件，且class名以下划线（_）开头。辅助类也常会用到!important，对应的，应尽可能少使用辅助类。

._pull-left { float: left !important; }
._pull-right { float: right !important; }

下划线（_）作为前缀的class名，如前文已经解释过的那样，也是作为一个特殊的标记提醒你这是一个辅助类，请谨慎使用它。

辅助类在前端框架中也很常见。

rscss的组件（Component），元素（Element）等概念，在BEM、SMACSS这些css理论中也有类似的存在。它们比较起来是这样的：

关于BEM、SMACSS以及前文出现过的OOCSS的介绍，可以参考以前的这篇文章。

以上就是rscss的主要内容了，下面来看看rsjs。

rsjs关注的是非单页应用（non-SPA web application），也就是我们通常理解的有很多页，主要使用jQuery，而且每个页都可以有自己的.js文件的传统网站。

现在已经有了可遵循的JavaScript代码本身的风格指南，因此，rsjs只对一些其他的要点提出建议，如命名空间，文件组织方式。

rsjs推荐把由JavaScript实现的交互功能当做一次只影响一个组件（Component）的行为（Behavior）。下面是一个参考示例：

  Expand

  Home
  
...

/* Behavior - behaviors/collapsible-nav.js */

$(function () {
  var $nav = $("[data-js-collapsible-nav]");
  if (!$nav.length) return;

  $nav
    .on("click", "[data-js-expand]", function () {
      $nav.addClass("-expanded");
    })
    .on("mouseout", function () {
      $nav.removeClass("-expanded");
    });
});

这其中包含了多项建议。

建议使用html5的data自定义属性data-js-___来标记和一个行为有关的DOM元素。

相比用ID和class来选取元素，这种data属性的形式一方面更具有明确的意义，提醒你这是一个和交互行为有关的元素，另一方面更易于复用，在任何DOM结构里添加这样的data属性即可获得对应的行为。

建议每一个行为对应的JavaScript代码都分离到多带带的文件里，并以文件名明示。文件名可以参照data-js-___这个属性名里的对应名称，这样，根据属性名就很容易找到对应的JavaScript代码。

一个可能的文件目录结构：

└── javascripts/
    └── behaviors/
            ├── collapsible-nav.js
            ├── avatar-hover.js
            ├── popup-dialog.js
            └── notification.js

在html中不要以或onclick=""等形式添加行内JavaScript代码。通过保持行为的逻辑代码独立于html，可以使代码更易于维护。

从rsjs的内容来看，在已有React、Vue等库的今天，“行为独立于内容”的约定仍然对传统的以jQuery为主的Web应用有一定意义。

传统Web站点的一个常见的场景是，后端语言在页面中预先输出某些数据，然后JavaScript会取用它们。你可能见到过下面这样

rsjs建议的方案是，如果这些数据只需要一个组件使用，可以利用之前提到的data属性（保存为值），由行为的JavaScript代码来自行取出。

  ...
  
  

  
  
  

if (!window.App) window.App = {};

App.Editor = function() {
  // ...
};

/* helpers/format_error.js */
if (!window.Helpers) window.Helpers = {};

Helpers.formatError = function (err) {
  return "" + err.project_id + " error: " + err.message;
};

// select2.js -- affects `[data-js-select2]`
$(function () {
  $("[data-js-select2]").select2();
});