feat: add symbols for git status component, closes #148

Author: cseickel

doc/neo-tree.txt

@@ -429,6 +429,48 @@ 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 = {
+          added = "✚",
+          conflict = "ﲅ",
+          ignored = "○",
+          modified = "",
+          renamed = "🠊",
+          staged = "",
+          unstaged = "",
+          unmerged = "",
+          untracked = "",
+        }
+      }
+    })
+<
+To change the color of these symbols, you can edit the corresponding highlight
+groups:
+
+    NeoTreeGitAdded
+    NeoTreeGitConflict
+    NeoTreeGitIgnored
+    NeoTreeGitModified
+    NeoTreeGitUnmerged
+    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|
 
 
@@ -531,6 +573,7 @@ NeoTreeGitAdded           File name when the git status is added.
 NeoTreeGitConflict        File name when the git status is conflict.
 NeoTreeGitIgnored         File name when the git status is ignored.
 NeoTreeGitModified        File name when the git status is modified.
+NeoTreeGitUnmerged        File name when the git status is unmerged.
 NeoTreeGitUntracked       File name when the git status is untracked.
 NeoTreeHiddenByName       Used for icons and names when `hide_by_name` is used.
 NeoTreeIndentMarker       The style of indentation markers (guides). By default,

lua/neo-tree/defaults.lua

@@ -68,7 +68,17 @@ local config = {
       use_git_status_colors = true,
     },
     git_status = {
-      highlight = "NeoTreeDimText",
+      symbols = {
+        added = "✚",
+        conflict = "ﲅ",
+        ignored = "○",
+        modified = "",
+        renamed = "🠊",
+        staged = "",
+        unmerged = "",
+        unstaged = "",
+        untracked = "",
+      }
     },
   },
   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,72 @@ M.git_status = function(config, node, state)
     end
   end
 
+  local symbols = config.symbols or {}
+  local status
   local highlight = highlights.FILE_NAME
+  local staged = symbols.unstaged
+  local staged_hl = highlights.GIT_CONFLICT
+
+  if git_status:sub(2, 2) == " " then
+    staged = symbols.staged
+    staged_hl = highlights.GIT_ADDED
+  end
+
   if git_status:match("?$") then
+    staged = nil
+    status = symbols.untracked
+    staged_hl = highlights.GIT_UNTRACKED
     highlight = highlights.GIT_UNTRACKED
-  elseif git_status:match("U") then
+  elseif git_status == "UU" then
+    staged = symbols.unmerged
+    staged_hl = highlights.GIT_UNMERGED
+    status = symbols.conflict
     highlight = highlights.GIT_CONFLICT
   elseif git_status == "AA" then
+    staged = symbols.unmerged
+    staged_hl = highlights.GIT_UNMERGED
+    status = symbols.conflict
+    highlight = highlights.GIT_CONFLICT
+  elseif git_status:match("U") then
+    staged = symbols.unmerged
+    staged_hl = highlights.GIT_UNMERGED
+    status = symbols.conflict
     highlight = highlights.GIT_CONFLICT
   elseif git_status:match("M") then
+    status = symbols.modified
     highlight = highlights.GIT_MODIFIED
-  elseif git_status:match("[ACRT]") then
+  elseif git_status:match("R") then
+    status = symbols.renamed
+    highlight = highlights.modified
+  elseif git_status:match("[ACT]") then
+    status = symbols.added
     highlight = highlights.GIT_ADDED
   elseif git_status:match("!") then
+    staged = nil
+    status = symbols.ignored
     highlight = highlights.GIT_IGNORED
   end
 
-  return {
-    text = " [" .. git_status .. "]",
-    highlight = config.highlight or highlight,
-  }
+  if status then
+    local components = {}
+    components[1] = {
+      text = " " .. status,
+      highlight = highlight,
+    }
+    if staged then
+      components[2] = {
+        text = " " .. staged,
+        highlight = staged_hl,
+      }
+    end
+    return components
+  else
+    return {
+      text = " [" .. git_status .. "]",
+      highlight = config.highlight or highlight,
+    }
+  end
+
 end
 
 M.filtered_by = function(config, node, state)

lua/neo-tree/ui/highlights.lua

@@ -17,6 +17,7 @@ M.GIT_CONFLICT = "NeoTreeGitConflict"
 M.GIT_IGNORED = "NeoTreeGitIgnored"
 M.GIT_MODIFIED = "NeoTreeGitModified"
 M.GIT_UNTRACKED = "NeoTreeGitUntracked"
+M.GIT_UNMERGED = "NeoTreeGitUnmerged"
 M.HIDDEN_BY_NAME = "NeoTreeHiddenByName"
 M.INDENT_MARKER = "NeoTreeIndentMarker"
 M.NORMAL = "NeoTreeNormal"
@@ -41,6 +42,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)
@@ -99,18 +102,16 @@ M.setup = function()
 
   create_highlight_group(M.TITLE_BAR, {}, float_border_hl.foreground, nil)
 
-  create_highlight_group(M.GIT_ADDED, { "GitGutterAdd", "GitSignsAdd" }, nil, "5faf5f")
-
+  local added = 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(
+  create_highlight_group(
     M.GIT_MODIFIED,
     { "GitGutterChange", "GitSignsChange" },
     nil,
     "d7af5f"
   )
-
-  create_highlight_group(M.GIT_UNTRACKED, {}, nil, modified.foreground, "italic")
+  create_highlight_group(M.GIT_UNMERGED, {}, nil, "ff8700", "italic,bold")
+  create_highlight_group(M.GIT_UNTRACKED, {}, nil, added.foreground, "italic")
 
   create_highlight_group(M.BUFFER_NUMBER, { "SpecialChar" })
   create_highlight_group(M.DIM_TEXT, {}, nil, "505050")

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