explorer is a directory node

Author: alex-courtis

lua/nvim-tree.lua

@@ -849,7 +849,7 @@ function M.setup(conf)
   require("nvim-tree.keymap").setup(opts)
   require("nvim-tree.appearance").setup()
   require("nvim-tree.diagnostics").setup(opts)
-  require("nvim-tree.explorer").setup(opts)
+  require("nvim-tree.explorer"):setup(opts)
   require("nvim-tree.git").setup(opts)
   require("nvim-tree.git.utils").setup(opts)
   require("nvim-tree.view").setup(opts)

lua/nvim-tree/explorer/init.lua

@@ -3,7 +3,6 @@ local log = require "nvim-tree.log"
 local notify = require "nvim-tree.notify"
 local utils = require "nvim-tree.utils"
 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"
@@ -26,19 +25,15 @@ local FILTER_REASON = require("nvim-tree.enum").FILTER_REASON
 
 local config
 
----@class Explorer: BaseNode
+---@class (exact) Explorer: DirectoryNode
 ---@field opts table user options
----@field absolute_path string
----@field nodes Node[]
----@field open boolean
----@field watcher Watcher|nil
 ---@field renderer Renderer
 ---@field filters Filters
 ---@field live_filter LiveFilter
 ---@field sorters Sorter
 ---@field marks Marks
 ---@field clipboard Clipboard
-local Explorer = BaseNode:new()
+local Explorer = BaseNode.new(DirectoryNode) -- TODO do not inherit, add a root node to separate Explorer and Node
 
 ---@param path string|nil
 ---@return Explorer|nil
@@ -56,27 +51,16 @@ function Explorer:new(path)
   end
 
   ---@type Explorer
-  local placeholder
-
-  local o = BaseNode.new(self, {
-    type = "directory",
-    explorer = placeholder,
-    absolute_path = path,
-    executable = false,
-    hidden = false,
-    is_dot = false,
-
-    has_children = false,
-    group_next = nil,
-    nodes = {},
-    open = true,
-  })
+  local placeholder = nil
+
+  local o = DirectoryNode.new(self, placeholder, nil, path, nil, nil)
   ---@cast o Explorer
 
   o.explorer = self
+  o.open = true
+
   o.opts = config
   o.sorters = Sorters:new(config)
-  o.watcher = watch.create_watcher(o)
   o.renderer = Renderer:new(config, o)
   o.filters = Filters:new(config, o)
   o.live_filter = LiveFilter:new(config, o)
@@ -490,7 +474,7 @@ function Explorer:reload_git()
   event_running = false
 end
 
-function Explorer.setup(opts)
+function Explorer:setup(opts)
   config = opts
   require("nvim-tree.explorer.node").setup(opts)
   require("nvim-tree.explorer.watch").setup(opts)

lua/nvim-tree/node/directory.lua

@@ -3,8 +3,8 @@ local watch = require "nvim-tree.explorer.watch"
 local BaseNode = require "nvim-tree.node"
 
 ---@class (exact) DirectoryNode: BaseNode
----@field has_children boolean
----@field group_next Node|nil
+---@field has_children boolean -- TODO remove this and just test nodes
+---@field group_next Node|nil -- 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
@@ -13,7 +13,7 @@ local DirectoryNode = BaseNode:new()
 ---@param explorer Explorer
 -----@param parent DirectoryNode    -- TODO  #2871 #2886
 ---@param absolute_path string
----@param name string
+---@param name string|nil
 ---@param fs_stat uv.fs_stat.result|nil
 ---@return DirectoryNode
 function DirectoryNode:new(explorer, parent, absolute_path, name, fs_stat)
@@ -32,7 +32,7 @@ function DirectoryNode:new(explorer, parent, absolute_path, name, fs_stat)
     parent = parent,
 
     has_children = has_children,
-    group_next = nil, -- If node is grouped, this points to the next child dir/link node
+    group_next = nil,
     nodes = {},
     open = false,
   })

lua/nvim-tree/node/init.lua

@@ -14,7 +14,7 @@
 ---@field diag_status DiagStatus|nil
 local BaseNode = {}
 
----@alias Node DirectoryNode|FileNode|LinkNode|Explorer
+---@alias Node DirectoryNode|FileNode|LinkNode
 
 ---@param o BaseNode|nil
 ---@return BaseNode

lua/nvim-tree/node/link.lua

@@ -3,6 +3,8 @@ local watch = require "nvim-tree.explorer.watch"
 local BaseNode = require "nvim-tree.node"
 
 ---@class (exact) LinkNode: BaseNode
+---@field has_children boolean -- TODO remove this and just test nodes
+---@field group_next Node|nil -- If node is grouped, this points to the next child dir/link node
 ---@field link_to string absolute path
 local LinkNode = BaseNode:new()
 
@@ -44,7 +46,7 @@ function LinkNode:new(explorer, parent, absolute_path, name, fs_stat)
     link_to = link_to,
 
     has_children = has_children,
-    group_next = nil, -- If node is grouped, this points to the next child dir/link node
+    group_next = nil,
     nodes = nodes,
     open = open,
   })