summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJesse Duffield <jessedduffield@gmail.com>2023-10-18 21:57:30 +1100
committerJesse Duffield <jessedduffield@gmail.com>2024-01-22 13:31:05 +1100
commit7c3d8921b737a77395851ccacb5cb1b2f659688a (patch)
tree2467f36736efb23097fcfbcd6b7e464c84b9725a
parent5c888a0b474ed2fc45c7640b4e73e2bf272f2d3c (diff)
Show unstaged file names in default colour
Previously, we had the following rules: * file names were in red when unstaged or partially staged * directory names were in red if unstaged, yellow if partially staged, and green if fully staged Red text on a black background can be hard to read, so instead I'm changing it so that unstaged files have their names in the default text colour. I'm also making it so that partially staged files are in yellow, just like how partially staged directories are yellow (same deal with the commit files view when adding to a custom patch). So the new rules are: * unstaged files/directories use the default colour * partially staged files/directories are in yellow * fully staged files/directories are in green I've also done a refactor on the code clean up some dead code from when the file tree outline was drawn with box characters, and I've made it so that the indentation in each line is handled inside the function that draws the line rather than in the recursive parent function. This makes it easier to experiment with things like showing the file status characters on the left edge of the view (admittedly after experimenting with it, I decided I didn't like it). Apologies for having a refactor and a functional change in the one commit but by the time I was done, I couldn't be bothered going back and retroactively splitting it into two halves.
-rw-r--r--pkg/gui/context/commit_files_context.go2
-rw-r--r--pkg/gui/context/working_tree_context.go2
-rw-r--r--pkg/gui/presentation/files.go244
-rw-r--r--pkg/gui/presentation/files_test.go4
4 files changed, 144 insertions, 108 deletions
diff --git a/pkg/gui/context/commit_files_context.go b/pkg/gui/context/commit_files_context.go
index 037554c91..674e5d7d6 100644
--- a/pkg/gui/context/commit_files_context.go
+++ b/pkg/gui/context/commit_files_context.go
@@ -33,7 +33,7 @@ func NewCommitFilesContext(c *ContextCommon) *CommitFilesContext {
return [][]string{{style.FgRed.Sprint("(none)")}}
}
- lines := presentation.RenderCommitFileTree(viewModel, c.Modes().Diffing.Ref, c.Git().Patch.PatchBuilder)
+ lines := presentation.RenderCommitFileTree(viewModel, c.Git().Patch.PatchBuilder)
return lo.Map(lines, func(line string, _ int) []string {
return []string{line}
})
diff --git a/pkg/gui/context/working_tree_context.go b/pkg/gui/context/working_tree_context.go
index 0e0b8d72b..4be5f531f 100644
--- a/pkg/gui/context/working_tree_context.go
+++ b/pkg/gui/context/working_tree_context.go
@@ -24,7 +24,7 @@ func NewWorkingTreeContext(c *ContextCommon) *WorkingTreeContext {
)
getDisplayStrings := func(_ int, _ int) [][]string {
- lines := presentation.RenderFileTree(viewModel, c.Modes().Diffing.Ref, c.Model().Submodules)
+ lines := presentation.RenderFileTree(viewModel, c.Model().Submodules)
return lo.Map(lines, func(line string, _ int) []string {
return []string{line}
})
diff --git a/pkg/gui/presentation/files.go b/pkg/gui/presentation/files.go
index 1df90176f..35fc4616a 100644
--- a/pkg/gui/presentation/files.go
+++ b/pkg/gui/presentation/files.go
@@ -18,141 +18,132 @@ const (
COLLAPSED_ARROW = "▶"
)
-// keeping these here as individual constants in case later on people want the old tree shape
-const (
- INNER_ITEM = " "
- LAST_ITEM = " "
- NESTED = " "
- NOTHING = " "
-)
-
func RenderFileTree(
tree filetree.IFileTree,
- diffName string,
submoduleConfigs []*models.SubmoduleConfig,
) []string {
- return renderAux(tree.GetRoot().Raw(), tree.CollapsedPaths(), "", -1, func(node *filetree.Node[models.File], depth int) string {
+ collapsedPaths := tree.CollapsedPaths()
+ return renderAux(tree.GetRoot().Raw(), collapsedPaths, -1, -1, func(node *filetree.Node[models.File], treeDepth int, visualDepth int, isCollapsed bool) string {
fileNode := filetree.NewFileNode(node)
- return getFileLine(fileNode.GetHasUnstagedChanges(), fileNode.GetHasStagedChanges(), fileNameAtDepth(node, depth), diffName, submoduleConfigs, node.File)
+ return getFileLine(isCollapsed, fileNode.GetHasUnstagedChanges(), fileNode.GetHasStagedChanges(), treeDepth, visualDepth, submoduleConfigs, node)
})
}
func RenderCommitFileTree(
tree *filetree.CommitFileTreeViewModel,
- diffName string,
patchBuilder *patch.PatchBuilder,
) []string {
- return renderAux(tree.GetRoot().Raw(), tree.CollapsedPaths(), "", -1, func(node *filetree.Node[models.CommitFile], depth int) string {
- // This is a little convoluted because we're dealing with either a leaf or a non-leaf.
- // But this code actually applies to both. If it's a leaf, the status will just
- // be whatever status it is, but if it's a non-leaf it will determine its status
- // based on the leaves of that subtree
- var status patch.PatchStatus
- if node.EveryFile(func(file *models.CommitFile) bool {
- return patchBuilder.GetFileStatus(file.Name, tree.GetRef().RefName()) == patch.WHOLE
- }) {
- status = patch.WHOLE
- } else if node.EveryFile(func(file *models.CommitFile) bool {
- return patchBuilder.GetFileStatus(file.Name, tree.GetRef().RefName()) == patch.UNSELECTED
- }) {
- status = patch.UNSELECTED
- } else {
- status = patch.PART
- }
+ collapsedPaths := tree.CollapsedPaths()
+ return renderAux(tree.GetRoot().Raw(), collapsedPaths, -1, -1, func(node *filetree.Node[models.CommitFile], treeDepth int, visualDepth int, isCollapsed bool) string {
+ status := commitFilePatchStatus(node, tree, patchBuilder)
- return getCommitFileLine(commitFileNameAtDepth(node, depth), diffName, node.File, status)
+ return getCommitFileLine(isCollapsed, treeDepth, visualDepth, node, status)
})
}
+// Returns the status of a commit file in terms of its inclusion in the custom patch
+func commitFilePatchStatus(node *filetree.Node[models.CommitFile], tree *filetree.CommitFileTreeViewModel, patchBuilder *patch.PatchBuilder) patch.PatchStatus {
+ // This is a little convoluted because we're dealing with either a leaf or a non-leaf.
+ // But this code actually applies to both. If it's a leaf, the status will just
+ // be whatever status it is, but if it's a non-leaf it will determine its status
+ // based on the leaves of that subtree
+ if node.EveryFile(func(file *models.CommitFile) bool {
+ return patchBuilder.GetFileStatus(file.Name, tree.GetRef().RefName()) == patch.WHOLE
+ }) {
+ return patch.WHOLE
+ } else if node.EveryFile(func(file *models.CommitFile) bool {
+ return patchBuilder.GetFileStatus(file.Name, tree.GetRef().RefName()) == patch.UNSELECTED
+ }) {
+ return patch.UNSELECTED
+ } else {
+ return patch.PART
+ }
+}
+
func renderAux[T any](
node *filetree.Node[T],
collapsedPaths *filetree.CollapsedPaths,
- prefix string,
- depth int,
- renderLine func(*filetree.Node[T], int) string,
+ // treeDepth is the depth of the node in the actual file tree. This is different to
+ // visualDepth because some directory nodes are compressed e.g. 'pkg/gui/blah' takes
+ // up two tree depths, but one visual depth. We need to track these separately,
+ // because indentation relies on visual depth, whereas file path truncation
+ // relies on tree depth.
+ treeDepth int,
+ visualDepth int,
+ renderLine func(*filetree.Node[T], int, int, bool) string,
) []string {
if node == nil {
return []string{}
}
- isRoot := depth == -1
+ isRoot := treeDepth == -1
if node.IsFile() {
if isRoot {
return []string{}
}
- return []string{prefix + renderLine(node, depth)}
- }
-
- if collapsedPaths.IsCollapsed(node.GetPath()) {
- return []string{prefix + COLLAPSED_ARROW + " " + renderLine(node, depth)}
+ return []string{renderLine(node, treeDepth, visualDepth, false)}
}
arr := []string{}
if !isRoot {
- arr = append(arr, prefix+EXPANDED_ARROW+" "+renderLine(node, depth))
+ isCollapsed := collapsedPaths.IsCollapsed(node.GetPath())
+ arr = append(arr, renderLine(node, treeDepth, visualDepth, isCollapsed))
}
- newPrefix := prefix
- if strings.HasSuffix(prefix, LAST_ITEM) {
- newPrefix = strings.TrimSuffix(prefix, LAST_ITEM) + NOTHING
- } else if strings.HasSuffix(prefix, INNER_ITEM) {
- newPrefix = strings.TrimSuffix(prefix, INNER_ITEM) + NESTED
+ if collapsedPaths.IsCollapsed(node.GetPath()) {
+ return arr
}
- for i, child := range node.Children {
- isLast := i == len(node.Children)-1
-
- var childPrefix string
- if isRoot {
- childPrefix = newPrefix
- } else if isLast {
- childPrefix = newPrefix + LAST_ITEM
- } else {
- childPrefix = newPrefix + INNER_ITEM
- }
-
- arr = append(arr, renderAux(child, collapsedPaths, childPrefix, depth+1+node.CompressionLevel, renderLine)...)
+ for _, child := range node.Children {
+ arr = append(arr, renderAux(child, collapsedPaths, treeDepth+1+node.CompressionLevel, visualDepth+1, renderLine)...)
}
return arr
}
-func getFileLine(hasUnstagedChanges bool, hasStagedChanges bool, name string, diffName string, submoduleConfigs []*models.SubmoduleConfig, file *models.File) string {
- // potentially inefficient to be instantiating these color
- // objects with each render
- partiallyModifiedColor := style.FgYellow
-
- restColor := style.FgGreen
- if name == diffName {
- restColor = theme.DiffTerminalColor
- } else if file == nil && hasStagedChanges && hasUnstagedChanges {
- restColor = partiallyModifiedColor
- } else if hasUnstagedChanges {
- restColor = theme.UnstagedChangesColor
+func getFileLine(
+ isCollapsed bool,
+ hasUnstagedChanges bool,
+ hasStagedChanges bool,
+ treeDepth int,
+ visualDepth int,
+ submoduleConfigs []*models.SubmoduleConfig,
+ node *filetree.Node[models.File],
+) string {
+ name := fileNameAtDepth(node, treeDepth)
+ output := ""
+
+ var nameColor style.TextStyle
+
+ file := node.File
+
+ indentation := strings.Repeat(" ", visualDepth)
+
+ if hasStagedChanges && !hasUnstagedChanges {
+ nameColor = style.FgGreen
+ } else if hasStagedChanges {
+ nameColor = style.FgYellow
+ } else {
+ nameColor = theme.DefaultTextColor
}
- output := ""
- if file != nil {
- // this is just making things look nice when the background attribute is 'reverse'
- firstChar := file.ShortStatus[0:1]
- firstCharCl := style.FgGreen
- if firstChar == "?" {
- firstCharCl = theme.UnstagedChangesColor
- } else if firstChar == " " {
- firstCharCl = restColor
+ if file == nil {
+ output += indentation + ""
+ arrow := EXPANDED_ARROW
+ if isCollapsed {
+ arrow = COLLAPSED_ARROW
}
- secondChar := file.ShortStatus[1:2]
- secondCharCl := theme.UnstagedChangesColor
- if secondChar == " " {
- secondCharCl = restColor
- }
+ arrowStyle := nameColor
- output = firstCharCl.Sprint(firstChar)
- output += secondCharCl.Sprint(secondChar)
- output += restColor.Sprint(" ")
+ output += arrowStyle.Sprint(arrow) + " "
+ } else {
+ // Sprinting the space at the end in the specific style is for the sake of
+ // when a reverse style is used in the theme, which looks ugly if you just
+ // use the default style
+ output += indentation + formatFileStatus(file, nameColor) + nameColor.Sprint(" ")
}
isSubmodule := file != nil && file.IsSubmodule(submoduleConfigs)
@@ -162,10 +153,10 @@ func getFileLine(hasUnstagedChanges bool, hasStagedChanges bool, name string, di
if icons.IsIconEnabled() {
icon := icons.IconForFile(name, isSubmodule, isLinkedWorktree, isDirectory)
paint := color.C256(icon.Color, false)
- output += paint.Sprint(icon.Icon) + " "
+ output += paint.Sprint(icon.Icon) + nameColor.Sprint(" ")
}
- output += restColor.Sprint(utils.EscapeSpecialChars(name))
+ output += nameColor.Sprint(utils.EscapeSpecialChars(name))
if isSubmodule {
output += theme.DefaultTextColor.Sprint(" (submodule)")
@@ -174,31 +165,76 @@ func getFileLine(hasUnstagedChanges bool, hasStagedChanges bool, name string, di
return output
}
-func getCommitFileLine(name string, diffName string, commitFile *models.CommitFile, status patch.PatchStatus) string {
- var colour style.TextStyle
- if diffName == name {
- colour = theme.DiffTerminalColor
+func formatFileStatus(file *models.File, restColor style.TextStyle) string {
+ firstChar := file.ShortStatus[0:1]
+ firstCharCl := style.FgGreen
+ if firstChar == "?" {
+ firstCharCl = theme.UnstagedChangesColor
+ } else if firstChar == " " {
+ firstCharCl = restColor
+ }
+
+ secondChar := file.ShortStatus[1:2]
+ secondCharCl := theme.UnstagedChangesColor
+ if secondChar == " " {
+ secondCharCl = restColor
+ }
+
+ return firstCharCl.Sprint(firstChar) + secondCharCl.Sprint(secondChar)
+}
+
+func getCommitFileLine(
+ isCollapsed bool,
+ treeDepth int,
+ visualDepth int,
+ node *filetree.Node[models.CommitFile],
+ status patch.PatchStatus,
+) string {
+ indentation := strings.Repeat(" ", visualDepth)
+ name := commitFileNameAtDepth(node, treeDepth)
+ commitFile := node.File
+ output := indentation
+
+ isDirectory := commitFile == nil
+
+ nameColor := theme.DefaultTextColor
+
+ switch status {
+ case patch.WHOLE:
+ nameColor = style.FgGreen
+ case patch.PART:
+ nameColor = style.FgYellow
+ case patch.UNSELECTED:
+ nameColor = theme.DefaultTextColor
+ }
+
+ if isDirectory {
+ arrow := EXPANDED_ARROW
+ if isCollapsed {
+ arrow = COLLAPSED_ARROW
+ }
+
+ output += nameColor.Sprint(arrow) + " "
} else {
+ var symbol string
+ symbolStyle := nameColor
+
switch status {
case patch.WHOLE:
- colour = style.FgGreen
+ symbol = "●"
case patch.PART:
- colour = style.FgYellow
+ symbol = "◐"
case patch.UNSELECTED:
- colour = theme.DefaultTextColor
+ symbol = commitFile.ChangeStatus
+ symbolStyle = getColorForChangeStatus(symbol)
}
- }
-
- output := ""
- name = utils.EscapeSpecialChars(name)
- if commitFile != nil {
- output += getColorForChangeStatus(commitFile.ChangeStatus).Sprint(commitFile.ChangeStatus) + " "
+ output += symbolStyle.Sprint(symbol) + " "
}
+ name = utils.EscapeSpecialChars(name)
isSubmodule := false
isLinkedWorktree := false
- isDirectory := commitFile == nil
if icons.IsIconEnabled() {
icon := icons.IconForFile(name, isSubmodule, isLinkedWorktree, isDirectory)
@@ -206,7 +242,7 @@ func getCommitFileLine(name string, diffName string, commitFile *models.CommitFi
output += paint.Sprint(icon.Icon) + " "
}
- output += colour.Sprint(name)
+ output += nameColor.Sprint(name)
return output
}
diff --git a/pkg/gui/presentation/files_test.go b/pkg/gui/presentation/files_test.go
index f6019a244..b6b543c65 100644
--- a/pkg/gui/presentation/files_test.go
+++ b/pkg/gui/presentation/files_test.go
@@ -74,7 +74,7 @@ M file1
for _, path := range s.collapsedPaths {
viewModel.ToggleCollapsed(path)
}
- result := RenderFileTree(viewModel, "", nil)
+ result := RenderFileTree(viewModel, nil)
assert.EqualValues(t, s.expected, result)
})
}
@@ -141,7 +141,7 @@ M file1
},
)
patchBuilder.Start("from", "to", false, false)
- result := RenderCommitFileTree(viewModel, "", patchBuilder)
+ result := RenderCommitFileTree(viewModel, patchBuilder)
assert.EqualValues(t, s.expected, result)
})
}