Husky项目入门指南：轻松管理Git钩子

Husky项目入门指南：轻松管理Git钩子

husky Git hooks made easy 🐶 woof! 项目地址: https://gitcode.com/gh_mirrors/hu/husky

什么是Husky

Husky是一个强大的Git钩子管理工具，它能够帮助开发团队在代码提交或推送前自动执行预定义的脚本，确保代码质量和一致性。通过简单的配置，Husky可以让你的项目在关键Git操作时自动运行测试、代码格式化、静态检查等任务。

安装Husky

Husky支持多种包管理器安装方式，以下是常见包管理器的安装命令：

# 使用npm安装
npm install --save-dev husky

# 使用pnpm安装
pnpm add --save-dev husky

# 使用yarn安装
yarn add --dev husky

# 使用bun安装
bun add --dev husky

注意：如果你的项目是公开的npm包（非私有），使用yarn时需要额外安装pinst工具。

初始化Husky（推荐方式）

Husky提供了便捷的初始化命令，它会自动完成以下工作：

1. 在项目中创建.husky目录
2. 添加基础的pre-commit钩子脚本
3. 更新package.json中的prepare脚本

初始化命令如下：

# 使用npm初始化
npx husky init

# 使用pnpm初始化
pnpm exec husky init

# 使用bun初始化
bunx husky init

测试Husky

初始化完成后，你可以尝试进行一次Git提交来测试Husky是否正常工作：

git commit -m "测试Husky钩子"

如果一切配置正确，你将在提交时看到预定义的脚本被执行。

高级用法

自定义钩子脚本

虽然大多数情况下你只需要在钩子中运行简单的npm脚本，但Husky也支持使用POSIX shell编写更复杂的逻辑。例如，下面是一个直接在pre-commit钩子中格式化暂存文件的示例：

# .husky/pre-commit
prettier $(git diff --cached --name-only --diff-filter=ACMR | sed 's| |\\ |g') --write --ignore-unknown
git update-index --again

这个脚本会：

1. 找出所有暂存的文件
2. 使用Prettier格式化这些文件
3. 更新Git索引以反映格式化后的变更

禁用钩子

在某些情况下，你可能需要临时禁用Husky钩子。可以通过设置环境变量来实现：

HUSKY=0 git commit -m "跳过钩子检查"

最佳实践

1. 保持钩子轻量：钩子脚本应该快速执行，避免长时间运行的任务影响开发流程
2. 明确反馈：确保钩子失败时有清晰的错误信息，帮助开发者快速定位问题
3. 团队一致性：将.husky目录纳入版本控制，确保团队成员使用相同的钩子配置
4. 渐进式采用：对于已有项目，可以先从简单的检查开始，逐步增加更多验证

常见问题

Q: 为什么我的钩子没有执行？ A: 请检查以下方面：

• 确保已运行husky init
• 确认.husky目录中的脚本有可执行权限
• 检查是否设置了HUSKY=0环境变量

Q: 如何添加多个钩子？ A: 只需在.husky目录下创建对应的钩子文件即可，如pre-push、commit-msg等

通过本文的介绍，你应该已经掌握了Husky的基本使用方法。这个工具虽然简单，但能显著提升团队的代码质量和开发体验。建议从简单的pre-commit钩子开始，逐步探索更多高级功能。

husky Git hooks made easy 🐶 woof! 项目地址: https://gitcode.com/gh_mirrors/hu/husky