Commitlint 在 Windows 系统下创建 Git Hook 的编码问题解析

在 Windows 系统下使用 Commitlint 和 Husky 配置 Git Hook 时，开发者可能会遇到一个常见但容易被忽视的问题：通过 echo 命令创建的 Hook 脚本文件无法执行。本文将深入分析这一问题的成因，并提供多种解决方案。

问题现象

当开发者按照常规流程配置 Commitlint 时，通常会执行以下命令创建 Hook 脚本：

echo "npx --no -- commitlint --edit \$1" > .husky/commit-msg

然而，在 Windows 系统（特别是 Windows 11）上，这样创建的脚本文件在执行时会报错：

.husky/commit-msg: .husky/commit-msg: cannot execute binary file
husky - commit-msg script failed (code 126)

根本原因

经过分析，这个问题源于 Windows 系统中 echo 命令的默认行为：

1. 文件编码问题：Windows 的 echo 命令默认会创建 UTF-16 LE 编码的文件，而 Git Hook 需要 UTF-8 编码的纯文本文件才能正确执行
2. BOM 标记：UTF-16 编码通常包含字节顺序标记（BOM），这会导致脚本解释器无法正确识别文件内容
3. 执行权限：虽然 Windows 本身不严格依赖文件权限，但某些环境（如 WSL 或 Git Bash）仍会检查文件的可执行属性

解决方案

方案一：使用文本编辑器手动创建

最可靠的方法是直接使用文本编辑器（如 VS Code、Sublime Text等）创建 .husky/commit-msg 文件，确保：

1. 文件编码为 UTF-8（无 BOM）
2. 内容为纯文本：

   npx --no -- commitlint --edit $1
   

方案二：修改 echo 命令行为

对于习惯使用命令行的开发者，可以通过以下方式调整：

# 使用 -n 参数避免换行符
echo -n "npx --no -- commitlint --edit \$1" > .husky/commit-msg

# 或者使用 PowerShell 的 Out-File
echo "npx --no -- commitlint --edit \$1" | Out-File -Encoding UTF8 .husky/commit-msg

方案三：配置 Git 的换行符处理

在 Windows 上配置 Git 的全局设置，可以避免换行符问题：

git config --global core.autocrlf false
git config --global core.eol lf

最佳实践建议

1. 跨平台兼容性：在团队协作项目中，建议在文档中明确说明 Hook 文件的创建方法
2. 版本控制：将 .husky 目录纳入版本控制，确保所有开发者使用相同的 Hook 配置
3. 编码检查：在 CI/CD 流程中添加文件编码检查，防止不兼容的脚本进入代码库

总结

Windows 系统下 Git Hook 的编码问题看似简单，但可能影响整个团队的开发流程。理解其背后的编码机制，采用适当的文件创建方法，可以避免这类问题的发生。对于 Node.js 项目，特别是使用 Husky 和 Commitlint 的项目，建议采用文本编辑器直接创建 Hook 文件的方式，这能最大程度保证跨平台的兼容性。