项目简介
本项目专注于前端编码规范的工程化,提供了一套全面且便捷的解决方案。支持前端全生态,具备完善的规范配件和完整测试用例,借助多种流行的 Linter 工具和定制规则包,有效提升前端项目的编码规范和质量。
项目的主要特性和功能
- 全面的前端生态支持:无需关注环境,可直接在前端各生态中使用。
- 完善的规范配件功能:实现前端全部配置的一键接入、扫描、修复和升级。
- 完整的测试用例:配套完整测试用例,提升项目健壮性。
- 多方面的工程化实践
- 采用
monorepo
和pnpm
多包管理,发包流程植入CI
实现自动化发布和CHANGLOG
自动化更新部署。 - 提供使用
eslint
、stylelint
、commitlint
、markdownlint
、husky
等工具提升编码规范的最佳实践,且将单元测试植入配套工具。 - 通过脚手架以交互式形式一键接入,为不同类型前端项目设置标准语法限制。
- 支持对存量项目一键扫描和修复,降低存量代码更新成本。
- 可一键接入新项目,结合
gitpre - commit
钩子和husky
的commit - msg
钩子,扫描提交文件和信息格式。
- 采用
- 配套工具丰富:引入多个流行的
Linter
工具并定制规则包,涵盖 JavaScript、TypeScript、Node、CSS、Git、文档等规范,收敛屏蔽依赖和配置细节,提供简单的CLI
和Node.js API
。
安装使用步骤
- 已下载本项目的源码文件。
- 在项目根目录安装依赖:
bash pnpm install
- 全局安装
markdownlint-cli
:bash npm i -g markdownlint-cli
- 运行
lint
命令进行规范检查:bash pnpm run lint
- 若需生成
CHANGELOG
,全局安装conventional-changelog-cli
并运行:bash npm install -g conventional-changelog-cli pnpm run changelog
然后根据生成的CHANGELOG
更新项目的版本信息。 - 使用
etc - fe - lint
提供的CLI
和Node.js API
进行项目的规范接入、扫描、修复和升级。
请确保已具备基本的 Node.js 和 npm 环境,本项目使用 pnpm 作为包管理器,需提前安装并配置好环境。
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】