配套 内测阶段
文档
该规范文档主要包含编码规范和工程规范两大类,包括:
编码规范
- HTML 编码规范
- CSS 编码规范
- JavaScript 编码规范
- TypeScript 编码规范
- Node.js 开发规范
- Vue 编码规范
工程规范
- Git 规范
- 文档规范
- 更新日志规范
- 工程目录及命名规范
- 协作规范
- 版本控制规范
工具
TIP
原则上不需要自己配置 eslint、prettier、commitlint、等 lint 规则,这些由pospal-lint统一生成
我们引入了多个业界流行的 Linter 进行规范落地的配套工具,并根据规范制定对应的规则包,包括:
| 规范 | Lint 工具 | 规则包 |
|---|---|---|
| 《JS/TS 编码规范》 《Vue 编码规范》 | ESLint | @pospal/eslint-config |
| 《CSS 编码规范》 | stylelint | @pospal/stylelint-config |
| 《Git 编码规范》 | commitlint | @pospal/commitlint-config |