在子模块目录中运行pre-commit遇到的问题及解决方案

当尝试在Git子模块内运行pre-commit时，可能会遇到失败的情况，并收到如下错误报告：

版本信息

pre-commit 版本: 2.9.3
系统版本: 3.7.9 (默认, 2020年11月25日, 03:17:55)
编译器: [GCC 8.3.0]
Python 可执行文件路径: /usr/local/bin/python
操作系统名称: posix
系统平台: linux

错误信息

发生了一个错误: 致命错误: Git命令执行失败。Git是否已安装，且当前目录是否为Git仓库？
错误详情:

Traceback (最接近的调用最后):
  File "/usr/local/lib/python3.7/site-packages/pre_commit/git.py", line 56, in get_root
    cmd_output('git', 'rev-parse', '--show-cdup')[1].strip(),
  File "/usr/local/lib/python3.7/site-packages/pre_commit/util.py", line 160, in cmd_output
    returncode, stdout_b, stderr_b = cmd_output_b(*cmd, **kwargs)
  File "/usr/local/lib/python3.7/site-packages/pre_commit/util.py", line 154, in cmd_output_b
    raise CalledProcessError(returncode, cmd, retcode, stdout_b, stderr_b)
pre_commit.util.CalledProcessError: 命令: ('/usr/bin/git', 'rev-parse', '--show-cdup')
返回码: 128
预期返回码: 0
标准输出: (无)
标准错误:
    fatal: 不是Git仓库: /src/../.git/modules/amp

由于Git使用.git文件而非.git文件夹来存储子模块的数据，这种检查总是会引发异常。根据官方文档，现代版本的Git将所有子模块的Git数据存储在顶级项目的.git目录中，因此删除子模块目录不会丢失任何提交或分支。

为了解决这一问题，可以考虑添加额外的检查以支持在子模块中运行pre-commit。例如，在我们的项目中，我们采用Docker容器来分发自定义的代码检查工具和linter。我们创建了一个包含预装pre-commit和自定义linter库的Docker镜像，然后将不同的仓库挂载到容器中并运行检查。对于子模块，我们使用了以下脚本作为临时解决方案：

if [ $(git rev-parse --show-superproject-working-tree) ]; then
    SUBMODULE_NAME=$(basename "$(pwd)")
    echo "正在为 '$SUBMODULE_NAME' 子模块运行代码检查。"
    WORK_DIR="/src/$SUBMODULE_NAME"
    REPO_ROOT=$(git rev-parse --show-superproject-working-tree)
else
    echo "正在为整个仓库运行代码检查。"
    WORK_DIR="/src"
    REPO_ROOT="$(pwd)"
fi

然后，使用以下命令运行Docker容器：

docker run --rm -t \
    --env "PRE_COMMIT_HOME=$HOME/.cache/pre-commit" \
    -v "$HOME/.cache:$HOME/.cache:rw" \
    -v "$REPO_ROOT":/src \
    --workdir "$WORK_DIR" \
    custom_pre_commit_image:latest "$@"

这种方法被证明是我们长期解决方案的一部分。感谢快速的响应和支持，以及对如此有用的工具的贡献！