husky - 给 git 钩子添加校验&处理

最新推荐文章于 2024-03-01 15:40:09 发布

共沐春鳅

最新推荐文章于 2024-03-01 15:40:09 发布

阅读量723

点赞数 1

文章标签： git github javascript

本文链接：https://blog.csdn.net/qq_61270298/article/details/129807345

版权

介绍

husky 通常用于在提交/推送前，校验提示信息，校验代码等。

安装使用

自动方式

需要先初始化git仓库，再执行下面的命令，否则会报错

git init

安装

npx husky-init && npm install       # npm
npx husky-init && yarn              # Yarn 1
yarn dlx husky-init --yarn2 && yarn # Yarn 2+
pnpm dlx husky-init && pnpm install # pnpm

🐙 使用 window 系统时，需要在连接符前后加上引号 '&&'，否则识别不了；

🐢 husky-init 是一次性的命令，用于快速初始化项目；

🐢 这将会修改 package.json 、并创建预提交钩子的示例文件，文件配置了在提交前执行 npm test；

🐢 如果执行 npm test 的过程发生了错误，代码将不会提交。

添加其它钩子

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

🐙 对于 window，如果出现其它提示，将语法改为 node node_modules/husky/lib/bin add ...

👻 这将会生成 commit-msg 文件，并将命令语句中引号的内容作为文件内容

手动方式

安装

安装 husky

npm install husky --save-dev

开启 git hooks

npx husky install

为了在执行 install 后能够自动开启 git hooks，需要添加脚本命令

npm pkg set scripts.prepare="husky install"

创建示例钩子

npx husky add .husky/pre-commit "npm test"

卸载

npm uninstall husky && git config --unset core.hooksPath

项目实践

提交前修复

一、如果没有，准备 .husky/pre-commit 文件

npx husky add .husky/pre-commit "npm test"

二、启用脚本

.husky/pre-commit

#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

npm run lint-staged

三、安装配置 lint-staged 脚本，包括它的匹配模式和触发命令

npm install lint-staged -D -S

package.json

{
  "scripts": {
    "lint-staged": "lint-staged"
  },
  "lint-staged": {
    "*.js": [
      "eslint --fix",
      "git add ."
    ]
  }
}

🐳 需要先初始化 eslint，并配置好 .eslintrc.js 文件，eslint --fix 才能发挥作用；

🐳 也可以在使用 eslint 前先添加 prettier --write 来进一步格式化文件;

🌟 使用 lint-staged 能够只检查&修复暂存区中的文件，节省性能，避免影响其他文件。

🐳 匹配规则示例

"lint-staged": {
  "src/**/*.{js,vue,ts,jsons}": [
    "prettier --write",
    "eslint --fix",
    "git add ."
  ]
}

glob 语法解释：

* 匹配0或多个除了 / 以外的字符
** 匹配多个字符包括 /
{} 可以让多个规则用 , 逗号分隔，起到或者的作用

提交前校验信息

一、安装依赖

npm install @commitlint/cli @commitlint/config-conventional -S -D

二、生成配置文件

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

🐙 如果使用 window，需手动创建一下这个文件；默认生成的 utf-16 格式是有问题的。

commitlint.config.js

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

三、添加 husky 钩子

#添加 commit-msg 钩子
npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"'

🐳配置示例

module.exports = {
  // 解析并从node_modules加载@commitlint/config常规
  extends: ['@commitlint/config-conventional'],
  rules: {
    "subject-empty": [2, "never"],
    // type 不能为空
    "type-empty": [2, "never"],
    // type 的可选值
    "type-enum": [
      2,
      "always",
      [
        "feat", // 新增功能
        "fix", // 修复缺陷
        "style", // 代码格式（不影响功能，例如空格、分号等格式修正）
        "refactor", // 代码重构（不包括 bug 修复、功能新增）
        "test", // 添加疏漏测试或已有测试改动
        "chore", // 对构建过程或辅助工具和库的更改
        "revert" //对构建过程或辅助工具和库的更改（不影响源文件、测试用例）
      ],
    ],
  }
}