Husky 入门

Husky 是一个流行的 Node.js 工具，用于管理 Git 钩子。Git 钩子是在特定 Git 操作（如提交、推送等）发生时自动触发的脚本。Husky 允许你轻松地为你的项目添加这些钩子，以便在代码提交或推送之前自动执行检查、测试或其他任务。

安装 Husky

首先，你需要确保你的项目中已经安装了 Node.js 和 npm（Node.js 的包管理器）。然后，你可以通过 npm 安装 Husky：

npm install husky --save-dev

这将把 Husky 安装为你项目的开发依赖。

配置 Git 钩子

安装 Husky 后，你可以开始配置 Git 钩子了。Husky 支持多种 Git 钩子，但最常用的可能是 pre-commit 钩子，它在每次提交之前运行。

要在你的项目中添加 pre-commit 钩子，你可以使用 Husky 提供的 husky-run 命令和 .huskyrc 配置文件（尽管新版本可能不再需要 .huskyrc，而是直接在 package.json 中配置）。但更常见和推荐的方式是使用 Husky 提供的 add 命令来添加钩子：

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

这个命令将在 .husky 目录下创建一个 pre-commit 钩子文件，并在其中添加 npm test 命令。这意味着每次你尝试提交代码时，npm test 命令都会自动运行。

测试 Git 钩子

配置好 Git 钩子后，你可以通过尝试提交一些代码来测试它是否按预期工作。如果 npm test 命令失败（例如，因为测试未通过），那么 Git 提交将被阻止，直到你解决测试失败的问题。

其他 Git 钩子

除了 pre-commit 钩子外，Husky 还支持其他 Git 钩子，如 commit-msg、pre-push 等。你可以根据需要添加和配置这些钩子，以便在代码提交或推送之前执行额外的检查或任务。

结论

Husky 是一个强大的工具，可以帮助你自动化 Git 钩子，并在代码提交或推送之前执行重要的检查或任务。通过遵循上述步骤，你应该能够轻松地为你的项目添加和配置 Husky Git 钩子。这将有助于提高你的代码质量，并确保只有经过充分测试的代码才会被提交到版本库中。