项目简介
本项目致力于解决前端开发中编码规范不一致的问题,通过前端编码规范工程化方案,使开发者能够快速接入规范,有效提升代码质量与开发效率。它支持全面的前端生态,具备完善的规范配件和完整的测试用例,为前端项目的规范化开发提供有力保障。
项目的主要特性和功能
特性
- 前端生态全覆盖:支持所有前端生态,无需关注环境,可直接使用。
- 规范配件便捷化:前端配置能一键接入、扫描、修复和升级。
- 测试用例完备性:配套完整测试用例,增强项目健壮性。
功能
- 多包管理自动化:运用
monorepo
和pnpm
实现多npm
包管理,将发包流程植入CI
实现自动化发布,自动更新部署CHANGLOG
。 - 规范工具集成化:引入
eslint
、stylelint
、commitlint
、markdownlint
、husky
等工具,提供最佳实践,并定制规则包,涵盖 JavaScript、TypeScript、CSS 编码规范,Git 规范以及文档规范等。 - 接入成本最低化:
encode-fe-lint
收敛屏蔽依赖和配置细节,通过CLI
和Node.js API
实现一键接入、扫描、修复和升级,配置 git commit 卡口。
安装使用步骤
假设已下载项目源码文件,按以下步骤操作:
1. 安装依赖:在项目根目录运行 pnpm install
。
2. 启动项目:执行 pnpm run start
。
3. 测试规范:全局安装 markdownlint-cli
(npm i -g markdownlint-cli
),运行 pnpm run lint
进行 markdown config
测试。
4. 生成日志:全局安装 conventional-changelog-cli
(npm install -g conventional-changelog-cli
),运行 pnpm run changelog
生成 CHANGELOG
。
5. 接入规范:使用 encode-fe-lint
为项目接入全部规范。
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】