fe-spec

前端编码规范工程化

⛰️ 能力支持

1. 全面的前端生态

支持前端全部生态，无需关注环境，支持直接使用

2. 完善的规范配件

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

3. 完整的测试用例

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

⭐ 设计目的

制定前端团队的代码规范，提高了前端开发效率,一致性的代码规范可以增强团队开发协作效率、提高代码质量、减少遗留系统维护的负担.以最小成本的推广，产出一套完整化的前端编码规范工具，不仅能够解决存量项目的编码异味，还能够保证后续所有项目的编码质量。

🛋️ 配套工具

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

规范	Lint 工具	npm 包
JavaScript 编码规范 TypeScript 编码规范 Node 编码规范	ESLint	eslint-config-hh
CSS 编码规范	stylelint	stylelint-config-hh
Git 规范	commitlint	commitlint-config-hh
文档规范	markdownlint	markdownlint-config-hh
Eslint 插件	ESlint Plugin	eslint-plugin-hh

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

您可以使用hh-fe-lint 方便地为项目接入全部规范。

其他

测试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

📧 联系

• 前端编码规范工程化 https://hh-studio-fe.github.io/standardized-projects/
• GitHub: https://github.com/coderhhan/standardized-projects