编码规范

前端编码规范工程化

立刻进入 →

完善的规范生态

支持对全部前端配置实现一键接入、一键扫描、一键修复、一键升级

支持 Typescript

提供完整的类型注释,帮助您从 0~1 掌握完整的前端规范化

完整的测试用例

配套完整的测试用例,帮助您提升项目健壮性

# 🛋 配套工具

我们引入了多个业界流行的 Linter 作为规约文档的配套工具,并根据规约内容定制了对应的规则包,它们包括:

规约 Lint 工具 NPM包
JavaScript 编码规范 TypeScript 编码规范 Node 编码规范 ESLint (opens new window) cd-eslint-config (opens new window)
CSS 编码规范 stylelint (opens new window) cd-stylelint-config (opens new window)
Git 规范 commitlint (opens new window) cd-commitlint-config (opens new window)
文档规范 markdownlint (opens new window) cd-markdownlint-config (opens new window)

cd-spec-cli (opens new window) 收敛屏蔽了上述依赖和配置细节,提供简单的 CLINode.js API,让项目能够一键接入、一键扫描、一键修复、一键升级,并为项目配置 git commit 卡口,降低项目接入规约的成本。

您可以使用cd-spec-cli (opens new window) 方便地为项目接入全部规范。


# ✉️ 联系

GitHub: https://github.com/chendie-dev/cd-spec (opens new window)