Husky —— 现代原生Git钩子管理库

Husky —— 现代原生Git钩子管理库

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

项目介绍

Husky 是一个轻量级的库，用于方便地管理和运行Git钩子。它使你能设置一些自动化任务，比如在提交或推送时自动格式化代码、运行测试等。Husky 使用新版本的Git特性（如 core.hooksPath），支持跨平台（macOS、Linux、Windows）以及各种开发环境，包括Git GUI、Node版本管理器、嵌套项目和monorepos。

项目快速启动

安装

在你的项目根目录中，使用npm安装husky：

npm install --save-dev husky

配置

添加一个基本的Git钩子，例如，配置pre-commit钩子来运行lint-staged：

npx husky add .husky/pre-commit "npx lint-staged"

这将在.husky文件夹下创建一个pre-commit脚本，每次你在提交前都会执行这个脚本。

启动

完成安装和配置后，你可以尝试提交来测试钩子是否工作正常：

git commit -am "Test commit"

应用案例和最佳实践

• 确保代码质量：在pre-commit钩子中运行代码格式化工具（如eslint或prettier）。
• 保护分支：使用pre-push钩子检查你的分支是否已合并到主分支，或者在推送之前运行所有测试。
• 版本控制：在prepare-commit-msg钩子中自动填充提交消息模板以遵循一定的规范。

典型生态项目

Husky 被广泛应用于许多知名的开源项目，包括：

• Vercel/Next.js
• Vercel/Hyper
• webpack/webpack
• Angular/Angular
• Facebook/Docusaurus
• Microsoft/VSCode

通过集成Husky，这些项目能够维护代码质量、自动化测试流程并提供一致的开发者体验。

更多关于Husky的信息，可以参考其官方文档，了解详细的配置选项和高级用法。

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