RUI 是一套基础样式库

代码规范 #

缩进 #

• 嵌套元素应当缩进一次（即四个空格）。
• Tab 缩进用四个空格来代替制表符（tab）代码行缩进。

样式 #

通用样式命名 #

• 以一个英文单词命名（非组件样式）。

函数命名 #

• 根据styl特性，里面的函数命名使用横杠 - 非驼峰命名、非下划线命名。
• 函数统一放到 mixins/... 目录中。

变量命名 #

• stylus中全局变量一定是下划线连接 _，与CSS区分如font-weight:bold。
• 全局样式放到 variables.styl 中。
• 英文单词命名拒绝拼音。

CSS语法 #

CSS 全部使用stylus 这里是 stylus 使用语法

• 为选择器分组时，将单独的选择器单独放在一行。
• 声明块的右花括号，stylus 一般情况没有，请查看官方文档。
• 每条声明语句的 : 后应该插入一个空格。
• 请不要在样式后面跟分号（例如，margin: 10px 代替 margin: 10px;）。
• 为选择器中的属性添加双引号，如：input[type="text"]。
• 不要在 rgb()、rgba()、hsl()、hsla() 或 rect() 值的内部的逗号后面插入空格。
• 避免为 0 值指定单位，例如，用 margin: 0 代替 margin: 0px。
• 对于属性值或颜色参数，省略小于 1 的小数前面的 0 （例如，.5 代替 0.5；-.5px 代替 -0.5px）。
• 尽量使用简写形式的十六进制值，例如，用 #fff 代替 #ffffff。
• 十六进制值应该全部小写，例如，#fff。
• 对于以逗号分隔的属性值，每个逗号后面都应该插入一个空格（例如，box-shadow）。

工具使用 #

编辑器配置 #

将你的编辑器按照下面的配置进行设置，以避免常见的代码不一致和差异：

• 用两个空格代替制表符（soft-tab 即用空格代表 tab 符）。
• 保存文件时，删除尾部的空白符。
• 设置文件编码为 UTF-8。
• 在文件结尾添加一个空白行。

CSS #

CSS 使用Stylus工具写，请不要使用Less、Sass

• sublime代码提示插件 Stylus Clean Completions
• 官方文档
• 张鑫旭中文翻译、
• Try Stylus!

js #

js 请不要使用 CoffeeScript、TypeScript

自动化工具 #

我们使用 gulp 不要使用 grunt