如何检测文件是否属于Git子模块并查询其所属的子模块

1. 检测指定文件是否属于子模块 #

使用Git内置的--show-superproject-working-tree参数即可实现无侵入检测，无需修改工作目录：

• 执行命令：git -C <目标文件所在目录> rev-parse --show-superproject-working-tree
• 判断规则：如果命令有非空输出，且输出路径等于主仓库根目录，说明该文件属于当前主仓库的子模块；如果输出为空，说明文件属于主仓库本身。

2. 确定文件所属的子模块信息 #

有两种兼容性较好的实现方式：

方法1：使用子模块辅助命令（推荐） #

直接调用Git内置的子模块辅助工具，一行命令即可得到结果：

• 在主仓库根目录执行：git submodule--helper find-path <目标文件的绝对路径>
• 输出结果第一部分就是该文件所属子模块在主仓库中的相对路径，第二部分是子模块名称。

方法2：遍历子模块配置（兼容旧版本Git） #

如果你的Git版本不支持submodule--helper命令，可以通过读取.gitmodules配置匹配路径：

1. 列出主仓库所有已注册的子模块路径：

git config --file .gitmodules --get-regexp path

2. 输出格式为submodule.<子模块名>.path <子模块相对主仓库路径>，将目标文件的相对主仓库路径和所有子模块路径做最长前缀匹配，匹配成功的就是对应的子模块。

实际脚本参考 #

你可以直接在现有脚本中加入以下逻辑，适配子模块场景的git log查询：

#!/bin/bash
# 传入目标文件路径作为参数
TARGET_FILE="$1"

# 校验目标文件存在
if [ ! -f "$TARGET_FILE" ]; then
    echo "文件不存在"
    exit 1
fi

# 获取主仓库根目录
MAIN_ROOT=$(git rev-parse --show-toplevel 2>/dev/null)
if [ -z "$MAIN_ROOT" ]; then
    echo "当前路径不在Git仓库内"
    exit 1
fi

# 转换为绝对路径方便匹配
TARGET_ABS=$(realpath "$TARGET_FILE")
# 检测是否属于子模块
SUPER_PROJECT=$(git -C "$(dirname "$TARGET_ABS")" rev-parse --show-superproject-working-tree 2>/dev/null)

if [ -n "$SUPER_PROJECT" ] && [ "$SUPER_PROJECT" = "$MAIN_ROOT" ]; then
    # 获取所属子模块路径
    SUB_INFO=$(git -C "$MAIN_ROOT" submodule--helper find-path "$TARGET_ABS")
    SUB_PATH=$(echo "$SUB_INFO" | cut -d' ' -f1)
    SUB_NAME=$(echo "$SUB_INFO" | cut -d' ' -f2)
    echo "文件属于子模块：$SUB_NAME，路径为$SUB_PATH"
    # 子模块场景下查询git log
    TARGET_RELATIVE=$(realpath --relative-to="$SUB_PATH" "$TARGET_ABS")
    git -C "$SUB_PATH" log -- "$TARGET_RELATIVE"
else
    # 主仓库场景直接查询
    TARGET_RELATIVE=$(realpath --relative-to="$MAIN_ROOT" "$TARGET_ABS")
    git log -- "$TARGET_RELATIVE"
fi

内容的提问来源于stack exchange，提问作者U. Windl