cd-spec

印客学院 前端编码规范工程化

⛰ 能力支持

1. 完善的规范生态

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

2. 支持 Typescript

提供完整的类型注释

3. 完整的测试用例

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

🛋 配套工具

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

规约	Lint 工具	npm 包
JavaScript 编码规范 TypeScript 编码规范 Node 编码规范	ESLint	cd-eslint-config
CSS 编码规范	stylelint	cd-stylelint-config
Git 规范	commitlint	cd-commitlint-config
文档规范	markdownlint	cd-markdownlint-config

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

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

其他

测试 markdown config

全局安装 markdownlint-cli

npm i -g markdownlint-cli
pnpm run lint

生成 CHANGELOG

参考conventional-changelog-cli，全局安装 conventional-changelog-cli：

npm install -g conventional-changelog-cli
pnpm run changelog

设置 husky

pnpm husky install

✉️ 联系

• 编码规范工程化 https://github.com/chendie-dev/cd-spec/
• GitHub: https://github.com/chendie-dev/cd-spec