如何从父项目.git目录为Git子模块添加pre-commit钩子

子模块钩子不生效的原因 #

Git子模块的配置独立于父项目，默认读取自身的hooks目录，子模块的.git数据存储在父项目的.git/modules/[子模块名]路径下，不会自动继承父项目的钩子配置。

解决方案 #

方案1：统一配置子模块钩子路径指向父项目

在父项目根目录执行以下命令，即可让所有现有子模块直接复用父项目的钩子：

git submodule foreach git config core.hooksPath ../../.git/hooks

路径说明：子模块工作目录位于父项目的子层级，../../.git/hooks 为相对路径指向父项目的hooks文件夹，团队协作时不会因为项目存储路径不同失效。
如果后续新增子模块，重新执行一次上述命令即可，也可以将该命令添加到父项目的post-submodule-update钩子中，实现新增子模块自动配置。

原有钩子脚本优化建议 #

1. prepare-commit-msg 脚本可以优化分支名获取逻辑，避免grep匹配出错：

#!/bin/sh
BRANCH=$(git rev-parse --abbrev-ref HEAD)
FILE=$(cat "$1")
echo "$BRANCH $FILE" > "$1"

2. 如果子模块不需要执行pre-commit里的vendor目录清理逻辑，可以在脚本开头增加环境判断，区分父项目和子模块执行逻辑：

#!/bin/bash
# 判断当前是否为子模块环境
if echo "$GIT_DIR" | grep -q "\.git/modules"; then
  # 子模块下要执行的逻辑，不需要的话直接exit 0即可
  exit 0
fi
# 原有父项目pre-commit逻辑
find vendor -name ".git*" -type d | while read i
do
        if [ -d "$i" ]; then
                DIR=`dirname $i`
                rm -fR $i
                git rm -r --cached $DIR > /dev/null 2>&1
                git add $DIR > /dev/null 2>&1
        fi
done

内容的提问来源于stack exchange，提问作者Thomas Hall