move group methods into DN

Author: alex-courtis

lua/nvim-tree/api.lua

@@ -210,13 +210,16 @@ local function edit(mode, node)
 end
 
 ---@param mode string
----@return fun(node: table)
+---@return fun(node: Node)
 local function open_or_expand_or_dir_up(mode, toggle_group)
+  ---@param node Node
   return function(node)
     if node.name == ".." then
       actions.root.change_dir.fn("..")
     elseif node:is(DirectoryNode) then
+      ---
       ---@cast node DirectoryNode
+      ---
       node:expand_or_collapse(toggle_group)
     elseif not toggle_group then
       edit(mode, node)

lua/nvim-tree/explorer/init.lua

@@ -170,7 +170,13 @@ function Explorer:reload(node, git_status)
   )
 
   local is_root = not node.parent
+  ---
+  --- @cast node DirectoryNode
+  ---
   local child_folder_only = node:has_one_child_folder() and node.nodes[1]
+  ---
+  --- @cast child_folder_only DirectoryNode
+  ---
   if config.renderer.group_empty and not is_root and child_folder_only then
     node.group_next = child_folder_only
     local ns = self:reload(child_folder_only, git_status)
@@ -311,7 +317,13 @@ function Explorer:explore(node, status, parent)
   self:populate_children(handle, cwd, node, status, parent)
 
   local is_root = not node.parent
+  ---
+  --- @cast node DirectoryNode
+  ---
   local child_folder_only = node:has_one_child_folder() and node.nodes[1]
+  ---
+  --- @cast child_folder_only DirectoryNode
+  ---
   if config.renderer.group_empty and not is_root and child_folder_only then
     local child_cwd = child_folder_only.link_to or child_folder_only.absolute_path
     local child_status = git.load_project_status(child_cwd)

lua/nvim-tree/node/directory.lua

@@ -128,6 +128,66 @@ function DirectoryNode:last_group_node()
   return node
 end
 
+---@return boolean
+function DirectoryNode:has_one_child_folder()
+  return #self.nodes == 1 and self.nodes[1].nodes and vim.loop.fs_access(self.nodes[1].absolute_path, "R") or false
+end
+
+---@private
+---@return Node[]
+function DirectoryNode:get_all_nodes_in_group()
+  local next_node = self:get_parent_of_group()
+  local nodes = {}
+  while next_node do
+    table.insert(nodes, next_node)
+    next_node = next_node.group_next
+  end
+  return nodes
+end
+
+---@private
+-- Toggle group empty folders
+function DirectoryNode:toggle_group_folders()
+  local is_grouped = self.group_next ~= nil
+
+  if is_grouped then
+    self:ungroup_empty_folders()
+  else
+    self:group_empty_folders()
+  end
+end
+
+---Group empty folders
+-- Recursively group nodes
+---@private
+---@return Node[]
+function DirectoryNode:group_empty_folders()
+  local is_root = not self.parent
+  local child_folder_only = self:has_one_child_folder() and self.nodes[1]
+  ---
+  --- @cast child_folder_only DirectoryNode
+  ---
+  if self.explorer.opts.renderer.group_empty and not is_root and child_folder_only then
+    self.group_next = child_folder_only
+    local ns = child_folder_only:group_empty_folders()
+    self.nodes = ns or {}
+    return ns
+  end
+  return self.nodes
+end
+
+---Ungroup empty folders
+-- If a node is grouped, ungroup it: put node.group_next to the node.nodes and set node.group_next to nil
+---@private
+function DirectoryNode:ungroup_empty_folders()
+  local cur = self
+  while cur and cur.group_next do
+    cur.nodes = { cur.group_next }
+    cur.group_next = nil
+    cur = cur.nodes[1]
+  end
+end
+
 ---@param toggle_group boolean
 function DirectoryNode:expand_or_collapse(toggle_group)
   toggle_group = toggle_group or false
@@ -140,6 +200,9 @@ function DirectoryNode:expand_or_collapse(toggle_group)
   end
 
   local head_node = self:get_parent_of_group()
+  ---
+  --- @cast head_node DirectoryNode
+  ---
   if toggle_group then
     head_node:toggle_group_folders()
   end

lua/nvim-tree/node/init.lua

@@ -32,11 +32,6 @@ function BaseNode:destroy()
   end
 end
 
----@return boolean
-function BaseNode:has_one_child_folder()
-  return #self.nodes == 1 and self.nodes[1].nodes and vim.loop.fs_access(self.nodes[1].absolute_path, "R") or false
-end
-
 --luacheck: push ignore 212
 ---Update the GitStatus of the node
 ---@param parent_ignored boolean
@@ -146,54 +141,6 @@ function BaseNode:get_parent_of_group()
   return node
 end
 
----@return Node[]
-function BaseNode:get_all_nodes_in_group()
-  local next_node = self:get_parent_of_group()
-  local nodes = {}
-  while next_node do
-    table.insert(nodes, next_node)
-    next_node = next_node.group_next
-  end
-  return nodes
-end
-
--- Toggle group empty folders
-function BaseNode:toggle_group_folders()
-  local is_grouped = self.group_next ~= nil
-
-  if is_grouped then
-    self:ungroup_empty_folders()
-  else
-    self:group_empty_folders()
-  end
-end
-
----Group empty folders
--- Recursively group nodes
----@return Node[]
-function BaseNode:group_empty_folders()
-  local is_root = not self.parent
-  local child_folder_only = self:has_one_child_folder() and self.nodes[1]
-  if self.explorer.opts.renderer.group_empty and not is_root and child_folder_only then
-    self.group_next = child_folder_only
-    local ns = child_folder_only:group_empty_folders()
-    self.nodes = ns or {}
-    return ns
-  end
-  return self.nodes
-end
-
----Ungroup empty folders
--- If a node is grouped, ungroup it: put node.group_next to the node.nodes and set node.group_next to nil
-function BaseNode:ungroup_empty_folders()
-  local cur = self
-  while cur and cur.group_next do
-    cur.nodes = { cur.group_next }
-    cur.group_next = nil
-    cur = cur.nodes[1]
-  end
-end
-
 ---Create a sanitized partial copy of a node, populating children recursively.
 ---@return BaseNode cloned
 function BaseNode:clone()