【实战指南】解决 Husky 中的 “.git can‘t be found“ 错误

文章正文

在前端开发中，预提交钩子（pre-commit hooks）是一种常见的实践，它们可以在提交代码之前执行一系列检查，比如格式化代码、运行测试等，以确保代码质量。Husky 是一个流行的 Git 钩子管理器，它简化了设置和管理这些钩子的过程。然而，有时我们会遇到一个常见的问题：“.git can’t be found”，这通常是因为 Husky 在非标准的 Git 目录下运行时发生的。本文将详细介绍这一问题的成因、解决方法以及如何配置 Husky 以适应不同的 Git 环境。

问题描述

当你使用 Husky 设置 Git 钩子时，可能会遇到以下错误信息：

│ husky - .git can't be found (see https://typicode.github.io/husky/#/?id=custom-directory)

这通常意味着 Husky 无法找到 Git 仓库的根目录。这种情况通常发生在 Git 存储库位于非标准位置时，例如子目录中或者使用了 Git submodules。

问题分析

在默认情况下，Husky 会在当前工作目录查找 .git 文件夹，如果该文件夹不在当前目录或其父目录中，Husky 就无法识别 Git 仓库的位置。这会导致 Husky 无法正确安装钩子脚本。

解决方案

接下来，我们将通过一个具体的示例来展示如何诊断和解决这个问题。

---

示例

假设我们的项目目录结构如下所示：

my-project/
├── .git/
├── frontend/
│   ├── .husky/
│   ├── package.json
│   └── package-lock.json
├── backend/
│   └── .git/
└── README.md

在这个例子中，前端项目位于 frontend 目录下，而 Git 仓库的根目录位于 my-project/。这意味着前端项目的 .git 文件夹不在预期的位置，因此 Husky 无法正确识别 Git 仓库。

步骤 1: 初始化项目

首先，我们需要初始化前端项目，并安装必要的依赖。

命令行操作:

cd my-project/frontend
npm init -y
npm install husky --save-dev

package.json:

{
  "name": "frontend",
  "version": "1.0.0",
  "private": true,
  "scripts": {
    "precommit": "echo 'Running pre-commit checks...'"
  },
  "devDependencies": {
    "husky": "^8.0.0"
  }
}

步骤 2: 配置 Husky

接下来，我们需要配置 Husky 以便它可以正确地识别 Git 仓库的位置。

命令行操作:

npx husky install

这将创建 .husky 文件夹，并设置默认的 Git 钩子脚本。然而，由于 .git 文件夹不在当前目录中，我们需要手动配置 Husky 以指定 Git 仓库的位置。

命令行操作:

npx husky add .husky/pre-commit 'npx --no-pnp lint-staged'

这里我们添加了一个简单的预提交钩子，用于运行 lint-staged。但是，我们需要告诉 Husky 如何找到 .git 文件夹。

步骤 3: 指定 .git 文件夹位置

为了指定 .git 文件夹的位置，我们需要修改 Husky 的配置文件。

命令行操作:

echo "repo=${PWD}/../.git" > .husky/_/env

这将创建一个名为 _ 的文件夹，并在其中创建一个名为 env 的文件。这个文件用于指定 Git 仓库的位置。

步骤 4: 测试预提交钩子

现在，我们可以尝试提交一些更改来测试预提交钩子是否正确工作。

命令行操作:

touch test.txt
git add test.txt
git commit -m "Initial commit"

如果一切正常，你应该能看到如下输出：

Running pre-commit checks...

步骤 5: 处理错误

如果在运行 git commit 时仍然遇到错误，那么可能是由于 Husky 未能正确读取 .git 文件夹的位置。这时，我们需要进一步排查问题。

命令行操作:

cat .husky/_/env

确保输出如下：

repo=/path/to/my-project/.git

如果输出不正确，你需要更新 .husky/_/env 文件以指向正确的 .git 文件夹。

步骤 6: 修复错误

如果 Husky 仍然无法找到 .git 文件夹，你可以尝试手动指定 .git 文件夹的位置。

命令行操作:

rm -rf .husky
npx husky install
npx husky add .husky/pre-commit 'npx --no-pnp lint-staged'
echo "repo=${PWD}/../.git" > .husky/_/env

步骤 7: 验证解决方案

最后，我们再次尝试提交更改来验证解决方案的有效性。

命令行操作:

touch test2.txt
git add test2.txt
git commit -m "Second commit"

这次应该不会出现任何错误，且预提交钩子会正常运行。

---

结论

本文通过一个具体的示例介绍了如何解决 Husky 中的 “.git can’t be found” 问题。在实际开发过程中，你应该始终注意 Git 仓库的位置，并确保 Husky 能够正确地识别它。通过适当的配置，我们可以避免这类问题，并充分利用 Husky 的强大功能来提高代码质量和团队协作效率。

---