feat(#2411): bookmark highlight and icon placement

Author: alex-courtis

doc/nvim-tree-lua.txt

@@ -388,7 +388,7 @@ Following is the default configuration. See |nvim-tree-opts| for details.
         highlight_diagnostics = false,
         highlight_opened_files = "none",
         highlight_modified = "none",
-        highlight_bookmarks = false,
+        highlight_bookmarks = "none",
         highlight_clipboard = "name",
         indent_markers = {
           enable = false,
@@ -780,7 +780,8 @@ Use nvim-tree in a floating window.
 ==============================================================================
  5.3 OPTS: RENDERER                                  *nvim-tree-opts-renderer*
 
-Highlight precedence: git < opened < modified < diagnostics
+Highlight precedence:
+  clipboard > diagnostics > bookmarked > modified > opened > git
 
 *nvim-tree.renderer.add_trailing*
 Appends a trailing slash to folder names.
@@ -844,8 +845,9 @@ Value can be `"none"`, `"icon"`, `"name"` or `"all"`
   Type: `string`, Default `"none"`
 
 *nvim-tree.renderer.highlight_bookmarks*
-Highlight bookmarked using the `NvimTreeBookmarkText` highlight group.
-  Type: `boolean`, Default `false`
+Highlight bookmarked using the `NvimTreeBookmarkHL` group.
+Value can be `"none"`, `"icon"`, `"name"` or `"all"`
+  Type: `string`, Default `"none"`
 
 *nvim-tree.renderer.highlight_clipboard*
 Enable highlight for clipboard items using the `NvimTreeCutHL` and
@@ -879,7 +881,11 @@ Configuration options for tree indent markers.
 *nvim-tree.renderer.icons*
 Configuration options for icons.
 
-Sign column icon precedence: bookmarked < git < modified < diagnostics
+Icon sign column precedence:
+  diagnostics > modified > git > bookmarked
+
+Left to right order:
+  git, modified, diagnostics, bookmarked
 
     *nvim-tree.renderer.icons.web_devicons*
     Configure optional plugin `"nvim-tree/nvim-web-devicons"`
@@ -2198,8 +2204,8 @@ Clipboard: >
 Bookmark Icon: >
     NvimTreeBookmark
 <
-Bookmark Text: >
-    NvimTreeBookmarkText        NvimTreeBookmark
+Bookmark Highlight: >
+    NvimTreeBookmarkHL          SpellLocal
 <
 Picker: >
     NvimTreeWindowPicker

lua/nvim-tree.lua

@@ -417,7 +417,7 @@ local DEFAULT_OPTS = { -- BEGIN_DEFAULT_OPTS
     highlight_diagnostics = false,
     highlight_opened_files = "none",
     highlight_modified = "none",
-    highlight_bookmarks = false,
+    highlight_bookmarks = "none",
     highlight_clipboard = "name",
     indent_markers = {
       enable = false,
@@ -645,6 +645,8 @@ local ACCEPTED_STRINGS = {
   renderer = {
     highlight_opened_files = { "none", "icon", "name", "all" },
     highlight_modified = { "none", "icon", "name", "all" },
+    highlight_bookmarks = { "none", "icon", "name", "all" },
+    highlight_clipboard = { "none", "icon", "name", "all" },
     icons = {
       git_placement = { "before", "after", "signcolumn" },
       modified_placement = { "before", "after", "signcolumn" },

lua/nvim-tree/actions/fs/copy-paste.lua

@@ -300,7 +300,7 @@ end
 function M.setup(opts)
   M.config.filesystem_watchers = opts.filesystem_watchers
   M.config.actions = opts.actions
-  M.hl_pos = HL_POSITION[opts.renderer.highlight_clipboard]
+  M.hl_pos = HL_POSITION[opts.renderer.highlight_clipboard] or HL_POSITION.none
 end
 
 return M

lua/nvim-tree/colors.lua

@@ -112,6 +112,7 @@ local function get_links()
     SignColumn = "NvimTreeNormal",
     CutHL = "SpellBad",
     CopiedHL = "SpellRare",
+    BookmarkHL = "SpellLocal",
   }
 end
 

lua/nvim-tree/renderer/builder.lua

@@ -84,7 +84,7 @@ function Builder:configure_diagnostics_icon_placement(where)
   return self
 end
 
-function Builder:configure_bookmarks_icon_placement(where)
+function Builder:configure_bookmark_icon_placement(where)
   if where ~= "after" and where ~= "before" and where ~= "signcolumn" then
     where = "before" -- default before
   end
@@ -256,21 +256,19 @@ end
 
 ---@param node table
 ---@return HighlightedString[]|nil icon
-function Builder:_get_bookmarks_icon(node)
-  local bookmarks_icon = bookmarks.get_icon(node)
-  if bookmarks_icon and self.bookmarks_placement == "signcolumn" then
-    table.insert(self.signs, { sign = bookmarks_icon.hl[1], lnum = self.index + 1, priority = 4 })
-    bookmarks_icon = nil
+function Builder:_get_bookmark_icon(node)
+  local bookmark_icon = bookmarks.get_icon(node)
+  if bookmark_icon and self.bookmarks_placement == "signcolumn" then
+    table.insert(self.signs, { sign = bookmark_icon.hl[1], lnum = self.index + 1, priority = 4 })
+    bookmark_icon = nil
   end
-  return bookmarks_icon
+  return bookmark_icon
 end
 
 ---@param node table
 ---@return string|nil icon_hl
 ---@return string|nil name_hl
 function Builder:_get_highlight_override(node, unloaded_bufnr)
-  -- highlights precedence:
-  -- original < git < opened_file < modified
   local name_hl, icon_hl
 
   -- git
@@ -331,7 +329,7 @@ end
 ---@param git_icons HighlightedString[]|nil
 ---@param diagnostics_icon HighlightedString|nil
 ---@param modified_icon HighlightedString|nil
----@param bookmarks_icon HighlightedString|nil
+---@param bookmark_icon HighlightedString|nil
 ---@return HighlightedString[]
 function Builder:_format_line(
   indent_markers,
@@ -341,7 +339,7 @@ function Builder:_format_line(
   git_icons,
   diagnostics_icon,
   modified_icon,
-  bookmarks_icon
+  bookmark_icon
 )
   local added_len = 0
   local function add_to_end(t1, t2)
@@ -371,8 +369,8 @@ function Builder:_format_line(
   if diagnostics_icon and self.diagnostics_placement == "before" then
     add_to_end(line, { diagnostics_icon })
   end
-  if bookmarks_icon and self.bookmarks_placement == "before" then
-    add_to_end(line, { bookmarks_icon })
+  if bookmark_icon and self.bookmarks_placement == "before" then
+    add_to_end(line, { bookmark_icon })
   end
 
   add_to_end(line, { name })
@@ -386,8 +384,8 @@ function Builder:_format_line(
   if diagnostics_icon and self.diagnostics_placement == "after" then
     add_to_end(line, { diagnostics_icon })
   end
-  if bookmarks_icon and self.bookmarks_placement == "after" then
-    add_to_end(line, { bookmarks_icon })
+  if bookmark_icon and self.bookmarks_placement == "after" then
+    add_to_end(line, { bookmark_icon })
   end
 
   return line
@@ -400,8 +398,8 @@ function Builder:_build_line(node, idx, num_children, unloaded_bufnr)
   local indent_markers = pad.get_indent_markers(self.depth, idx, num_children, node, self.markers)
   local arrows = pad.get_arrows(node)
 
-  -- sign column precedence: bookmarks < git < modified < diagnostics
-  local bookmarks_icon = self:_get_bookmarks_icon(node)
+  -- adds icons to signcolumn
+  local bookmark_icon = self:_get_bookmark_icon(node)
   local git_icons = self:_get_git_icons(node)
   local modified_icon = self:_get_modified_icon(node)
   local diagnostics_icon = self:_get_diagnostics_icon(node)
@@ -428,10 +426,11 @@ function Builder:_build_line(node, idx, num_children, unloaded_bufnr)
   end
 
   -- extra highighting
+  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)
 
-  local line = self:_format_line(indent_markers, arrows, icon, name, git_icons, diagnostics_icon, modified_icon)
+  local line = self:_format_line(indent_markers, arrows, icon, name, git_icons, diagnostics_icon, modified_icon, bookmark_icon)
   self:_insert_line(self:_unwrap_highlighted_strings(line))
 
   self.index = self.index + 1

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

@@ -1,15 +1,26 @@
 local marks = require "nvim-tree.marks"
 
-local M = {}
+local HL_POSITION = require("nvim-tree.enum").HL_POSITION
 
-local ICON = {}
+local M = {
+  ICON = {},
+  hl_pos = HL_POSITION.none,
+}
 
----bookmark text highlight group if marked
+---Bookmark highlight group and position when highlight_bookmark.
 ---@param node table
----@return string|nil group
+---@return HL_POSITION position none when clipboard empty
+---@return string|nil group only when node present in clipboard
 function M.get_highlight(node)
-  if M.config.renderer.highlight_bookmarks and marks.get_mark(node) then
-    return "NvimTreeBookmarkText"
+  if M.hl_pos == HL_POSITION.none then
+    return HL_POSITION.none, nil
+  end
+
+  local mark = marks.get_mark(node)
+  if mark then
+    return M.hl_pos, "NvimTreeBookmarkHL"
+  else
+    return HL_POSITION.none, nil
   end
 end
 
@@ -18,7 +29,7 @@ end
 ---@return HighlightedString|nil bookmark icon
 function M.get_icon(node)
   if M.config.renderer.icons.show.bookmarks and marks.get_mark(node) then
-    return ICON
+    return M.ICON
   end
 end
 
@@ -27,12 +38,14 @@ function M.setup(opts)
     renderer = opts.renderer,
   }
 
-  ICON = {
+  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(ICON.hl[1], { text = ICON.str, texthl = ICON.hl[1] })
+  vim.fn.sign_define(M.ICON.hl[1], { text = M.ICON.str, texthl = M.ICON.hl[1] })
 end
 
 return M

lua/nvim-tree/renderer/init.lua

@@ -74,7 +74,7 @@ function M.draw(unloaded_bufnr)
     :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)
-    :configure_bookmarks_icon_placement(M.config.icons.bookmarks_placement)
+    :configure_bookmark_icon_placement(M.config.icons.bookmarks_placement)
     :configure_modified_placement(M.config.icons.modified_placement)
     :configure_symlink_destination(M.config.symlink_destination)
     :configure_filter(live_filter.filter, live_filter.prefix)