add DecoratorCopied DecoratorCut

Author: alex-courtis

doc/nvim-tree-lua.txt

@@ -788,7 +788,7 @@ Use nvim-tree in a floating window.
  5.3 OPTS: RENDERER                                  *nvim-tree-opts-renderer*
 
 Highlight precedence:
-  clipboard > diagnostics > bookmarked > modified > opened > git
+  cut > copied > diagnostics > bookmarked > modified > opened > git
 
 *nvim-tree.renderer.add_trailing*
 Appends a trailing slash to folder names.

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

@@ -7,8 +7,6 @@ local notify = require "nvim-tree.notify"
 local renderer = require "nvim-tree.renderer"
 local reloaders = require "nvim-tree.actions.reloaders.reloaders"
 
-local HL_POSITION = require("nvim-tree.enum").HL_POSITION
-
 local find_file = require("nvim-tree.actions.finders.find-file").fn
 
 local M = {
@@ -317,34 +315,23 @@ function M.copy_absolute_path(node)
   copy_to_clipboard(content)
 end
 
---- Clipboard text highlight group and position when highlight_clipboard.
+---Node is cut. May also be copied.
 ---@param node Node
----@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.hl_pos == HL_POSITION.none then
-    return HL_POSITION.none, nil
-  end
-
-  for _, n in ipairs(clipboard.cut) do
-    if node == n then
-      return M.hl_pos, "NvimTreeCutHL"
-    end
-  end
-
-  for _, n in ipairs(clipboard.copy) do
-    if node == n then
-      return M.hl_pos, "NvimTreeCopiedHL"
-    end
-  end
+---@return boolean
+function M.is_cut(node)
+  return vim.tbl_contains(clipboard.cut, node)
+end
 
-  return HL_POSITION.none, nil
+---Node is copied. May also be cut.
+---@param node Node
+---@return boolean
+function M.is_copied(node)
+  return vim.tbl_contains(clipboard.copy, node)
 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] or HL_POSITION.none
 end
 
 return M

lua/nvim-tree/renderer/builder.lua

@@ -373,8 +373,6 @@ function Builder:_format_line(indent_markers, arrows, icon, name, git_icons, dia
 end
 
 function Builder:_build_line(node, idx, num_children, unloaded_bufnr)
-  local copy_paste = require "nvim-tree.actions.fs.copy-paste"
-
   -- various components
   local indent_markers = pad.get_indent_markers(self.depth, idx, num_children, node, self.markers)
   local arrows = pad.get_arrows(node)
@@ -411,7 +409,8 @@ function Builder:_build_line(node, idx, num_children, unloaded_bufnr)
   self:_append_dec_highlight(node, self.decorators.modified, icon.hl, name.hl)
   self:_append_dec_highlight(node, self.decorators.bookmarks, icon.hl, name.hl)
   self:_append_dec_highlight(node, self.decorators.diagnostics, icon.hl, name.hl)
-  self:_append_highlight(node, copy_paste.get_highlight, icon.hl, name.hl)
+  self:_append_dec_highlight(node, self.decorators.copied, icon.hl, name.hl)
+  self:_append_dec_highlight(node, self.decorators.cut, icon.hl, name.hl)
 
   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))

lua/nvim-tree/renderer/decorator/copied.lua

@@ -0,0 +1,35 @@
+local copy_paste
+
+local HL_POSITION = require("nvim-tree.enum").HL_POSITION
+local ICON_PLACEMENT = require("nvim-tree.enum").ICON_PLACEMENT
+
+local Decorator = require "nvim-tree.renderer.decorator"
+
+--- @class DecoratorCopied: Decorator
+--- @field enabled boolean
+--- @field icon HighlightedString|nil
+local DecoratorCopied = Decorator:new()
+
+--- @param opts table
+--- @return DecoratorCopied
+function DecoratorCopied:new(opts)
+  local o = Decorator.new(self, {
+    hl_pos = HL_POSITION[opts.renderer.highlight_clipboard] or HL_POSITION.none,
+    icon_placement = ICON_PLACEMENT.none,
+  })
+  ---@cast o DecoratorCopied
+
+  -- cyclic
+  copy_paste = copy_paste or require "nvim-tree.actions.fs.copy-paste"
+
+  return o
+end
+
+--- Cut highlight: renderer.highlight_clipboard and node is copied
+function DecoratorCopied:get_highlight(node)
+  if self.hl_pos ~= HL_POSITION.none and copy_paste.is_copied(node) then
+    return "NvimTreeCopiedHL"
+  end
+end
+
+return DecoratorCopied

lua/nvim-tree/renderer/decorator/cut.lua

@@ -0,0 +1,35 @@
+local copy_paste
+
+local HL_POSITION = require("nvim-tree.enum").HL_POSITION
+local ICON_PLACEMENT = require("nvim-tree.enum").ICON_PLACEMENT
+
+local Decorator = require "nvim-tree.renderer.decorator"
+
+--- @class DecoratorCut: Decorator
+--- @field enabled boolean
+--- @field icon HighlightedString|nil
+local DecoratorCut = Decorator:new()
+
+--- @param opts table
+--- @return DecoratorCut
+function DecoratorCut:new(opts)
+  local o = Decorator.new(self, {
+    hl_pos = HL_POSITION[opts.renderer.highlight_clipboard] or HL_POSITION.none,
+    icon_placement = ICON_PLACEMENT.none,
+  })
+  ---@cast o DecoratorCut
+
+  -- cyclic
+  copy_paste = copy_paste or require "nvim-tree.actions.fs.copy-paste"
+
+  return o
+end
+
+--- Cut highlight: renderer.highlight_clipboard and node is cut
+function DecoratorCut:get_highlight(node)
+  if self.hl_pos ~= HL_POSITION.none and copy_paste.is_cut(node) then
+    return "NvimTreeCutHL"
+  end
+end
+
+return DecoratorCut

lua/nvim-tree/renderer/init.lua

@@ -10,6 +10,8 @@ local Builder = require "nvim-tree.renderer.builder"
 local live_filter = require "nvim-tree.live-filter"
 
 local DecoratorBookmarks = require "nvim-tree.renderer.decorator.bookmarks"
+local DecoratorCopied = require "nvim-tree.renderer.decorator.copied"
+local DecoratorCut = require "nvim-tree.renderer.decorator.cut"
 local DecoratorDiagnostics = require "nvim-tree.renderer.decorator.diagnostics"
 local DecoratorGit = require "nvim-tree.renderer.decorator.git"
 local DecoratorModified = require "nvim-tree.renderer.decorator.modified"
@@ -106,9 +108,11 @@ function M.setup(opts)
 
   -- TODO change to array: precedence should follow order
   M.decorators = {
-    git = DecoratorGit:new(opts),
     bookmarks = DecoratorBookmarks:new(opts),
+    copied = DecoratorCopied:new(opts),
+    cut = DecoratorCut:new(opts),
     diagnostics = DecoratorDiagnostics:new(opts),
+    git = DecoratorGit:new(opts),
     modified = DecoratorModified:new(opts),
   }
 end