灏天阁

vue3.2/Vite/Ts5: 配置 husky

· Yin灏

在上面我们已经配置好了代码校验工具,但是需要每次手动的去执行命令才会格式化我们的代码。如果有人没有格式化就提交到远程仓库中,那这个规范就没什么用。所以我们需要强制让开发人员按照代码规范来提交。

要做到这件事件,就需要利用 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 操作的时候,就会执行命令,对代码进行格式化,然后提交。

- Book Lists -