项目简介
本项目聚焦前端编码规范工程化,提供一套完整的前端编码规范工具集。涵盖 JavaScript、TypeScript、CSS 等编码规范,以及 Git 规范和文档规范。通过引入多种业界流行的 Lint 工具并定制规则包,以工程化手段助力团队落实编码规范,提升前端项目开发、维护与升级的规范性和效率。
项目的主要特性和功能
- 全面前端生态支持:无需关注环境,可直接使用前端全部生态。
- 完善规范配件:能对全部前端配置实现一键接入、扫描、修复和升级。
- 完整测试用例:配套完整测试用例,增强项目健壮性。
- 便捷工程化工具:
encode - fe - lint
收敛屏蔽依赖和配置细节,提供简单 CLI 和 Node.js API,便于项目接入规范。 - Git 提交卡口配置:通过配套工具对 git commit 进行卡口配置,降低项目接入规范成本。
安装使用步骤
1. 确保已下载源码
用户需提前下载本项目的源码文件。
2. 安装依赖
在项目根目录下,运行以下命令安装所需依赖:
bash
pnpm install
3. 进行规范扫描
运行以下命令对项目进行规范扫描:
bash
pnpm run lint
4. 生成 CHANGELOG(可选)
若需要生成 CHANGELOG,可按以下步骤操作:
全局安装 conventional - changelog - cli
:
bash
npm install -g conventional-changelog-cli
然后运行以下命令生成 CHANGELOG:
bash
pnpm run changelog
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】