Add user config for hiding the root item in the file tree (#4593)

- **PR Description** In #4346 we added a `/` root item in the Files and CommitFiles panels whenever there is more than one top-level item. We made it unconditional, but I promised to add a config as soon as users ask for being able to disable it. For a while I was able to convince users who asked for it that it is useful and they don't want to turn it off, but now there's a [stronger request](#4590 (reply in thread)) from someone who refuses to upgrade to the current version, and we don't want that. So, add a config option `gui.showRootItemInFileTree` that is true by default.

Author: stefanhaller

docs/Config.md

@@ -190,6 +190,9 @@ gui:
  # This can be toggled from within Lazygit with the '`' key, but that will not change the default.
  showFileTree: true
 
+ # If true, add a "/" root item in the file tree representing the root of the repository. It is only added when necessary, i.e. when there is more than one item at top level.
+ showRootItemInFileTree: true
+
  # If true, show the number of lines changed per file in the Files view
  showNumstatInFilesView: false
 

pkg/config/user_config.go

@@ -123,6 +123,8 @@ type GuiConfig struct {
 // If true, display the files in the file views as a tree. If false, display the files as a flat list.
 // This can be toggled from within Lazygit with the '`' key, but that will not change the default.
 ShowFileTree bool `yaml:"showFileTree"`
+// If true, add a "/" root item in the file tree representing the root of the repository. It is only added when necessary, i.e. when there is more than one item at top level.
+ShowRootItemInFileTree bool `yaml:"showRootItemInFileTree"`
 // If true, show the number of lines changed per file in the Files view
 ShowNumstatInFilesView bool `yaml:"showNumstatInFilesView"`
 // If true, show a random tip in the command log when Lazygit starts
@@ -764,6 +766,7 @@ func GetDefaultConfig() *UserConfig {
 ShowBottomLine: true,
 ShowPanelJumps: true,
 ShowFileTree: true,
+ShowRootItemInFileTree: true,
 ShowNumstatInFilesView: false,
 ShowRandomTip: true,
 ShowIcons: false,

pkg/gui/context/commit_files_context.go

@@ -29,7 +29,7 @@ var (
 func NewCommitFilesContext(c *ContextCommon) *CommitFilesContext {
 viewModel := filetree.NewCommitFileTreeViewModel(
 func() []*models.CommitFile { return c.Model().CommitFiles },
-c.Log,
+c.Common,
 c.UserConfig().Gui.ShowFileTree,
 )
 

pkg/gui/context/working_tree_context.go

@@ -24,14 +24,14 @@ var (
 func NewWorkingTreeContext(c *ContextCommon) *WorkingTreeContext {
 viewModel := filetree.NewFileTreeViewModel(
 func() []*models.File { return c.Model().Files },
-c.Log,
+c.Common,
 c.UserConfig().Gui.ShowFileTree,
 )
 
 getDisplayStrings := func(_ int, _ int) [][]string {
 showFileIcons := icons.IsIconEnabled() && c.UserConfig().Gui.ShowFileIcons
 showNumstat := c.UserConfig().Gui.ShowNumstatInFilesView
-lines := presentation.RenderFileTree(viewModel, c.Model().Submodules, showFileIcons, showNumstat, &c.UserConfig().Gui.CustomIcons)
+lines := presentation.RenderFileTree(viewModel, c.Model().Submodules, showFileIcons, showNumstat, &c.UserConfig().Gui.CustomIcons, c.UserConfig().Gui.ShowRootItemInFileTree)
 return lo.Map(lines, func(line string, _ int) []string {
 return []string{line}
 })

pkg/gui/filetree/build_tree.go

@@ -7,14 +7,14 @@ import (
 "github.com/jesseduffield/lazygit/pkg/commands/models"
 )
 
-func BuildTreeFromFiles(files []*models.File) *Node[models.File] {
+func BuildTreeFromFiles(files []*models.File, showRootItem bool) *Node[models.File] {
 root := &Node[models.File]{}
 
 childrenMapsByNode := make(map[*Node[models.File]]map[string]*Node[models.File])
 
 var curr *Node[models.File]
 for _, file := range files {
-splitPath := split("./" + file.Path)
+splitPath := SplitFileTreePath(file.Path, showRootItem)
 curr = root
 outer:
 for i := range splitPath {
@@ -63,19 +63,19 @@ func BuildTreeFromFiles(files []*models.File) *Node[models.File] {
 return root
 }
 
-func BuildFlatTreeFromCommitFiles(files []*models.CommitFile) *Node[models.CommitFile] {
-rootAux := BuildTreeFromCommitFiles(files)
+func BuildFlatTreeFromCommitFiles(files []*models.CommitFile, showRootItem bool) *Node[models.CommitFile] {
+rootAux := BuildTreeFromCommitFiles(files, showRootItem)
 sortedFiles := rootAux.GetLeaves()
 
 return &Node[models.CommitFile]{Children: sortedFiles}
 }
 
-func BuildTreeFromCommitFiles(files []*models.CommitFile) *Node[models.CommitFile] {
+func BuildTreeFromCommitFiles(files []*models.CommitFile, showRootItem bool) *Node[models.CommitFile] {
 root := &Node[models.CommitFile]{}
 
 var curr *Node[models.CommitFile]
 for _, file := range files {
-splitPath := split("./" + file.Path)
+splitPath := SplitFileTreePath(file.Path, showRootItem)
 curr = root
 outer:
 for i := range splitPath {
@@ -115,8 +115,8 @@ func BuildTreeFromCommitFiles(files []*models.CommitFile) *Node[models.CommitFil
 return root
 }
 
-func BuildFlatTreeFromFiles(files []*models.File) *Node[models.File] {
-rootAux := BuildTreeFromFiles(files)
+func BuildFlatTreeFromFiles(files []*models.File, showRootItem bool) *Node[models.File] {
+rootAux := BuildTreeFromFiles(files, showRootItem)
 sortedFiles := rootAux.GetLeaves()
 
 // from top down we have merge conflict files, then tracked file, then untracked
@@ -160,3 +160,11 @@ func split(str string) []string {
 func join(strs []string) string {
 return strings.Join(strs, "/")
 }
+
+func SplitFileTreePath(path string, showRootItem bool) []string {
+if showRootItem {
+return split("./" + path)
+}
+
+return split(path)
+}