feat(common): add symbols to git status component, closes #148 (#173)

Author: cseickel

.gitignore

@@ -41,3 +41,6 @@ luac.out
 
 # Vim tag files
 tags
+
+#example
+ignored

README.md

@@ -4,7 +4,7 @@ Neo-tree is a Neovim plugin to browse the file system and other tree like
 structures in whatever style suits you, including sidebars, floating windows,
 netrw split style, or all of them at once!
 
-![Neo-tree file system](https://github.com/nvim-neo-tree/resources/raw/main/images/Neo-tree-filesystem.png)
+![Neo-tree file system](https://github.com/nvim-neo-tree/resources/raw/main/images/Neo-tree-2.0-with-git-symbols.png)
 
 ### Breaking Changes BAD :bomb: :imp:
 
@@ -82,7 +82,19 @@ use {
             use_git_status_colors = true,
           },
           git_status = {
-            highlight = "NeoTreeDimText", -- if you remove this the status will be colorful
+            symbols = {
+              -- Change type
+              added     = "✚",
+              deleted   = "✖",
+              modified  = "",
+              renamed   = "",
+              -- Status type
+              untracked = "",
+              ignored   = "",
+              unstaged  = "",
+              staged    = "",
+              conflict  = "",
+            }
           },
         },
         filesystem = {

doc/neo-tree.txt

@@ -429,6 +429,50 @@ config when calling the setup function. To just disable colors on file or
 directory names, you can set `use_git_status_colors = false` in the `name`
 component of your renderer(s).
 
+Starting with 2.0, this will display symbols by default. The default symbols
+will require a nerd font to be installed. To change these symbols, you can set
+the following properties:
+>
+    require("neo-tree").setup({
+      default_component_configs = {
+        symbols = {
+          -- Change type
+          added     = "✚",
+          deleted   = "✖",
+          modified  = "",
+          renamed   = "",
+          -- Status type
+          untracked = "",
+          ignored   = "",
+          unstaged  = "",
+          staged    = "",
+          conflict  = "",
+        }
+      }
+    })
+<
+To change the color of these symbols, you can edit the corresponding highlight
+groups:
+
+    NeoTreeGitAdded
+    NeoTreeGitConflict
+    NeoTreeGitDeleted
+    NeoTreeGitIgnored
+    NeoTreeGitModified
+    NeoTreeGitUntracked
+
+To revert to the previous behavior of passing the git status through as-is
+with codes like `[M ]` for changed/unstaged, and `[ M]` for changed/staged,
+you can set the `symbols` property to nil or false:
+>
+    require("neo-tree").setup({
+      default_component_configs = {
+        git_status = {
+          symbols = false
+        }
+      }
+    })
+<
 See also: |neo-tree-git-status-source|
 
 
@@ -534,6 +578,7 @@ NeoTreeTitleBar           Used for the title bar of pop-ups, when the border-sty
                           is set to "NC". This is derived from NeoTreeFloatBorder.
 NeoTreeGitAdded           File name when the git status is added.
 NeoTreeGitConflict        File name when the git status is conflict.
+NeoTreeGitDeleted         File name when the git status is deleted.
 NeoTreeGitIgnored         File name when the git status is ignored.
 NeoTreeGitModified        File name when the git status is modified.
 NeoTreeGitUntracked       File name when the git status is untracked.

lua/neo-tree/defaults.lua

@@ -68,7 +68,19 @@ local config = {
       use_git_status_colors = true,
     },
     git_status = {
-      highlight = "NeoTreeDimText",
+      symbols = {
+        -- Change type
+        added     = "✚",
+        deleted   = "✖",
+        modified  = "",
+        renamed   = "",
+        -- Status type
+        untracked = "",
+        ignored   = "",
+        unstaged  = "",
+        staged    = "",
+        conflict  = "",
+      }
     },
   },
   filesystem = {

lua/neo-tree/sources/common/components.lua

@@ -11,6 +11,7 @@
 --    highlight: The highlight group to apply to this text.
 
 local highlights = require("neo-tree.ui.highlights")
+local utils      = require("neo-tree.utils")
 
 local M = {}
 
@@ -86,25 +87,83 @@ M.git_status = function(config, node, state)
     end
   end
 
-  local highlight = highlights.FILE_NAME
+  local symbols = config.symbols or {}
+  local change_symbol
+  local change_highlt = highlights.FILE_NAME
+  local status_symbol = symbols.unstaged
+  local status_highlt = highlights.GIT_CONFLICT
+
+  if git_status:sub(2, 2) == " " then
+    status_symbol = symbols.staged
+    status_highlt = highlights.GIT_ADDED
+  end
+
   if git_status:match("?$") then
-    highlight = highlights.GIT_UNTRACKED
-  elseif git_status:match("U") then
-    highlight = highlights.GIT_CONFLICT
+    status_symbol = nil
+    status_highlt = highlights.GIT_UNTRACKED
+    change_symbol = symbols.untracked
+    change_highlt = highlights.GIT_UNTRACKED
+  -- all variations of merge conflicts
+  elseif git_status == "DD" then
+    status_symbol = symbols.conflict
+    status_highlt = highlights.GIT_CONFLICT
+    change_symbol = symbols.deleted
+    change_highlt = highlights.GIT_CONFLICT
+  elseif git_status == "UU" then
+    status_symbol = symbols.conflict
+    status_highlt = highlights.GIT_CONFLICT
+    change_symbol = symbols.modified
+    change_highlt = highlights.GIT_CONFLICT
   elseif git_status == "AA" then
-    highlight = highlights.GIT_CONFLICT
+    status_symbol = symbols.conflict
+    status_highlt = highlights.GIT_CONFLICT
+    change_symbol = symbols.added
+    change_highlt = highlights.GIT_CONFLICT
+  elseif git_status:match("U") then
+    status_symbol = symbols.conflict
+    status_highlt = highlights.GIT_CONFLICT
+    if git_status:match("A") then
+      change_symbol = symbols.added
+    elseif git_status:match("D") then
+      change_symbol = symbols.deleted
+    end
+    change_highlt = highlights.GIT_CONFLICT
+  -- end merge conflict section
   elseif git_status:match("M") then
-    highlight = highlights.GIT_MODIFIED
-  elseif git_status:match("[ACRT]") then
-    highlight = highlights.GIT_ADDED
+    change_symbol = symbols.modified
+    change_highlt = highlights.GIT_MODIFIED
+  elseif git_status:match("R") then
+    change_symbol = symbols.renamed
+    change_highlt = highlights.GIT_RENAMED
+  elseif git_status:match("[ACT]") then
+    change_symbol = symbols.added
+    change_highlt = highlights.GIT_ADDED
   elseif git_status:match("!") then
-    highlight = highlights.GIT_IGNORED
+    status_symbol = nil
+    change_symbol = symbols.ignored
+    change_highlt = highlights.GIT_IGNORED
+  end
+
+  if change_symbol then
+    local components = {}
+    components[1] = {
+      text = " " .. change_symbol,
+      highlight = change_highlt,
+    }
+    if status_symbol then
+      components[2] = {
+        text = " " .. status_symbol,
+        highlight = status_highlt,
+      }
+    end
+    return components
+  else
+    return {
+      text = " [" .. git_status .. "]",
+      highlight = config.highlight or change_highlt,
+    }
   end
 
-  return {
-    text = " [" .. git_status .. "]",
-    highlight = config.highlight or highlight,
-  }
 end
 
 M.filtered_by = function(config, node, state)

lua/neo-tree/ui/highlights.lua

@@ -15,8 +15,10 @@ M.FLOAT_BORDER = "NeoTreeFloatBorder"
 M.FLOAT_TITLE = "NeoTreeFloatTitle"
 M.GIT_ADDED = "NeoTreeGitAdded"
 M.GIT_CONFLICT = "NeoTreeGitConflict"
+M.GIT_DELETED = "NeoTreeGitDeleted"
 M.GIT_IGNORED = "NeoTreeGitIgnored"
 M.GIT_MODIFIED = "NeoTreeGitModified"
+M.GIT_RENAMED = "NeoTreeGitRenamed"
 M.GIT_UNTRACKED = "NeoTreeGitUntracked"
 M.HIDDEN_BY_NAME = "NeoTreeHiddenByName"
 M.INDENT_MARKER = "NeoTreeIndentMarker"
@@ -42,6 +44,8 @@ end
 --is not defined and it is not linked to another group.
 ---@param foreground string The foreground color to use, in hex, if the highlight group
 --is not defined and it is not linked to another group.
+---@gui string The gui to use, if the highlight group is not defined and it is not linked
+--to another group.
 ---@return table table The highlight group values.
 local function create_highlight_group(hl_group_name, link_to_if_exists, background, foreground, gui)
   local success, hl_group = pcall(vim.api.nvim_get_hl_by_name, hl_group_name, true)
@@ -101,23 +105,22 @@ M.setup = function()
   create_highlight_group(M.FLOAT_TITLE, {}, float_border_hl.background, normal_hl.foreground)
   create_highlight_group(M.TITLE_BAR, {}, float_border_hl.foreground, nil)
 
-  create_highlight_group(M.GIT_ADDED, { "GitGutterAdd", "GitSignsAdd" }, nil, "5faf5f")
-
-  create_highlight_group(M.GIT_CONFLICT, { "GitGutterDelete", "GitSignsDelete" }, nil, "ff5900")
-
-  local modified = create_highlight_group(
+  local added = create_highlight_group(M.GIT_ADDED, { "GitGutterAdd", "GitSignsAdd" }, nil, "5faf5f")
+  create_highlight_group(M.GIT_DELETED, { "GitGutterDelete", "GitSignsDelete" }, nil, "ff5900")
+  create_highlight_group(
     M.GIT_MODIFIED,
     { "GitGutterChange", "GitSignsChange" },
     nil,
     "d7af5f"
   )
-
-  create_highlight_group(M.GIT_UNTRACKED, {}, nil, modified.foreground, "italic")
+  local conflict = create_highlight_group(M.GIT_CONFLICT, {}, nil, "ff8700", "italic,bold")
+  create_highlight_group(M.GIT_IGNORED, { M.DOTFILE }, nil, nil)
+  create_highlight_group(M.GIT_RENAMED, { M.GIT_MODIFIED }, nil, nil)
+  create_highlight_group(M.GIT_UNTRACKED, {}, nil, conflict.foreground, "italic")
 
   create_highlight_group(M.BUFFER_NUMBER, { "SpecialChar" })
   create_highlight_group(M.DIM_TEXT, {}, nil, "505050")
   create_highlight_group(M.DOTFILE, {}, nil, "626262")
-  create_highlight_group(M.GIT_IGNORED, { M.DOTFILE }, nil, nil)
   create_highlight_group(M.HIDDEN_BY_NAME, { M.DOTFILE }, nil, nil)
   create_highlight_group(M.CURSOR_LINE, { "CursorLine" }, nil, nil, "bold")
   create_highlight_group(M.DIRECTORY_NAME, {}, "NONE", "NONE")

lua/neo-tree/ui/renderer.lua

@@ -80,7 +80,6 @@ local remove_filtered = function(source_items, filtered_items)
   for _, child in ipairs(source_items) do
     local fby = child.filtered_by
     if type(fby) == "table" then
-      log.info("filtered_by is a table", fby)
       if filtered_items.visible and not fby.never_show then
         table.insert(filtered, child)
       end