Husky 安装与使用教程

Husky 安装与使用教程

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

1. 项目目录结构及介绍

在Husky项目中，目录结构通常包括以下几个关键部分：

husky/
├── bin/            # 包含可执行脚本
├── dist/           # 编译后的JavaScript代码
├── src/            # 源代码
│   ├── index.ts    # 入口文件
│   └── ...         # 其他源码文件
├── package.json    # 项目包信息，包含依赖和脚本
└── README.md       # 项目说明文档

• bin/: 存放用于操作git钩子的可执行文件。
• dist/: 执行环境下的二进制文件，由源代码编译得到。
• src/: 存放项目的主要源代码。
• package.json: 项目元数据文件，定义了项目的依赖以及可运行的npm命令。
• README.md: 项目的说明文档，包含如何安装和使用的信息。

2. 项目启动文件介绍

Husky的核心是它的启动脚本，这些脚本被设置为Git的钩子（hooks）。启动文件位于bin目录下，比如husky-run，这个脚本会被git命令调用来执行指定的钩子操作。当您通过npm运行Husky相关的命令时，如npm run precommit，实际上就是通过husky-run来执行对应的钩子逻辑。

此外，package.json中的scripts字段也扮演重要角色，例如：

{
  "scripts": {
    "prepare": "husky install"
  }
}

上面的prepare脚本会在您npm install后自动安装Husky的钩子。

3. 项目的配置文件介绍

Husky的配置主要是在项目根目录下的.husky文件夹内进行的。此文件夹包含了所有客户端Git钩子的脚本，比如.husky/pre-commit或.husky/pre-push。这些文件可以是shell脚本，用于执行自动化任务，如代码检查、测试等。

默认情况下，无需手动创建这些文件，Husky提供了简便的方法来添加和管理这些钩子。例如，要添加一个precommit钩子，你可以使用以下命令：

npx husky add .husky/precommit "npm run lint && npm run test"

这将在.husky目录下创建precommit文件，并将其内容设置为运行npm run lint和npm run test这两个命令。

请注意，自v4版本起，Husky不再支持在package.json中配置钩子，而是鼓励直接在.husky文件夹内使用shell脚本来保持与Git原生钩子的兼容性。

通过理解上述目录结构、启动文件和配置方法，你应该能更好地理解和部署Husky到你的项目中，以实现高效的Git工作流。

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