move last_group_node to DirectoryNode

Author: alex-courtis

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

@@ -7,6 +7,8 @@ local notify = require("nvim-tree.notify")
 
 local find_file = require("nvim-tree.actions.finders.find-file").fn
 
+local DirectoryNode = require("nvim-tree.node.directory")
+
 ---@enum ACTION
 local ACTION = {
   copy = "copy",
@@ -219,7 +221,7 @@ end
 function Clipboard:do_paste(node, action, action_fn)
   if node.name == ".." then
     node = self.explorer
-  else
+  elseif node:is(DirectoryNode) then
     node = node:last_group_node()
   end
   local clip = self.data[action]

lua/nvim-tree/actions/fs/create-file.lua

@@ -5,6 +5,8 @@ local notify = require("nvim-tree.notify")
 
 local find_file = require("nvim-tree.actions.finders.find-file").fn
 
+local DirectoryNode = require("nvim-tree.node.directory")
+
 local M = {}
 
 ---@param file string
@@ -53,7 +55,7 @@ function M.fn(node)
       nodes = core.get_explorer().nodes,
       open = true,
     }
-  else
+  elseif node:is(DirectoryNode) then
     node = node:last_group_node()
   end
 

lua/nvim-tree/actions/fs/rename-file.lua

@@ -6,6 +6,8 @@ local notify = require("nvim-tree.notify")
 
 local find_file = require("nvim-tree.actions.finders.find-file").fn
 
+local DirectoryNode = require("nvim-tree.node.directory")
+
 local M = {
   config = {},
 }
@@ -120,7 +122,9 @@ function M.fn(default_modifier)
       return
     end
 
-    node = node:last_group_node()
+    if node:is(DirectoryNode) then
+      node = node:last_group_node()
+    end
     if node.name == ".." then
       return
     end

lua/nvim-tree/actions/moves/parent.lua

@@ -2,6 +2,8 @@ local view = require("nvim-tree.view")
 local utils = require("nvim-tree.utils")
 local core = require("nvim-tree.core")
 
+local DirectoryNode = require("nvim-tree.node.directory")
+
 local M = {}
 
 ---@param should_close boolean|nil
@@ -11,7 +13,9 @@ function M.fn(should_close)
 
   return function(node)
     local explorer = core.get_explorer()
-    node = node:last_group_node()
+    if node:is(DirectoryNode) then
+      node = node:last_group_node()
+    end
     if should_close and node.open then
       node.open = false
       if explorer then

lua/nvim-tree/actions/tree/modifiers/expand-all.lua

@@ -2,6 +2,8 @@ local core = require("nvim-tree.core")
 local Iterator = require("nvim-tree.iterators.node-iterator")
 local notify = require("nvim-tree.notify")
 
+local DirectoryNode = require("nvim-tree.node.directory")
+
 local M = {}
 
 ---@param list string[]
@@ -17,7 +19,9 @@ end
 
 ---@param node Node
 local function expand(node)
-  node = node:last_group_node()
+  if node:is(DirectoryNode) then
+    node = node:last_group_node()
+  end
   node.open = true
   if #node.nodes == 0 then
     core.get_explorer():expand(node)

lua/nvim-tree/node/directory.lua

@@ -5,7 +5,7 @@ local BaseNode = require("nvim-tree.node")
 
 ---@class (exact) DirectoryNode: BaseNode
 ---@field has_children boolean
----@field group_next Node? -- If node is grouped, this points to the next child dir/link node
+---@field group_next DirectoryNode? -- If node is grouped, this points to the next child dir/link node
 ---@field nodes Node[]
 ---@field open boolean
 ---@field hidden_stats table? -- Each field of this table is a key for source and value for count
@@ -116,6 +116,18 @@ function DirectoryNode:get_git_status()
   end
 end
 
+-- If node is grouped, return the last node in the group. Otherwise, return the given node.
+---@return Node
+function DirectoryNode:last_group_node()
+  local node = self
+
+  while node.group_next do
+    node = node.group_next or node
+  end
+
+  return node
+end
+
 function DirectoryNode:expand_or_collapse(toggle_group)
   toggle_group = toggle_group or false
   if self.has_children then

lua/nvim-tree/node/init.lua

@@ -1,5 +1,6 @@
 local git = require("nvim-tree.git")
 
+---TODO #2886
 ---TODO remove all @cast
 ---TODO remove all references to directory fields:
 
@@ -106,17 +107,12 @@ function BaseNode:is_dotfile()
   return false
 end
 
--- If node is grouped, return the last node in the group. Otherwise, return the given node.
+---Return self, should only be called on a DirectoryNode
+---TODO #2886 remove method or leave in place, warn if practical and non too intrusive
 ---@return Node
 function BaseNode:last_group_node()
-  local node = self
-  --- @cast node BaseNode
-
-  while node.group_next do
-    node = node.group_next
-  end
-
-  return node
+  error(string.format("\nBaseNode:last_group_node called for '%s'", self.absolute_path))
+  return self
 end
 
 ---@param project table?

lua/nvim-tree/renderer/builder.lua

@@ -2,6 +2,10 @@ local notify = require("nvim-tree.notify")
 local utils = require("nvim-tree.utils")
 local view = require("nvim-tree.view")
 
+local DirectoryLinkNode = require("nvim-tree.node.directory-link")
+local DirectoryNode = require("nvim-tree.node.directory")
+local FileLinkNode = require("nvim-tree.node.file-link")
+
 local DecoratorBookmarks = require("nvim-tree.renderer.decorator.bookmarks")
 local DecoratorCopied = require("nvim-tree.renderer.decorator.copied")
 local DecoratorCut = require("nvim-tree.renderer.decorator.cut")
@@ -341,19 +345,21 @@ function Builder:add_highlights(node)
   return icon_hl_group, name_hl_group
 end
 
+---Insert node line into self.lines, calling Builder:build_lines for each directory
 ---@private
-function Builder:build_line(node, idx, num_children)
+---@param node Node
+---@param idx integer line number starting at 1
+---@param siblings integer of node
+function Builder:build_line(node, idx, siblings)
   -- various components
-  local indent_markers = pad.get_indent_markers(self.depth, idx, num_children, node, self.markers)
+  local indent_markers = pad.get_indent_markers(self.depth, idx, siblings, node, self.markers)
   local arrows = pad.get_arrows(node)
 
   -- main components
-  local is_folder = node.nodes ~= nil
-  local is_symlink = node.link_to ~= nil
   local icon, name
-  if is_folder then
+  if node:is(DirectoryNode) then
     icon, name = self:build_folder(node)
-  elseif is_symlink then
+  elseif node:is(DirectoryLinkNode) or node:is(FileLinkNode) then
     icon, name = self:build_symlink(node)
   else
     icon, name = self:build_file(node)
@@ -369,11 +375,13 @@ function Builder:build_line(node, idx, num_children)
 
   self.index = self.index + 1
 
-  node = node:last_group_node()
-  if node.open then
-    self.depth = self.depth + 1
-    self:build_lines(node)
-    self.depth = self.depth - 1
+  if node:is(DirectoryNode) then
+    node = node:last_group_node()
+    if node.open then
+      self.depth = self.depth + 1
+      self:build_lines(node)
+      self.depth = self.depth - 1
+    end
   end
 end
 
@@ -403,8 +411,11 @@ function Builder:add_hidden_count_string(node, idx, num_children)
   end
 end
 
+---Number of visible nodes
 ---@private
-function Builder:get_nodes_number(nodes)
+---@param nodes Node[]
+---@return integer
+function Builder:num_visible(nodes)
   if not self.explorer.live_filter.filter then
     return #nodes
   end
@@ -423,12 +434,12 @@ function Builder:build_lines(node)
   if not node then
     node = self.explorer
   end
-  local num_children = self:get_nodes_number(node.nodes)
+  local siblings = self:num_visible(node.nodes)
   local idx = 1
   for _, n in ipairs(node.nodes) do
     if not n.hidden then
       self:build_signs(n)
-      self:build_line(n, idx, num_children)
+      self:build_line(n, idx, siblings)
       idx = idx + 1
     end
   end

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

@@ -19,17 +19,17 @@ local function check_siblings_for_folder(node, with_arrows)
   return false
 end
 
-local function get_padding_indent_markers(depth, idx, nodes_number, markers, with_arrows, inline_arrows, node, early_stop)
+local function get_padding_indent_markers(depth, idx, siblings, markers, with_arrows, inline_arrows, node, early_stop)
   local base_padding = with_arrows and (not node.nodes or depth > 0) and "  " or ""
   local padding = (inline_arrows or depth == 0) and base_padding or ""
 
   if depth > 0 then
     local has_folder_sibling = check_siblings_for_folder(node, with_arrows)
     local indent = string.rep(" ", M.config.indent_width - 1)
-    markers[depth] = idx ~= nodes_number
+    markers[depth] = idx ~= siblings
     for i = 1, depth - early_stop do
       local glyph
-      if idx == nodes_number and i == depth then
+      if idx == siblings and i == depth then
         local bottom_width = M.config.indent_width - 2 + (with_arrows and not inline_arrows and has_folder_sibling and 2 or 0)
         glyph = M.config.indent_markers.icons.corner
           .. string.rep(M.config.indent_markers.icons.bottom, bottom_width)
@@ -46,7 +46,7 @@ local function get_padding_indent_markers(depth, idx, nodes_number, markers, wit
         padding = padding .. glyph
       elseif inline_arrows then
         padding = padding
-      elseif idx ~= nodes_number and depth == i and not node.nodes and has_folder_sibling then
+      elseif idx ~= siblings and depth == i and not node.nodes and has_folder_sibling then
         padding = padding .. base_padding .. glyph .. base_padding
       else
         padding = padding .. base_padding .. glyph
@@ -58,11 +58,11 @@ end
 
 ---@param depth integer
 ---@param idx integer
----@param nodes_number integer
+---@param siblings integer
 ---@param node Node
 ---@param markers table
 ---@return HighlightedString[]
-function M.get_indent_markers(depth, idx, nodes_number, node, markers, early_stop)
+function M.get_indent_markers(depth, idx, siblings, node, markers, early_stop)
   local str = ""
 
   local show_arrows = M.config.icons.show.folder_arrow
@@ -71,7 +71,7 @@ function M.get_indent_markers(depth, idx, nodes_number, node, markers, early_sto
   local indent_width = M.config.indent_width
 
   if show_markers then
-    str = str .. get_padding_indent_markers(depth, idx, nodes_number, markers, show_arrows, inline_arrows, node, early_stop or 0)
+    str = str .. get_padding_indent_markers(depth, idx, siblings, markers, show_arrows, inline_arrows, node, early_stop or 0)
   else
     str = str .. string.rep(" ", depth * indent_width)
   end