refactor(clipboard): simplify copying node attribute and allow all to work in visual mode

Author: Uanela

lua/nvim-tree/actions/fs/clipboard.lua

@@ -462,36 +462,59 @@ function Clipboard:copy_to_reg(content, msg)
 end
 
 ---@param node Node
-function Clipboard:copy_filename(node)
+---@return string
+function Clipboard:get_node_filename(node)
   if node.name == ".." then
     -- root
-    self:copy_to_reg(vim.fn.fnamemodify(self.explorer.absolute_path, ":t"))
+    return vim.fn.fnamemodify(self.explorer.absolute_path, ":t")
   else
     -- node
-    self:copy_to_reg(node.name)
+    return node.name
   end
 end
 
 ---@param node_or_nodes Node|Node[]
-function Clipboard:copy_basename(node_or_nodes)
+---@param attribute "absolute_path" | "basename" | "filename" | "relative_path"
+function Clipboard:copy_node_attribute(node_or_nodes, attribute)
   local content
-  if self:is_nodes_array(node_or_nodes) == false or #node_or_nodes == 1 then
+  local node_attribute_getters = {
+    basename = function(n) return self:get_node_basename(n) end,
+    filename = function(n) return self:get_node_filename(n) end,
+    relative_path = function(n) return self:get_node_relative_path(n) end,
+    absolute_path = function(n) return self:get_node_absolute_path(n) end,
+  }
+
+  local attribute_getter = node_attribute_getters[attribute]
+
+  local is_single = self:is_nodes_array(node_or_nodes) == false
+  if is_single then
     local node = #node_or_nodes == 1 and node_or_nodes[0] or node_or_nodes
-    content = self:get_basename(node)
+    content = attribute_getter(node)
   else
+    node_or_nodes = utils.filter_descendant_nodes(node_or_nodes)
     content = {}
     for _, node in ipairs(node_or_nodes) do
-      table.insert(content, self:get_basename(node))
+      table.insert(content, attribute_getter(node))
+    end
+  end
+
+
+  if content ~= nil then
+    local message = nil
+
+    if not is_single then
+      message = string.format("%s %s copied to register", #content, attribute:gsub("_", " ") .. "s")
     end
+    self:copy_to_reg(content, message)
   end
-  self:copy_to_reg(content)
 end
 
 ---@param node Node
-function Clipboard:copy_path(node)
+---@return string|nil
+function Clipboard:get_node_relative_path(node)
   if node.name == ".." then
     -- root
-    self:copy_to_reg(utils.path_add_trailing(""))
+    return utils.path_add_trailing("")
   else
     -- node
     local absolute_path = node.absolute_path
@@ -502,17 +525,17 @@ function Clipboard:copy_path(node)
 
     local relative_path = utils.path_relative(absolute_path, cwd)
     if node:is(DirectoryNode) then
-      self:copy_to_reg(utils.path_add_trailing(relative_path))
+      return utils.path_add_trailing(relative_path)
     else
-      self:copy_to_reg(relative_path)
+      return relative_path
     end
   end
 end
 
 ---@private
 ---@param node Node
 ---@return string
-function Clipboard:get_absolute_path(node)
+function Clipboard:get_node_absolute_path(node)
   if node.name == ".." then
     node = self.explorer
   end
@@ -521,22 +544,16 @@ function Clipboard:get_absolute_path(node)
   return node.nodes ~= nil and utils.path_add_trailing(absolute_path) or absolute_path
 end
 
----@param node_or_nodes Node|Node[]
-function Clipboard:copy_absolute_path(node_or_nodes)
-  local content
-  local is_single = self:is_nodes_array(node_or_nodes) == false or #node_or_nodes == 1
-  if is_single then
-    local node = #node_or_nodes == 1 and node_or_nodes[0] or node_or_nodes
-    content = self:get_absolute_path(node)
+---@param node Node
+---@return string
+function Clipboard:get_node_basename(node)
+  if node.name == ".." then
+    -- root
+    return vim.fn.fnamemodify(node.explorer.absolute_path, ":t:r")
   else
-    node_or_nodes = utils.filter_descendant_nodes(node_or_nodes)
-    content = {}
-    for _, node in ipairs(node_or_nodes) do
-      table.insert(content, self:get_absolute_path(node))
-    end
+    -- node
+    return vim.fn.fnamemodify(node.name, ":r")
   end
-
-  self:copy_to_reg(content, string.format("%s paths copied to register", is_single and 1 or #content))
 end
 
 ---Node is cut. Will not be copied.
@@ -553,16 +570,4 @@ function Clipboard:is_copied(node)
   return vim.tbl_contains(self.data.copy, node)
 end
 
----@param node Node
----@return string
-function Clipboard:get_basename(node)
-  if node.name == ".." then
-    -- root
-    return vim.fn.fnamemodify(node.explorer.absolute_path, ":t:r")
-  else
-    -- node
-    return vim.fn.fnamemodify(node.name, ":r")
-  end
-end
-
 return Clipboard

lua/nvim-tree/api/impl.lua

@@ -155,11 +155,11 @@ function M.hydrate_post_setup(api)
   api.filter.toggle                            = e_(function(e) e.filters:toggle() end)
 
   api.fs.clear_clipboard                       = e_(function(e) e.clipboard:clear_clipboard() end)
-  api.fs.copy.absolute_path                    = ev(function(e, n) e.clipboard:copy_absolute_path(n) end)
-  api.fs.copy.basename                         = ev(function(e, n) e.clipboard:copy_basename(n) end)
-  api.fs.copy.filename                         = en(function(e, n) e.clipboard:copy_filename(n) end)
+  api.fs.copy.absolute_path                    = ev(function(e, n) e.clipboard:copy_node_attribute(n, "absolute_path") end)
+  api.fs.copy.basename                         = ev(function(e, n) e.clipboard:copy_node_attribute(n, "basename") end)
+  api.fs.copy.filename                         = ev(function(e, n) e.clipboard:copy_node_attribute(n, "filename") end)
+  api.fs.copy.relative_path                    = ev(function(e, n) e.clipboard:copy_node_attribute(n, "relative_path") end)
   api.fs.copy.node                             = ev(function(e, n) e.clipboard:copy(n) end)
-  api.fs.copy.relative_path                    = en(function(e, n) e.clipboard:copy_path(n) end)
   api.fs.create                                = _n(function(n) require("nvim-tree.actions.fs.create-file").fn(n) end)
   api.fs.cut                                   = ev(function(e, n) e.clipboard:cut(n) end)
   api.fs.paste                                 = en(function(e, n) e.clipboard:paste(n) end)

lua/nvim-tree/keymap.lua

@@ -114,8 +114,8 @@ function M.on_attach_default(bufnr)
   vim.keymap.set("n",          "U",              api.filter.custom.toggle,           opts("Toggle Filter: Custom"))
   vim.keymap.set("n",          "W",              api.tree.collapse_all,              opts("Collapse All"))
   vim.keymap.set({ "n", "x" }, "x",              api.fs.cut,                         opts("Cut"))
-  vim.keymap.set("n",          "y",              api.fs.copy.filename,               opts("Copy Name"))
-  vim.keymap.set("n",          "Y",              api.fs.copy.relative_path,          opts("Copy Relative Path"))
+  vim.keymap.set({ "n", "x" }, "y",              api.fs.copy.filename,               opts("Copy Name"))
+  vim.keymap.set({ "n", "x" }, "Y",              api.fs.copy.relative_path,          opts("Copy Relative Path"))
   vim.keymap.set("n",          "<2-LeftMouse>",  api.node.open.edit,                 opts("Open"))
   vim.keymap.set("n",          "<2-RightMouse>", api.tree.change_root_to_node,       opts("CD"))
   -- END_ON_ATTACH_DEFAULT