如何让git difftool --dir-diff向自定义工具传递Git重命名检测信息？

问题背景 #

使用git difftool --dir-diff可以快速对比整个目录树的差异，但Git不会把已经识别的文件重命名信息传递给外部Diff工具。比如以下操作：

git init
echo xyz >foo.txt
git add .
git commit -m 'Initial commit'
git mv foo.txt bar.txt
git commit -m 'Renamed'
git difftool --dir-diff --tool meld HEAD^

实际运行后，Meld会把这个变更识别为foo.txt被删除、bar.txt新增，而不是Git已经检测到的重命名操作。我们期望Diff工具能像git diff HEAD^那样，直接获取到重命名的元数据：

diff --git a/foo.txt b/bar.txt
similarity index 100%
rename from foo.txt
rename to bar.txt

但git difftool.<tool>.cmd默认只提供LEFT和RIGHT两个临时目录参数，官方文档也未明确说明传递重命名信息的方法。

解决方案 #

1. 解析Git生成的临时diff元数据文件 #

当使用--dir-diff时，Git会在临时目录下自动生成一个git_diff_index文件，里面包含了完整的diff详情（包括重命名、相似度等信息）。你可以在自定义工具的配置中引入这个文件，然后在脚本里解析它来获取重命名关系。

示例配置：

# 配置自定义diff工具
git config --global diff.tool custom-diff
git config --global difftool.custom-diff.cmd 'my-diff-script.sh "$LEFT" "$RIGHT" "$(dirname "$LEFT")/git_diff_index"'

在my-diff-script.sh中，你可以读取git_diff_index文件，提取类似rename from foo.txt和rename to bar.txt的条目，再将这些映射关系传递给你的Diff工具，让工具识别出重命名操作。

2. 绕过--dir-diff，逐个处理文件差异 #

如果不需要目录级的批量对比，可以直接去掉--dir-diff参数，让Git逐个文件调用Diff工具。此时Git会自动将重命名的原文件和新文件路径分别作为LOCAL和REMOTE参数传递给工具，无需额外处理。

示例配置：

git config --global diff.tool custom-diff
git config --global difftool.custom-diff.cmd 'my-single-file-diff.sh "$LOCAL" "$REMOTE"'

执行git difftool HEAD^后，Git会针对重命名的文件对单独调用你的工具，工具可以直接通过LOCAL和REMOTE参数识别这是一个重命名操作。

3. 使用支持Git重命名的Diff工具 #

部分主流Diff工具（如新版Meld）支持直接读取Git的diff输出，从而识别重命名。你可以直接让工具接收git diff的结果：

# 配置Meld读取Git diff输出
git config --global difftool.meld.cmd 'meld --diff "$LOCAL" "$REMOTE" --label "$(basename "$LOCAL") (HEAD^)" --label "$(basename "$REMOTE") (HEAD)"'
# 或者直接通过管道传递Git diff结果
git diff HEAD^ | meld -

这样Meld就能直接显示Git识别的重命名信息，无需额外配置脚本。

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