feat(#2415): normalise and add modified groups

Author: alex-courtis

doc/nvim-tree-lua.txt

@@ -2188,7 +2188,6 @@ Standard: >
 File Text: >
     NvimTreeExecFile            Constant
     NvimTreeImageFile           PreProc
-    NvimTreeModifiedFile        Constant
     NvimTreeOpenedFile          Constant
     NvimTreeSpecialFile         PreProc
     NvimTreeSymlink             Statement
@@ -2217,12 +2216,15 @@ Clipboard: >
     NvimTreeCopiedHL            SpellRare
     NvimTreeCutHL               SpellBad
 <
-Bookmark Icon: >
+Bookmarks: >
     NvimTreeBookmark            Constant
-<
-Bookmark Highlight: >
     NvimTreeBookmarkHL          SpellLocal
 <
+Modified: >
+    NvimTreeModifiedIcon        Constant
+    NvimTreeModifiedFileHL      NvimTreeModifiedIcon
+    NvimTreeModifiedFolderHL    NvimTreeModifiedIcon
+<
 Picker: >
     NvimTreeWindowPicker        guifg=#ededed guibg=#4493c8 gui=bold ctermfg=White ctermbg=Cyan
 <
@@ -2239,7 +2241,7 @@ Git Icon: >
     NvimTreeGitRenamedIcon      PreProc
     NvimTreeGitStagedIcon       Constant
 <
-Git File Text: >
+Git File File Highlight: >
     NvimTreeGitFileDeletedHL    NvimTreeGitDeletedIcon
     NvimTreeGitFileDirtyHL      NvimTreeGitDirtyIcon
     NvimTreeGitFileIgnoredHL    NvimTreeGitIgnoredIcon
@@ -2248,7 +2250,7 @@ Git File Text: >
     NvimTreeGitFileRenamedHL    NvimTreeGitRenamedIcon
     NvimTreeGitFileStagedHL     NvimTreeGitStagedIcon
 <
-Git Folder Text: >
+Git Folder Folder Highlight: >
     NvimTreeGitFolderDeletedHL  NvimTreeGitFileDeletedHL
     NvimTreeGitFolderDirtyHL    NvimTreeGitFileDirtyHL
     NvimTreeGitFolderIgnoredHL  NvimTreeGitFileIgnoredHL
@@ -2305,6 +2307,8 @@ Legacy diagnostic HL style may be applied: >
 Legacy highlight group are still obeyed when they are defined and the current
 highlight group is not, hard linking as follows: >
 
+    NvimTreeModifiedIcon        NvimTreeModifiedFile
+
     NvimTreeGitDeletedIcon      NvimTreeGitDeleted
     NvimTreeGitDirtyIcon        NvimTreeGitDirty
     NvimTreeGitIgnoredIcon      NvimTreeGitIgnored

lua/nvim-tree/colors.lua

@@ -31,7 +31,6 @@ local DEFAULT_LINKS = {
   -- File Text
   NvimTreeExecFile = "Constant",
   NvimTreeImageFile = "PreProc",
-  NvimTreeModifiedFile = "Constant",
   NvimTreeOpenedFile = "Constant",
   NvimTreeSpecialFile = "PreProc",
   NvimTreeSymlink = "Statement",
@@ -65,6 +64,11 @@ local DEFAULT_LINKS = {
   -- Bookmark Highlight
   NvimTreeBookmarkHL = "SpellLocal",
 
+  -- Modified
+  NvimTreeModifiedIcon = "Constant",
+  NvimTreeModifiedFileHL = "NvimTreeModifiedIcon",
+  NvimTreeModifiedFolderHL = "NvimTreeModifiedFileHL",
+
   -- LiveFilter
   NvimTreeLiveFilterPrefix = "PreProc",
   NvimTreeLiveFilterValue = "ModeMsg",
@@ -78,7 +82,7 @@ local DEFAULT_LINKS = {
   NvimTreeGitRenamedIcon = "PreProc",
   NvimTreeGitStagedIcon = "Constant",
 
-  -- Git File Text
+  -- Git File Highlight
   NvimTreeGitFileDeletedHL = "NvimTreeGitDeletedIcon",
   NvimTreeGitFileDirtyHL = "NvimTreeGitDirtyIcon",
   NvimTreeGitFileIgnoredHL = "NvimTreeGitIgnoredIcon",
@@ -87,7 +91,7 @@ local DEFAULT_LINKS = {
   NvimTreeGitFileRenamedHL = "NvimTreeGitRenamedIcon",
   NvimTreeGitFileStagedHL = "NvimTreeGitStagedIcon",
 
-  -- Git Folder Text
+  -- Git Folder Highlight
   NvimTreeGitFolderDeletedHL = "NvimTreeGitFileDeletedHL",
   NvimTreeGitFolderDirtyHL = "NvimTreeGitFileDirtyHL",
   NvimTreeGitFolderIgnoredHL = "NvimTreeGitFileIgnoredHL",
@@ -117,6 +121,8 @@ local DEFAULT_LINKS = {
 
 -- nvim-tree highlight groups to legacy
 local LEGACY_LINKS = {
+  NvimTreeModifiedIcon = "NvimTreeModifiedFile",
+
   NvimTreeGitDeletedIcon = "NvimTreeGitDeleted",
   NvimTreeGitDirtyIcon = "NvimTreeGitDirty",
   NvimTreeGitIgnoredIcon = "NvimTreeGitIgnored",

lua/nvim-tree/renderer/builder.lua

@@ -58,11 +58,6 @@ function Builder:configure_opened_file_highlighting(highlight_opened_files)
   return self
 end
 
-function Builder:configure_modified_highlighting(highlight_modified)
-  self.highlight_modified = highlight_modified
-  return self
-end
-
 function Builder:configure_icon_padding(padding)
   self.icon_padding = padding or " "
   return self
@@ -294,18 +289,6 @@ function Builder:_get_highlight_override(node, unloaded_bufnr)
       icon_hl = "NvimTreeOpenedFileIcon"
     end
   end
-
-  -- modified file
-  local modified_highlight = modified.get_highlight(node)
-  if modified_highlight then
-    if self.highlight_modified == "all" or self.highlight_modified == "name" then
-      name_hl = modified_highlight
-    end
-    if self.highlight_modified == "all" or self.highlight_modified == "icon" then
-      icon_hl = modified_highlight
-    end
-  end
-
   return icon_hl, name_hl
 end
 
@@ -422,6 +405,8 @@ function Builder:_build_line(node, idx, num_children, unloaded_bufnr)
 
   -- extra highighting
   self:_append_highlight(node, git.get_highlight, icon.hl, name.hl)
+  -- TODO opened
+  self:_append_highlight(node, modified.get_highlight, icon.hl, name.hl)
   self:_append_highlight(node, bookmarks.get_highlight, icon.hl, name.hl)
   self:_append_highlight(node, diagnostics.get_highlight, icon.hl, name.hl)
   self:_append_highlight(node, copy_paste.get_highlight, icon.hl, name.hl)

lua/nvim-tree/renderer/components/bookmarks.lua

@@ -3,7 +3,7 @@ local marks = require "nvim-tree.marks"
 local HL_POSITION = require("nvim-tree.enum").HL_POSITION
 
 local M = {
-  ICON = {},
+  icon = nil,
   hl_pos = HL_POSITION.none,
 }
 
@@ -28,8 +28,8 @@ end
 ---@param node table
 ---@return HighlightedString|nil bookmark icon
 function M.get_icon(node)
-  if M.config.renderer.icons.show.bookmarks and marks.get_mark(node) then
-    return M.ICON
+  if M.icon and marks.get_mark(node) then
+    return M.icon
   end
 end
 
@@ -40,12 +40,16 @@ function M.setup(opts)
 
   M.hl_pos = HL_POSITION[opts.renderer.highlight_bookmarks] or HL_POSITION.none
 
-  M.ICON = {
-    str = opts.renderer.icons.glyphs.bookmark,
-    hl = { "NvimTreeBookmark" },
-  }
-
-  vim.fn.sign_define(M.ICON.hl[1], { text = M.ICON.str, texthl = M.ICON.hl[1] })
+  if opts.renderer.icons.show.bookmarks then
+    M.icon = {
+      str = opts.renderer.icons.glyphs.bookmark,
+      hl = { "NvimTreeBookmark" },
+    }
+    vim.fn.sign_define(M.icon.hl[1], {
+      text = M.icon.str,
+      texthl = M.icon.hl[1],
+    })
+  end
 end
 
 return M

lua/nvim-tree/renderer/components/modified.lua

@@ -1,40 +1,53 @@
 local modified = require "nvim-tree.modified"
 
-local M = {}
+local HL_POSITION = require("nvim-tree.enum").HL_POSITION
 
-local HIGHLIGHT = "NvimTreeModifiedFile"
+local M = {
+  icon = nil,
+  hl_pos = HL_POSITION.none,
+}
 
----return modified icon if node is modified, otherwise return empty string
+---modified icon if modified
 ---@param node table
 ---@return HighlightedString|nil modified icon
 function M.get_icon(node)
-  if not modified.is_modified(node) or not M.show_icon then
-    return nil
+  if M.icon and modified.is_modified(node) then
+    return M.icon
   end
-
-  return { str = M.icon, hl = { HIGHLIGHT } }
-end
-
-function M.setup_signs()
-  vim.fn.sign_define(HIGHLIGHT, { text = M.icon, texthl = HIGHLIGHT })
 end
 
+---Diagnostics highlight group and position when highlight_diagnostics.
 ---@param node table
----@return string|nil
+---@return HL_POSITION position none when no status
+---@return string|nil group only when status
 function M.get_highlight(node)
-  if not modified.is_modified(node) then
-    return nil
+  if M.hl_pos == HL_POSITION.none or not modified.is_modified(node) then
+    return HL_POSITION.none, nil
   end
 
-  return HIGHLIGHT
+  if node.nodes then
+    return M.hl_pos, "NvimTreeModifiedFolderHL"
+  else
+    return M.hl_pos, "NvimTreeModifiedFileHL"
+  end
 end
 
 function M.setup(opts)
-  M.icon = opts.renderer.icons.glyphs.modified
-  M.show_icon = opts.renderer.icons.show.modified
+  if not opts.modified.enable then
+    return
+  end
 
-  if opts.renderer.icons.modified_placement == "signcolumn" then
-    M.setup_signs()
+  M.hl_pos = HL_POSITION[opts.renderer.highlight_modified] or HL_POSITION.none
+
+  if opts.renderer.icons.show.modified then
+    M.icon = {
+      str = opts.renderer.icons.glyphs.modified,
+      hl = { "NvimTreeModifiedIcon" },
+    }
+    vim.fn.sign_define(M.icon.hl[1], {
+      text = M.icon.str,
+      texthl = M.icon.hl[1],
+    })
   end
 end
 

lua/nvim-tree/renderer/init.lua

@@ -72,7 +72,6 @@ function M.draw(unloaded_bufnr)
     :configure_special_files(M.config.special_files)
     :configure_picture_map(picture_map)
     :configure_opened_file_highlighting(M.config.highlight_opened_files)
-    :configure_modified_highlighting(M.config.highlight_modified)
     :configure_icon_padding(M.config.icons.padding)
     :configure_git_icons_placement(M.config.icons.git_placement)
     :configure_diagnostics_icon_placement(M.config.icons.diagnostics_placement)