Lazygit中未跟踪文件的存储差异显示问题解析

在Git版本控制系统中，git stash命令是开发者常用的工具之一，它允许临时保存工作目录中的修改而不提交。Lazygit作为Git的终端用户界面(TUI)，为用户提供了更友好的交互体验。然而，在处理包含未跟踪文件的存储条目时，Lazygit的默认行为存在一些值得探讨的问题。

问题背景

当开发者使用git stash --include-untracked命令存储包含未跟踪文件的修改时，Git会将这些文件一并保存。但在Lazygit界面中查看这些存储条目时，未跟踪文件的差异内容默认不会显示在主视图中。这一行为与直接使用Git命令行工具时的表现不同，后者通过git stash show命令会显示所有存储的变更，包括未跟踪文件。

技术分析

深入探究这一问题，我们发现Git本身提供了stash.showIncludeUntracked配置选项来控制是否在显示存储差异时包含未跟踪文件。默认情况下，Git不会自动显示这些内容，这可能是出于历史兼容性或性能考虑。开发者可以通过以下命令全局启用这一功能：

git config --global stash.showIncludeUntracked true

在Lazygit的实现中，当前版本遵循了Git的默认配置，没有主动传递--include-untracked标志。这导致即使用户在Git配置中启用了相关选项，Lazygit的"diff files"面板（用于应用自定义补丁）仍然不会显示未跟踪文件，这显然是一个需要修复的缺陷。

解决方案探讨

针对这一问题，社区提出了几种解决方案思路：

1. 遵循Git配置：保持与Git行为一致，仅当用户配置了stash.showIncludeUntracked时才显示未跟踪文件。这种方案最为保守，确保与Git命令行工具的行为完全一致。

2. 主动包含未跟踪文件：Lazygit可以主动传递--include-untracked标志，提供更好的默认体验。这种做法虽然偏离了Git的默认行为，但可能更符合用户预期。

3. 提供配置选项：在Lazygit中新增配置项，让用户自行决定是否显示未跟踪的存储文件。这种方案增加了灵活性，但也带来了额外的配置复杂度。

经过社区讨论，最终决定采用第一种方案，即尊重Git的配置设置。这一选择保持了与Git工具链的一致性，同时通过修复"diff files"面板的显示问题来完善用户体验。

对开发者的建议

对于依赖存储功能的开发者，建议：

1. 明确了解Git存储命令的行为差异，特别是--include-untracked和--all等选项的区别。

2. 根据个人工作习惯，考虑是否设置stash.showIncludeUntracked全局配置。

3. 在使用Lazygit时，注意存储面板和差异视图之间的关联，确保重要变更不会被遗漏。

这一问题的讨论和解决过程展示了开源社区如何通过技术探讨找到平衡点，既尊重上游工具的设计决策，又努力提供最佳的用户体验。