conform-spec
前端编码规范工程化
🎉 能力支持
1. 全面的前端生态
支持前端全部生态,无需关注环境,支持直接使用
2. 完善的规范配件
支持对全部前端配置实现一键接入、一键扫描、一键修复、一键升级
3. 完整的测试用例
配套完整的测试用例,提升项目健壮性
🛋️ 配套工具
引入了多个业界流行的 Linter
作为规范文档的配套工具,并根据规范内容定制了对应的规则包,它们包括:
规范 | Lint 工具 | npm 包 |
---|---|---|
JavaScript 编码规范 TypeScript 编码规范 Node 编码规范 | ESLint | eslint-config-conform |
CSS 编码规范 | stylelint | stylelint-config-conform |
Git 规范 | commitlint | commitlint-config-conform |
文档规范 | markdownlint | markdownlint-config-conform |
Eslint 插件 | ESlint Plugin | eslint-plugin-conform |
conform-lint 收敛屏蔽了上述依赖和配置细节,提供简单的 CLI
和 Node.js API
,让项目能够一键接入、一键扫描、一键修复、一键升级,并为项目配置 git commit 卡口,降低项目接入规范的成本。
您可以使用conform-lint 方便地为项目接入全部规范。
其他
测试markdown config
全局安装markdownlint-cli
bash
npm i -g markdownlint-cli
pnpm run lint
生成CHANGELOG
参考conventional-changelog-cli,全局安装conventional-changelog-cli
:
bash
npm install -g conventional-changelog-cli
pnpm run changelog