tidy group methods

Author: alex-courtis

lua/nvim-tree.lua

@@ -125,7 +125,7 @@ function M.place_cursor_on_node()
   if not node or node.name == ".." then
     return
   end
-  node = node:get_parent_of_group()
+  node = node:group_parent_or_node()
 
   local line = vim.api.nvim_get_current_line()
   local cursor = vim.api.nvim_win_get_cursor(0)

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

@@ -24,7 +24,7 @@ function M.fn(should_close)
       return
     end
 
-    local parent = node:get_parent_of_group().parent
+    local parent = node:group_parent_or_node().parent
 
     if not parent or not parent.parent then
       return view.set_cursor({ 1, 0 })

lua/nvim-tree/explorer/init.lua

@@ -5,6 +5,7 @@ local utils = require("nvim-tree.utils")
 local view = require("nvim-tree.view")
 local node_factory = require("nvim-tree.node.factory")
 
+local DirectoryNode = require("nvim-tree.node.directory")
 local RootNode = require("nvim-tree.node.root")
 local Watcher = require("nvim-tree.watcher")
 
@@ -72,12 +73,12 @@ function Explorer:create(path)
   return o
 end
 
----@param node Node
+---@param node DirectoryNode
 function Explorer:expand(node)
   self:_load(node)
 end
 
----@param node Node
+---@param node DirectoryNode
 ---@param git_status table|nil
 function Explorer:reload(node, git_status)
   local cwd = node.link_to or node.absolute_path
@@ -169,17 +170,10 @@ function Explorer:reload(node, git_status)
     end, node.nodes)
   )
 
-  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)
+  local single_child = node:single_child_directory()
+  if config.renderer.group_empty and node.parent and single_child then
+    node.group_next = single_child
+    local ns = self:reload(single_child, git_status)
     node.nodes = ns or {}
     log.profile_end(profile)
     return ns
@@ -225,7 +219,7 @@ function Explorer:refresh_parent_nodes_for_path(path)
 end
 
 ---@private
----@param node Node
+---@param node DirectoryNode
 function Explorer:_load(node)
   local cwd = node.link_to or node.absolute_path
   local git_status = git.load_project_status(cwd)
@@ -301,7 +295,7 @@ function Explorer:populate_children(handle, cwd, node, git_status, parent)
 end
 
 ---@private
----@param node Node
+---@param node DirectoryNode
 ---@param status table
 ---@param parent Explorer
 ---@return Node[]|nil
@@ -317,18 +311,12 @@ 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 single_child = node:single_child_directory()
+  if config.renderer.group_empty and not is_root and single_child then
+    local child_cwd = single_child.link_to or single_child.absolute_path
     local child_status = git.load_project_status(child_cwd)
-    node.group_next = child_folder_only
-    local ns = self:explore(child_folder_only, child_status, parent)
+    node.group_next = single_child
+    local ns = self:explore(single_child, child_status, parent)
     node.nodes = ns or {}
 
     log.profile_end(profile)
@@ -347,9 +335,10 @@ end
 function Explorer:refresh_nodes(projects)
   Iterator.builder({ self })
     :applier(function(n)
-      if n.nodes then
-        local toplevel = git.get_toplevel(n.cwd or n.link_to or n.absolute_path)
-        self:reload(n, projects[toplevel] or {})
+      local dir = n:as(DirectoryNode)
+      if dir then
+        local toplevel = git.get_toplevel(dir.cwd or dir.link_to or dir.absolute_path)
+        self:reload(dir, projects[toplevel] or {})
       end
     end)
     :recursor(function(n)

lua/nvim-tree/explorer/watch.lua

@@ -53,7 +53,7 @@ local function is_folder_ignored(path)
   return false
 end
 
----@param node Node
+---@param node DirectoryNode
 ---@return Watcher|nil
 function M.create_watcher(node)
   if not M.config.filesystem_watchers.enable or type(node) ~= "table" then

lua/nvim-tree/node/directory.lua

@@ -116,6 +116,22 @@ function DirectoryNode:get_git_status()
   end
 end
 
+---Refresh contents and git status for a single node
+function DirectoryNode:refresh()
+  local node = self:group_parent_or_node()
+  local toplevel = git.get_toplevel(self.absolute_path)
+
+  git.reload_project(toplevel, self.absolute_path, function()
+    local project = git.get_project(toplevel) or {}
+
+    self.explorer:reload(node, project)
+
+    node:update_parent_statuses(project, toplevel)
+
+    self.explorer.renderer:draw()
+  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()
@@ -128,15 +144,18 @@ 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
+---Return the one and only one child directory
+---@return DirectoryNode?
+function DirectoryNode:single_child_directory()
+  if #self.nodes == 1 then
+    return self.nodes[1]:as(DirectoryNode)
+  end
 end
 
 ---@private
 ---@return Node[]
 function DirectoryNode:get_all_nodes_in_group()
-  local next_node = self:get_parent_of_group()
+  local next_node = self:group_parent_or_node()
   local nodes = {}
   while next_node do
     table.insert(nodes, next_node)
@@ -162,14 +181,10 @@ end
 ---@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()
+  local single_child = self:single_child_directory()
+  if self.explorer.opts.renderer.group_empty and self.parent and single_child then
+    self.group_next = single_child
+    local ns = single_child:group_empty_folders()
     self.nodes = ns or {}
     return ns
   end
@@ -180,11 +195,10 @@ end
 -- 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]
+  if self.group_next then
+    self.group_next:ungroup_empty_folders()
+    self.nodes = { self.group_next }
+    self.group_next = nil
   end
 end
 
@@ -199,10 +213,7 @@ function DirectoryNode:expand_or_collapse(toggle_group)
     self.explorer:expand(self)
   end
 
-  local head_node = self:get_parent_of_group()
-  ---
-  --- @cast head_node DirectoryNode
-  ---
+  local head_node = self:group_parent_or_node()
   if toggle_group then
     head_node:toggle_group_folders()
   end

lua/nvim-tree/node/init.lua

@@ -38,6 +38,7 @@ end
 ---@param status table?
 function BaseNode:update_git_status(parent_ignored, status) ---@diagnostic disable-line: unused-local
 end
+
 --luacheck: pop
 
 ---@return GitStatus?
@@ -115,30 +116,14 @@ function BaseNode:update_parent_statuses(project, root)
   end
 end
 
----Refresh contents and git status for a single node
-function BaseNode:refresh()
-  local parent_node = self:get_parent_of_group()
-  local toplevel = git.get_toplevel(self.absolute_path)
-
-  git.reload_project(toplevel, self.absolute_path, function()
-    local project = git.get_project(toplevel) or {}
-
-    self.explorer:reload(parent_node, project)
-
-    parent_node:update_parent_statuses(project, toplevel)
-
-    self.explorer.renderer:draw()
-  end)
-end
-
----Get the highest parent of grouped nodes
----@return Node node or parent
-function BaseNode:get_parent_of_group()
-  local node = self
-  while node and node.parent and node.parent.group_next do
-    node = node.parent or node
+---Get the highest parent of grouped nodes or the node itself
+---@return Node
+function BaseNode:group_parent_or_node()
+  if self.parent and self.parent.group_next then
+    return self.parent:group_parent_or_node()
+  else
+    return self
   end
-  return node
 end
 
 ---Create a sanitized partial copy of a node, populating children recursively.