项目简介
本项目是基于 Vue 3 框架的源码模板,严格遵循 Vue 官方推荐的风格指南。集成了 Prettier、ESLint、StyleLint 等代码规范工具,利用 Git 钩子(husky)和 commitlint 校验 git commit 信息,保障团队代码规范的一致性。同时引入 commitizen 和 cz-git 简化 commit message 的生成。
项目的主要特性和功能
- 代码格式化:借助 Prettier 统一代码风格。
- 代码校验:ESLint 校验 JavaScript/TypeScript 代码,StyleLint 校验 CSS/SCSS/Less 代码。
- Git 钩子管理:通过 husky 管理 git 钩子,在 commit 前用 lint-staged 校验,确保提交代码符合规范。
- Commit 信息校验:使用 commitlint 按 Angular 的提交规范校验 git commit 信息。
- Commit 信息生成:运用 commitizen 和 cz-git 生成标准化的 commit message,简化提交操作。
安装使用步骤
- 安装依赖:在项目根目录下执行
npm install
。 - 格式化代码:运行
npm run lint:lint-staged
对本地暂存区的代码进行格式化。 - 提交代码:先使用
git add
添加要提交的文件,再运行git commit
,此时会自动进行代码校验和格式化。 - 查看代码规范:在 Vscode 中打开项目,EditorConfig 配置文件会自动应用,对代码进行规范检查。
注意:执行 npm install
时,会自动安装 husky 和 lint-staged 并添加 git 钩子。
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】