node methods

Author: alex-courtis

lua/nvim-tree/explorer/init.lua

@@ -6,6 +6,7 @@ local view = require("nvim-tree.view")
 local watch = require("nvim-tree.explorer.watch")
 local explorer_node = require("nvim-tree.explorer.node")
 
+local BaseNode = require("nvim-tree.node")
 local DirectoryNode = require("nvim-tree.node.directory")
 local FileNode = require("nvim-tree.node.file")
 local LinkNode = require("nvim-tree.node.link")
@@ -25,7 +26,7 @@ local FILTER_REASON = require("nvim-tree.enum").FILTER_REASON
 
 local config
 
----@class Explorer
+---@class Explorer: BaseNode
 ---@field opts table user options
 ---@field absolute_path string
 ---@field nodes Node[]
@@ -37,7 +38,7 @@ local config
 ---@field sorters Sorter
 ---@field marks Marks
 ---@field clipboard Clipboard
-local Explorer = {}
+local Explorer = BaseNode:new()
 
 ---@param path string|nil
 ---@return Explorer|nil
@@ -84,7 +85,7 @@ end
 
 function Explorer:destroy()
   local function iterate(node)
-    explorer_node.node_destroy(node)
+    node:destroy()
     if node.nodes then
       for _, child in pairs(node.nodes) do
         iterate(child)
@@ -114,7 +115,7 @@ function Explorer:reload(node, git_status)
 
   local remain_childs = {}
 
-  local node_ignored = explorer_node.is_git_ignored(node)
+  local node_ignored = node:is_git_ignored()
   ---@type table<string, Node>
   local nodes_by_path = utils.key_by(node.nodes, "absolute_path")
 
@@ -150,7 +151,7 @@ function Explorer:reload(node, git_status)
 
         if n.type ~= t then
           utils.array_remove(node.nodes, n)
-          explorer_node.node_destroy(n)
+          n:destroy()
           nodes_by_path[abs] = nil
         end
       end
@@ -193,14 +194,14 @@ function Explorer:reload(node, git_status)
       if remain_childs[n.absolute_path] then
         return remain_childs[n.absolute_path]
       else
-        explorer_node.node_destroy(n)
+        n:destroy()
         return false
       end
     end, node.nodes)
   )
 
   local is_root = not node.parent
-  local child_folder_only = explorer_node.has_one_child_folder(node) and node.nodes[1]
+  local child_folder_only = node:has_one_child_folder() and node.nodes[1]
   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)
@@ -329,7 +330,7 @@ function Explorer:update_parent_statuses(node, project, root)
     end
 
     -- update status
-    explorer_node.update_git_status(node, explorer_node.is_git_ignored(node.parent), project)
+    explorer_node.update_git_status(node, node.parent and node.parent:is_git_ignored(), project)
 
     -- maybe parent
     node = node.parent
@@ -343,7 +344,7 @@ end
 ---@param git_status table
 ---@param parent Explorer
 function Explorer:populate_children(handle, cwd, node, git_status, parent)
-  local node_ignored = explorer_node.is_git_ignored(node)
+  local node_ignored = node:is_git_ignored()
   local nodes_by_path = utils.bool_record(node.nodes, "absolute_path")
 
   local filter_status = parent.filters:prepare(git_status)
@@ -419,7 +420,7 @@ function Explorer:explore(node, status, parent)
   self:populate_children(handle, cwd, node, status, parent)
 
   local is_root = not node.parent
-  local child_folder_only = explorer_node.has_one_child_folder(node) and node.nodes[1]
+  local child_folder_only = node:has_one_child_folder() and node.nodes[1]
   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/explorer/node.lua

@@ -35,12 +35,6 @@ local function get_git_status(parent_ignored, status, absolute_path)
   return { file = file_status }
 end
 
----@param node Node
----@return boolean
-function M.has_one_child_folder(node)
-  return #node.nodes == 1 and node.nodes[1].nodes and vim.loop.fs_access(node.nodes[1].absolute_path, "R") or false
-end
-
 ---@param node Node
 ---@param parent_ignored boolean
 ---@param status table|nil
@@ -141,25 +135,6 @@ function M.reload_node_status(parent_node, projects)
   end
 end
 
----@param node Node
----@return boolean
-function M.is_git_ignored(node)
-  return node and node.git_status ~= nil and node.git_status.file == "!!"
-end
-
----@param node Node
----@return boolean
-function M.is_dotfile(node)
-  if node == nil then
-    return false
-  end
-  if node.is_dot or (node.name and (node.name:sub(1, 1) == ".")) or M.is_dotfile(node.parent) then
-    node.is_dot = true
-    return true
-  end
-  return false
-end
-
 ---@param node Node
 function M.node_destroy(node)
   if not node then

lua/nvim-tree/git/init.lua

@@ -208,7 +208,7 @@ local function reload_tree_at(toplevel)
     Iterator.builder(root_node.nodes)
       :hidden()
       :applier(function(node)
-        local parent_ignored = explorer_node.is_git_ignored(node.parent)
+        local parent_ignored = node.parent and node.parent:is_git_ignored()
         explorer_node.update_git_status(node, parent_ignored, git_status)
       end)
       :recursor(function(node)

lua/nvim-tree/lib.lua

@@ -3,7 +3,6 @@ local core = require("nvim-tree.core")
 local utils = require("nvim-tree.utils")
 local events = require("nvim-tree.events")
 local notify = require("nvim-tree.notify")
-local explorer_node = require("nvim-tree.explorer.node")
 
 ---@class LibOpenOpts
 ---@field path string|nil path
@@ -101,7 +100,7 @@ end
 ---@return Node[]
 function M.group_empty_folders(node)
   local is_root = not node.parent
-  local child_folder_only = explorer_node.has_one_child_folder(node) and node.nodes[1]
+  local child_folder_only = node:has_one_child_folder() and node.nodes[1]
   if M.group_empty and not is_root and child_folder_only then
     node.group_next = child_folder_only
     local ns = M.group_empty_folders(child_folder_only)

lua/nvim-tree/node/directory.lua

@@ -1,6 +1,6 @@
 local watch = require("nvim-tree.explorer.watch")
 
-local BaseNode = require("nvim-tree.node.init")
+local BaseNode = require("nvim-tree.node")
 
 ---@class (exact) DirectoryNode: BaseNode
 ---@field has_children boolean

lua/nvim-tree/node/file.lua

@@ -1,6 +1,6 @@
 local utils = require("nvim-tree.utils")
 
-local BaseNode = require("nvim-tree.node.init")
+local BaseNode = require("nvim-tree.node")
 
 ---@class (exact) FileNode: BaseNode
 ---@field extension string

lua/nvim-tree/node/init.lua

@@ -1,6 +1,3 @@
----@class ParentNode
----@field name string
-
 ---@class (exact) BaseNode
 ---@field type NODE_TYPE
 ---@field explorer Explorer
@@ -28,4 +25,34 @@ function BaseNode:new(o)
   return o
 end
 
+function BaseNode:destroy()
+  if self.watcher then
+    self.watcher:destroy()
+    self.watcher = nil
+  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
+
+---@return boolean
+function BaseNode:is_git_ignored()
+  return self.git_status ~= nil and self.git_status.file == "!!"
+end
+
+---@return boolean
+function BaseNode:is_dotfile()
+  if
+    self.is_dot                                     --
+    or (self.name and (self.name:sub(1, 1) == ".")) --
+    or (self.parent and self.parent:is_dotfile())
+  then
+    self.is_dot = true
+    return true
+  end
+  return false
+end
+
 return BaseNode

lua/nvim-tree/node/link.lua

@@ -1,6 +1,6 @@
 local watch = require("nvim-tree.explorer.watch")
 
-local BaseNode = require("nvim-tree.node.init")
+local BaseNode = require("nvim-tree.node")
 
 ---@class (exact) LinkNode: BaseNode
 ---@field link_to string absolute path

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

@@ -1,6 +1,5 @@
 local HL_POSITION = require("nvim-tree.enum").HL_POSITION
 local ICON_PLACEMENT = require("nvim-tree.enum").ICON_PLACEMENT
-local explorer_node = require("nvim-tree.explorer.node")
 local Decorator = require("nvim-tree.renderer.decorator")
 
 ---@class (exact) DecoratorHidden: Decorator
@@ -34,7 +33,7 @@ end
 ---@param node Node
 ---@return HighlightedString[]|nil icons
 function DecoratorHidden:calculate_icons(node)
-  if self.enabled and explorer_node.is_dotfile(node) then
+  if self.enabled and node:is_dotfile() then
     return { self.icon }
   end
 end
@@ -43,7 +42,7 @@ end
 ---@param node Node
 ---@return string|nil group
 function DecoratorHidden:calculate_highlight(node)
-  if not self.enabled or self.hl_pos == HL_POSITION.none or (not explorer_node.is_dotfile(node)) then
+  if not self.enabled or self.hl_pos == HL_POSITION.none or not node:is_dotfile() then
     return nil
   end