配置 husky
配置 husky 之前先在码云创建新仓库
本地创建空文件夹 vue3_admin
在 git bash 中 cd 到 vue3_admin 路径,执行 git init
使用 git remote add origin https://gitee.com/你的码云用户名/XXXX
//添加远程仓库
使用 git pull origin master
命令,将码云上的仓库 pull 到本地文件夹
(期间需要输入 gitee 上面的账号和密码。
输入完账号后,弹出输入密码的。)
将要上传的文件,添加到刚刚创建的文件夹
使用 git add .
(. 表示所有的)或者 git add + 文件名 // 将文件保存到缓存区
使用 git commit -m '新添加的文件内容描述'
//添加文件描述
使用 git push origin master
,将本地仓库推送到远程仓库
执行完 git push 之后,在 gitee 中就能看到推送上去的项目了。
在上面我们已经集成好了我们代码校验工具,但是需要每次手动的去执行命令才会格式化我们的代码。如果有人没有格式化就提交了远程仓库中,那这个规范就没什么用。所以我们需要强制让开发人员按照代码规范来提交。
要做到这件事情,就需要利用 husky 在代码提交之前触发 git hook(git 在客户端的钩子),然后执行pnpm run format
来自动的格式化我们的代码。
安装husky
pnpm install -D husky
执行
npx husky-init
会在根目录下生成个一个.husky 目录,在这个目录下面会有一个 pre-commit 文件,这个文件里面的命令在我们执行 commit 的时候就会执行
在.husky/pre-commit
文件添加如下命令:
#!/usr/bin/env sh
. “$(dirname – “$0”)/_/husky.sh”
pnpm run format
当我们对代码进行 commit 操作的时候,就会执行命令,对代码进行格式化,然后再提交。
对于我们的 commit 信息,也是有统一规范的,不能随便写,要让每个人都按照统一的标准来执行,我们可以利用commitlint来实现。
配置commitlint文章见commitlint 配置