Husky项目中commit-msg钩子配置的正确方式

在Git钩子管理工具Husky的使用过程中，开发者有时会遇到钩子脚本不生效的问题。本文将以一个典型场景为例，讲解如何正确配置commit-msg钩子。

问题现象

开发者在Ubuntu 22.04系统中使用Husky 9.0.11版本时，尝试通过修改.husky/_/commit-msg文件来拦截Git提交信息。该脚本包含简单的输出语句和强制失败的退出码，但实际执行git commit -m "testing"时，脚本既没有输出任何内容，也没有阻止提交操作。

问题根源

经过分析，这实际上是一个配置路径错误的问题。Husky在9.x版本中采用了新的目录结构设计：

1. .husky/_目录是Husky内部使用的目录，类似于项目的node_modules目录，存放Husky运行所需的支持文件
2. 用户自定义的钩子脚本应该放在.husky根目录下，如.husky/commit-msg

正确配置方法

要正确配置commit-msg钩子，应该遵循以下步骤：

1. 在项目根目录下创建或编辑.husky/commit-msg文件
2. 为该文件添加可执行权限：chmod +x .husky/commit-msg
3. 在文件中编写验证逻辑，例如：

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

# 在这里添加提交信息验证逻辑
echo "正在验证提交信息..."
if ! grep -q "JIRA-" "$1"; then
  echo "错误：提交信息必须包含JIRA编号"
  exit 1
fi

工作原理

当配置正确时，Husky会在Git提交时：

1. 自动调用.husky/commit-msg脚本
2. 将临时提交信息文件路径作为第一个参数传递给脚本
3. 如果脚本以非零状态退出，Git提交操作将被中止

最佳实践建议

1. 不要修改.husky/_目录下的任何文件，这些是Husky的内部实现细节
2. 对于团队项目，建议将.husky目录纳入版本控制
3. 复杂的验证逻辑可以考虑拆分为单独的可执行文件，在钩子脚本中调用
4. 在脚本中添加适当的错误提示，帮助开发者理解为什么提交被拒绝

通过遵循这些指导原则，开发者可以有效地利用Husky来实施项目中的Git提交规范。