Vue3+Vite+husky搭建规范的前端项目

刘坤15
315 阅读5分钟

前言

vue3出了已经有一段时间了，之前做的项目基本都是基于Vue2+webpack做的，但是vue3现在是大势所趋，那么如何搭建一个规范的前端项目呢？

技术栈

  • 开发工具： Vscode
  • 代码管理： git
  • 前端框架： Vue3
  • 构建工具： Vite
  • 代码规范： eslint
  • 代码格式化： Prettier
  • css预处理： sass
  • 代码提交： husky + commitlint

构建

1.初始化项目

安装vite

npm init vite@latst

安装完成后vite会引导我们创建一个项目，输入项目名称，package名称，然后选择项目使用的框架，这里有多个选项，我们自然是选择Vue,而后选择typescript

image.png 项目创建成功

cd vite-prject
npm install

成功后运行项目

npm run dev

这样最基础班的Vue3+Vite+TS的项目就创建成功了

2.集成editorconfig配置

EditorConfig 有助于为不同 IDE 编辑器上处理同一项目的多个开发人员维护一致的编码风格。

下面的代码是在目录下创建.editorconfig

# http://editorconfig.org
root = true

[*] # 表示所有文件适用
charset = utf-8 # 设置文件字符集为 utf-8
indent_style = space # 缩进风格（tab | space）
indent_size = 2 # 缩进大小
end_of_line = lf # 控制换行类型(lf | cr | crlf)
trim_trailing_whitespace = true # 去除行首的任意空白字符
insert_final_newline = true # 始终在文件末尾插入一个新行
[*.md] # 表示仅 md 文件适用以下规则
max_line_length = off
trim_trailing_whitespace = false

VSCode需要安装一个插件：EditorConfig for VS Code

image.png

3.使用prettier工具

Prettier 是一款强大的代码格式化工具，支持 JavaScript、TypeScript、CSS、SCSS、Less、JSX、Angular、Vue、GraphQL、JSON、Markdown 等语言，基本上前端能用到的文件格式它都可以搞定，是当下最流行的代码格式化工具。

3.1.安装prettier
npm install prettier -D
npx eslint --init
3.2.配置.prettierrc文件：
  • useTabs：使用tab缩进还是空格缩进，选择false；
  • tabWidth：tab是空格的情况下，是几个空格，选择2个；
  • printWidth：当行字符的长度，推荐80，也有人喜欢100或者120；
  • singleQuote：使用单引号还是双引号，选择true，使用单引号；
  • trailingComma：在多行输入的尾逗号是否添加，设置为 none；
  • semi：语句末尾是否要加分号，默认值true，选择false表示不加；
{ 
    "useTabs": false,
    "tabWidth": 2,
    "printWidth": 80,
    "singleQuote": true,
    "trailingComma": "none",
    "semi": false 
}
3.3.创建.prettierignore忽略文件
/dist/*
.local
.output.js
/node_modules/**

**/*.svg
**/*.sh

/public/*
3.4.VSCode需要安装prettier的插件

image.png

3.5.测试prettier是否生效
  • 测试一：在代码中保存代码；
  • 测试二：配置一次性修改的命令；

在package.json中配置一个scripts：

"prettier": "prettier --write ."

4.使用eslint检测

4.1.在前面创建项目的时候，我们就选择了ESLint，所以Vue会默认帮助我们配置需要的ESLint环境。
4.2.VSCode需要安装ESLint插件：

image.png

4.3.解决eslint和prettier冲突的问题：

安装插件：（vue在创建项目时，如果选择prettier，那么这两个插件会自动安装）

npm i eslint-plugin-prettier eslint-config-prettier -D

添加prettier插件：

extends: [
    'plugin:vue/vue3-essential',
    'eslint:recommended',
    'plugin:@typescript-eslint/recommended',
    '@vue/prettier',
    'plugin:prettier/recommended'
],

5.git Husky和eslint

虽然我们已经要求项目使用eslint了，但是不能保证组员提交代码之前都将eslint中的问题解决掉了：

  • 也就是我们希望保证代码仓库中的代码都是符合eslint规范的；
  • 那么我们需要在组员执行 git commit 命令的时候对其进行校验，如果不符合eslint规范，那么自动通过规范进行修复；

那么如何做到这一点呢？可以通过Husky工具：

  • husky是一个git hook工具，可以帮助我们触发git提交的各个阶段：pre-commit、commit-msg、pre-push 如何使用husky呢？

这里我们可以使用自动配置命令：

npx husky-init && npm install

这里会做三件事：

1.安装husky相关的依赖：

image.png

2.在项目目录下创建 .husky 文件夹：

npx huksy install

image.png

3.在package.json中添加一个脚本：

image.png

接下来，我们需要去完成一个操作：在进行commit时，执行lint脚本：

image.png

这个时候我们执行git commit的时候会自动对代码进行lint校验

6.git commit规范

6.1 代码提交风格

通常我们的git commit会按照统一的风格来提交，这样可以快速定位每次提交的内容，方便之后对版本进行控制

image.png 但是如果每次手动来编写这些是比较麻烦的事情，我们可以使用一个工具：Commitizen

  • Commitizen 是一个帮助我们编写规范 commit message 的工具；

1.安装Commitizen

npm install commitizen -D

2.安装cz-conventional-changelog，并且初始化cz-conventional-changelog

npx commitizen init cz-conventional-changelog --save-dev --save-exact

这个命令会帮助我们安装cz-conventional-changelog

image.png

并且在package.json中进行配置：

image.png

这个时候我们提交代码需要使用 npx cz：

  • 第一步是选择type，本次更新的类型
Type作用
feat新增特性 (feature)
fix修复 Bug(bug fix)
docs修改文档 (documentation)
style代码格式修改(white-space, formatting, missing semi colons, etc)
refactor代码重构(refactor)
perf改善性能(A code change that improves performance)
test测试(when adding missing tests)
build变更项目构建或外部依赖（例如 scopes: webpack、gulp、npm 等）
ci更改持续集成软件的配置文件和 package 中的 scripts 命令，例如 scopes: Travis, Circle 等
chore变更构建流程或辅助工具(比如更改测试环境)
revert代码回退
  • 第二步选择本次修改的范围（作用域）

image.png

  • 第三步选择提交的信息

image.png

  • 第四步提交详细的描述信息

image.png

  • 第五步是否是一次重大的更改

image.png

  • 第六步是否影响某个open issue

image.png

我们也可以在scripts中构建一个命令来执行 cz：

image.png

6.2 代码提交验证

如果我们按照cz来规范了提交风格，但是依然有同事通过 git commit 按照不规范的格式提交应该怎么办呢？

  • 我们可以通过commitlint来限制提交；

1.安装 @commitlint/config-conventional 和 @commitlint/cli

npm i @commitlint/config-conventional @commitlint/cli -D

2.在根目录创建commitlint.config.js文件，配置commitlint

module.exports = {  extends: ['@commitlint/config-conventional'] }

3.使用husky生成commit-msg文件，验证提交信息：

npx husky add .husky/commit-msg "npx --no-install commitlint --edit $1"

结语

到这里，一个较为规范的项目就搭建完毕了，其他的校验及检测等具体项目具体配置

avatar
文章
阅读
粉丝