feat(#1079): add highlight NvimTreeCopiedText and NvimTreeCutText

Author: alex-courtis

doc/nvim-tree-lua.txt

@@ -2166,6 +2166,10 @@ Standard: >
     NvimTreeStatusLine          StatusLine
     NvimTreeStatusLineNC        StatusLineNC
 <
+Clipboard: >
+    NvimTreeCopiedText
+    NvimTreeCutText
+<
 Picker: >
     NvimTreeWindowPicker
 <

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

@@ -4,6 +4,7 @@ local utils = require "nvim-tree.utils"
 local core = require "nvim-tree.core"
 local events = require "nvim-tree.events"
 local notify = require "nvim-tree.notify"
+local renderer = require "nvim-tree.renderer"
 
 local find_file = require("nvim-tree.actions.finders.find-file").fn
 
@@ -150,14 +151,17 @@ function M.clear_clipboard()
   clipboard.move = {}
   clipboard.copy = {}
   notify.info "Clipboard has been emptied."
+  renderer.draw()
 end
 
 function M.copy(node)
   add_to_clipboard(node, clipboard.copy)
+  renderer.draw()
 end
 
 function M.cut(node)
   add_to_clipboard(node, clipboard.move)
+  renderer.draw()
 end
 
 local function do_paste(node, action_type, action_fn)
@@ -267,6 +271,23 @@ function M.copy_absolute_path(node)
   return copy_to_clipboard(content)
 end
 
+---clipboard text highlight group
+---@param node table
+---@return string|nil group
+function M.get_highlight(node)
+  for _, n in ipairs(clipboard.move) do
+    if node == n then
+      return "NvimTreeCutText"
+    end
+  end
+
+  for _, n in ipairs(clipboard.copy) do
+    if node == n then
+      return "NvimTreeCopiedText"
+    end
+  end
+end
+
 function M.setup(opts)
   M.config.filesystem_watchers = opts.filesystem_watchers
   M.config.actions = opts.actions

lua/nvim-tree/colors.lua

@@ -42,6 +42,9 @@ local function get_hl_groups()
     OpenedFile = { gui = "bold", fg = colors.green },
     ModifiedFile = { fg = colors.green },
 
+    CopiedText = { gui = "underline" },
+    CutText = { gui = "strikethrough" },
+
     GitDirty = { fg = colors.dark_red },
     GitDeleted = { fg = colors.dark_red },
     GitStaged = { fg = colors.green },

lua/nvim-tree/renderer/builder.lua

@@ -114,7 +114,7 @@ end
 
 ---@class HighlightedString
 ---@field str string
----@field hl string|nil
+---@field hl string[]
 
 ---@param highlighted_strings HighlightedString[]
 ---@return string
@@ -126,7 +126,7 @@ function Builder:_unwrap_highlighted_strings(highlighted_strings)
   local string = ""
   for _, v in ipairs(highlighted_strings) do
     if #v.str > 0 then
-      if v.hl then
+      if v.hl and type(v.hl) == "table" then
         self:_insert_highlight(v.hl, #string, #string + #v.str)
       end
       string = string .. v.str
@@ -136,7 +136,8 @@ function Builder:_unwrap_highlighted_strings(highlighted_strings)
 end
 
 ---@param node table
----@return HighlightedString icon, HighlightedString name
+---@return HighlightedString icon
+---@return HighlightedString name
 function Builder:_build_folder(node)
   local has_children = #node.nodes ~= 0 or node.has_children
   local icon, icon_hl = icons.get_folder_icon(node, has_children)
@@ -166,11 +167,12 @@ function Builder:_build_folder(node)
     foldername_hl = "NvimTreeEmptyFolderName"
   end
 
-  return { str = icon, hl = icon_hl }, { str = foldername, hl = foldername_hl }
+  return { str = icon, hl = { icon_hl } }, { str = foldername, hl = { foldername_hl } }
 end
 
 ---@param node table
----@return HighlightedString icon, HighlightedString name
+---@return HighlightedString icon
+---@return HighlightedString name
 function Builder:_build_symlink(node)
   local icon = icons.i.symlink
   local arrow = icons.i.symlink_arrow
@@ -180,21 +182,19 @@ function Builder:_build_symlink(node)
     symlink_formatted = symlink_formatted .. arrow .. link_to
   end
 
-  local link_highlight = "NvimTreeSymlink"
-  local icon_hl = "NvimTreeSymlinkIcon"
-
-  return { str = icon, hl = icon_hl }, { str = symlink_formatted, hl = link_highlight }
+  return { str = icon, hl = { "NvimTreeSymlinkIcon" } }, { str = symlink_formatted, hl = { "NvimTreeSymlink" } }
 end
 
 ---@param node table
 ---@return HighlightedString icon
 function Builder:_build_file_icon(node)
   local icon, hl_group = icons.get_file_icon(node.name, node.extension)
-  return { str = icon, hl = hl_group }
+  return { str = icon, hl = { hl_group } }
 end
 
 ---@param node table
----@return HighlightedString icon, HighlightedString name
+---@return HighlightedString icon
+---@return HighlightedString name
 function Builder:_build_file(node)
   local icon = self:_build_file_icon(node)
 
@@ -207,15 +207,15 @@ function Builder:_build_file(node)
     hl = "NvimTreeImageFile"
   end
 
-  return icon, { str = node.name, hl = hl }
+  return icon, { str = node.name, hl = { hl } }
 end
 
 ---@param node table
 ---@return HighlightedString[]|nil icon
 function Builder:_get_git_icons(node)
   local git_icons = git.get_icons(node)
   if git_icons and #git_icons > 0 and self.git_placement == "signcolumn" then
-    table.insert(self.signs, { sign = git_icons[1].hl, lnum = self.index + 1, priority = 1 })
+    table.insert(self.signs, { sign = git_icons[1].hl[1], lnum = self.index + 1, priority = 1 })
     git_icons = nil
   end
   return git_icons
@@ -226,7 +226,7 @@ end
 function Builder:_get_diagnostics_icon(node)
   local diagnostics_icon = diagnostics.get_icon(node)
   if diagnostics_icon and self.diagnostics_placement == "signcolumn" then
-    table.insert(self.signs, { sign = diagnostics_icon.hl, lnum = self.index + 1, priority = 2 })
+    table.insert(self.signs, { sign = diagnostics_icon.hl[1], lnum = self.index + 1, priority = 2 })
     diagnostics_icon = nil
   end
   return diagnostics_icon
@@ -237,14 +237,15 @@ end
 function Builder:_get_modified_icon(node)
   local modified_icon = modified.get_icon(node)
   if modified_icon and self.modified_placement == "signcolumn" then
-    table.insert(self.signs, { sign = modified_icon.hl, lnum = self.index + 1, priority = 3 })
+    table.insert(self.signs, { sign = modified_icon.hl[1], lnum = self.index + 1, priority = 3 })
     modified_icon = nil
   end
   return modified_icon
 end
 
 ---@param node table
----@return string icon_highlight, string name_highlight
+---@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
@@ -290,6 +291,20 @@ function Builder:_get_highlight_override(node, unloaded_bufnr)
   return icon_hl, name_hl
 end
 
+---@param node table
+---@return string[] icon_hl
+---@return string[] name_hl
+function Builder:_get_highlight_extra(node)
+  local icon_hl = {}
+  local name_hl = {}
+
+  -- clipboard
+  local clipboard_highlight = require "nvim-tree.actions.fs.copy-paste".get_highlight(node)
+  table.insert(name_hl, clipboard_highlight)
+
+  return icon_hl, name_hl
+end
+
 ---@param indent_markers HighlightedString[]
 ---@param arrows HighlightedString[]|nil
 ---@param icon HighlightedString
@@ -364,12 +379,21 @@ function Builder:_build_line(node, idx, num_children, unloaded_bufnr)
   end
 
   -- highlight override
-  local icon_hl, name_hl = self:_get_highlight_override(node, unloaded_bufnr)
-  if icon_hl then
-    icon.hl = icon_hl
+  local icon_hl_override, name_hl_override = self:_get_highlight_override(node, unloaded_bufnr)
+  if icon_hl_override then
+    icon.hl = { icon_hl_override }
+  end
+  if name_hl_override then
+    name.hl = { name_hl_override }
+  end
+
+  -- extra highighting
+  local icon_hl_extra, name_hl_extra = self:_get_highlight_extra(node)
+  for _, hl in ipairs(icon_hl_extra) do
+    table.insert(icon.hl, hl)
   end
-  if name_hl then
-    name.hl = name_hl
+  for _, hl in ipairs(name_hl_extra) do
+    table.insert(name.hl, hl)
   end
 
   local line = self:_format_line(indent_markers, arrows, icon, name, git_icons, diagnostics_icon, modified_icon)
@@ -429,16 +453,16 @@ function Builder:build_header(show_header)
   if show_header then
     local root_name = format_root_name(self.root_cwd, self.root_folder_label)
     self:_insert_line(root_name)
-    self:_insert_highlight("NvimTreeRootFolder", 0, string.len(root_name))
+    self:_insert_highlight({ "NvimTreeRootFolder" }, 0, string.len(root_name))
     self.index = 1
   end
 
   if self.filter then
     local filter_line = self.filter_prefix .. "/" .. self.filter .. "/"
     self:_insert_line(filter_line)
     local prefix_length = string.len(self.filter_prefix)
-    self:_insert_highlight("NvimTreeLiveFilterPrefix", 0, prefix_length)
-    self:_insert_highlight("NvimTreeLiveFilterValue", prefix_length, string.len(filter_line))
+    self:_insert_highlight({ "NvimTreeLiveFilterPrefix" }, 0, prefix_length)
+    self:_insert_highlight({ "NvimTreeLiveFilterValue" }, prefix_length, string.len(filter_line))
     self.index = self.index + 1
   end
 

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

@@ -6,7 +6,7 @@ local ICON = {}
 
 ---diagnostics text highlight group if there is a status
 ---@param node table
----@return string|nil highlight
+---@return string|nil group
 function M.get_highlight(node)
   if node and M.config.diagnostics.enable and M.config.renderer.highlight_diagnostics then
     if node.nodes then
@@ -44,24 +44,24 @@ function M.setup(opts)
 
   ICON[vim.diagnostic.severity.ERROR] = {
     str = M.config.diagnostics.icons.error,
-    hl = "NvimTreeLspDiagnosticsError",
+    hl = { "NvimTreeLspDiagnosticsError" },
   }
 
   ICON[vim.diagnostic.severity.WARN] = {
     str = M.config.diagnostics.icons.warning,
-    hl = "NvimTreeLspDiagnosticsWarning",
+    hl = { "NvimTreeLspDiagnosticsWarning" },
   }
   ICON[vim.diagnostic.severity.INFO] = {
     str = M.config.diagnostics.icons.info,
-    hl = "NvimTreeLspDiagnosticsInfo",
+    hl = { "NvimTreeLspDiagnosticsInfo" },
   }
   ICON[vim.diagnostic.severity.HINT] = {
     str = M.config.diagnostics.icons.hint,
-    hl = "NvimTreeLspDiagnosticsHint",
+    hl = { "NvimTreeLspDiagnosticsHint" },
   }
 
   for _, i in ipairs(ICON) do
-    vim.fn.sign_define(i.hl, { text = i.str, texthl = i.hl })
+    vim.fn.sign_define(i.hl[1], { text = i.str, texthl = i.hl[1] })
   end
 end
 

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

@@ -5,13 +5,13 @@ local M = {}
 
 local function build_icons_table(i)
   local icons = {
-    staged = { str = i.staged, hl = "NvimTreeGitStaged", ord = 1 },
-    unstaged = { str = i.unstaged, hl = "NvimTreeGitDirty", ord = 2 },
-    renamed = { str = i.renamed, hl = "NvimTreeGitRenamed", ord = 3 },
-    deleted = { str = i.deleted, hl = "NvimTreeGitDeleted", ord = 4 },
-    unmerged = { str = i.unmerged, hl = "NvimTreeGitMerge", ord = 5 },
-    untracked = { str = i.untracked, hl = "NvimTreeGitNew", ord = 6 },
-    ignored = { str = i.ignored, hl = "NvimTreeGitIgnored", ord = 7 },
+    staged = { str = i.staged, hl = { "NvimTreeGitStaged" }, ord = 1 },
+    unstaged = { str = i.unstaged, hl = { "NvimTreeGitDirty" }, ord = 2 },
+    renamed = { str = i.renamed, hl = { "NvimTreeGitRenamed" }, ord = 3 },
+    deleted = { str = i.deleted, hl = { "NvimTreeGitDeleted" }, ord = 4 },
+    unmerged = { str = i.unmerged, hl = { "NvimTreeGitMerge" }, ord = 5 },
+    untracked = { str = i.untracked, hl = { "NvimTreeGitNew" }, ord = 6 },
+    ignored = { str = i.ignored, hl = { "NvimTreeGitIgnored" }, ord = 7 },
   }
   return {
     ["M "] = { icons.staged },

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

@@ -12,7 +12,7 @@ function M.get_icon(node)
     return nil
   end
 
-  return { str = M.icon, hl = HIGHLIGHT }
+  return { str = M.icon, hl = { HIGHLIGHT } }
 end
 
 function M.setup_signs()

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

@@ -78,7 +78,7 @@ function M.get_indent_markers(depth, idx, nodes_number, node, markers)
     str = str .. string.rep(" ", depth * indent_width)
   end
 
-  return { str = str, hl = "NvimTreeIndentMarker" }
+  return { str = str, hl = { "NvimTreeIndentMarker" } }
 end
 
 ---@param node table
@@ -104,7 +104,7 @@ function M.get_arrows(node)
     str = "  "
   end
 
-  return { str = str, hl = hl }
+  return { str = str, hl = { hl } }
 end
 
 function M.setup(opts)

lua/nvim-tree/renderer/init.lua

@@ -38,7 +38,11 @@ function M.render_hl(bufnr, hl)
   end
   vim.api.nvim_buf_clear_namespace(bufnr, namespace_id, 0, -1)
   for _, data in ipairs(hl or M.last_highlights) do
-    vim.api.nvim_buf_add_highlight(bufnr, namespace_id, data[1], data[2], data[3], data[4])
+    if type(data[1]) == "table" then
+      for _, group in ipairs(data[1]) do
+        vim.api.nvim_buf_add_highlight(bufnr, namespace_id, group, data[2], data[3], data[4])
+      end
+    end
   end
 end