refactor(#3225): multi instance expand (#3234)

* wip(explorer): rename :expand to :expand_dir_node and all places using it

* wip: move expand function to directory

* refactor: move expand functionality to node methods

Move expansion logic from actions/tree/modifiers/expand.lua into
DirectoryNode and Explorer methods. Update API to use new methods
via wrap_explorer. Remove expand module and its setup calls.

* refactor(directory): correctly calling class methods and passing correct values

* fix: moving directory and file nodes require to avoid circular depency

* fix(node): correctly calling expand on parent without circular dependency

* fix(node.directory): fix <E> not expanding all folders

* refactor(node.director): move gen_iterator to expand and safely call descend_until_empty

* feat: move collapse to tree actions and remove modifiers folder

* feat: move should_expand to Node for better OO

* chore: add should_expand in DirectoryNode to avoid circular dependecy

* fix(explorer): correctly calling expand as a class method

* fix: adding underscore on unsed variables

* chore: move descend_until_empty to local function

* fix(directory): correctly pass node instead of self ot should_descend

Author: Uanela

…tree/actions/tree/modifiers/collapse.lua lua/nvim-tree/actions/tree/collapse.lualua/nvim-tree/actions/tree/modifiers/collapse.lua renamed to lua/nvim-tree/actions/tree/collapse.lua lua/nvim-tree/actions/tree/modifiers/collapse.lua renamed to lua/nvim-tree/actions/tree/collapse.lua

@@ -1,14 +1,13 @@
 local M = {}
 
 M.find_file = require("nvim-tree.actions.tree.find-file")
-M.modifiers = require("nvim-tree.actions.tree.modifiers")
+M.collapse = require("nvim-tree.actions.tree.collapse")
 M.open = require("nvim-tree.actions.tree.open")
 M.toggle = require("nvim-tree.actions.tree.toggle")
 M.resize = require("nvim-tree.actions.tree.resize")
 
 function M.setup(opts)
   M.find_file.setup(opts)
-  M.modifiers.setup(opts)
   M.open.setup(opts)
   M.toggle.setup(opts)
   M.resize.setup(opts)

lua/nvim-tree/actions/tree/init.lua

@@ -176,12 +176,12 @@ Api.tree.search_node = wrap(actions.finders.search_node.fn)
 ---@class ApiCollapseOpts
 ---@field keep_buffers boolean|nil default false
 
-Api.tree.collapse_all = wrap(actions.tree.modifiers.collapse.all)
+Api.tree.collapse_all = wrap(actions.tree.collapse.all)
 
 ---@class ApiTreeExpandOpts
 ---@field expand_until (fun(expansion_count: integer, node: Node): boolean)|nil
 
-Api.tree.expand_all = wrap_node(actions.tree.modifiers.expand.all)
+Api.tree.expand_all = wrap_node(wrap_explorer("expand_all"))
 Api.tree.toggle_enable_filters = wrap_explorer_member("filters", "toggle")
 Api.tree.toggle_gitignore_filter = wrap_explorer_member_args("filters", "toggle", "git_ignored")
 Api.tree.toggle_git_clean_filter = wrap_explorer_member_args("filters", "toggle", "git_clean")
@@ -310,8 +310,8 @@ Api.node.navigate.diagnostics.prev_recursive = wrap_node(actions.moves.item.fn({
 Api.node.navigate.opened.next = wrap_node(actions.moves.item.fn({ where = "next", what = "opened" }))
 Api.node.navigate.opened.prev = wrap_node(actions.moves.item.fn({ where = "prev", what = "opened" }))
 
-Api.node.expand = wrap_node(actions.tree.modifiers.expand.node)
-Api.node.collapse = wrap_node(actions.tree.modifiers.collapse.node)
+Api.node.expand = wrap_node(wrap_explorer("expand_node"))
+Api.node.collapse = wrap_node(actions.tree.collapse.node)
 
 ---@class ApiNodeDeleteWipeBufferOpts
 ---@field force boolean|nil default false

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

@@ -687,6 +687,28 @@ function Explorer:get_nodes()
   return self:clone()
 end
 
+---Expand the directory node or the root
+---@param node Node
+---@param expand_opts ApiTreeExpandOpts?
+function Explorer:expand_all(node, expand_opts)
+  if node then
+    node:expand(expand_opts)
+  else
+    self:expand(expand_opts)
+  end
+end
+
+---Expand the directory node or parent node
+---@param node Node
+---@param expand_opts ApiTreeExpandOpts?
+function Explorer:expand_node(node, expand_opts)
+  if not node then
+    return
+  end
+
+  node:expand(expand_opts)
+end
+
 ---@private
 ---@param new_tabpage integer
 ---@return boolean

lua/nvim-tree/actions/tree/modifiers/init.lua

@@ -1,6 +1,7 @@
 local git_utils = require("nvim-tree.git.utils")
 local icons = require("nvim-tree.renderer.components.devicons")
 local notify = require("nvim-tree.notify")
+local Iterator = require("nvim-tree.iterators.node-iterator")
 
 local Node = require("nvim-tree.node")
 
@@ -290,4 +291,110 @@ function DirectoryNode:clone(api_nodes)
   return clone
 end
 
+---@private
+---@param should_descend fun(expansion_count: integer, node: Node): boolean
+---@return fun(expansion_count: integer, node: Node): boolean
+function DirectoryNode:limit_folder_discovery(should_descend)
+  local MAX_FOLDER_DISCOVERY = self.explorer.opts.actions.expand_all.max_folder_discovery
+  return function(expansion_count, node)
+    local should_halt = expansion_count >= MAX_FOLDER_DISCOVERY
+    if should_halt then
+      notify.warn("expansion iteration was halted after " .. MAX_FOLDER_DISCOVERY .. " discovered folders")
+      return false
+    end
+
+    return should_descend(expansion_count, node)
+  end
+end
+
+---@param expansion_count integer
+---@param should_descend fun(expansion_count: integer, node: Node): boolean
+---@return boolean
+function DirectoryNode:should_expand(expansion_count, should_descend)
+  if not self.open and should_descend(expansion_count, self) then
+    if #self.nodes == 0 then
+      self.explorer:expand_dir_node(self) -- populate node.group_next
+    end
+
+    if self.group_next then
+      local expand_next = self.group_next:should_expand(expansion_count, should_descend)
+      if expand_next then
+        self.open = true
+      end
+      return expand_next
+    else
+      return true
+    end
+  end
+  return false
+end
+
+---@param list string[]
+---@return table
+local function to_lookup_table(list)
+  local table = {}
+  for _, element in ipairs(list) do
+    table[element] = true
+  end
+
+  return table
+end
+
+---@param _ integer
+---@param node Node
+---@return boolean
+local function descend_until_empty(_, node)
+  local EXCLUDE = to_lookup_table(node.explorer.opts.actions.expand_all.exclude)
+  local should_exclude = EXCLUDE[node.name]
+  return not should_exclude
+end
+
+---@param expand_opts ApiTreeExpandOpts?
+function DirectoryNode:expand(expand_opts)
+  local expansion_count = 0
+
+  local should_descend = self:limit_folder_discovery((expand_opts and expand_opts.expand_until) or descend_until_empty)
+
+
+  if self.parent and self.nodes and not self.open then
+    expansion_count = expansion_count + 1
+    self:expand_dir_node()
+  end
+
+  Iterator.builder(self.nodes)
+    :hidden()
+    :applier(function(node)
+      if node:should_expand(expansion_count, should_descend) then
+        expansion_count = expansion_count + 1
+        node:expand_dir_node()
+      end
+    end)
+    :recursor(function(node)
+      if not should_descend(expansion_count, node) then
+        return nil
+      end
+
+      if node.group_next then
+        return { node.group_next }
+      end
+
+      if node.open and node.nodes then
+        return node.nodes
+      end
+
+      return nil
+    end)
+    :iterate()
+
+  self.explorer.renderer:draw()
+end
+
+function DirectoryNode:expand_dir_node()
+  local node = self:last_group_node()
+  node.open = true
+  if #node.nodes == 0 then
+    self.explorer:expand_dir_node(node)
+  end
+end
+
 return DirectoryNode

lua/nvim-tree/api.lua

@@ -144,4 +144,18 @@ function Node:clone(api_nodes)
   return clone
 end
 
+---@param _expansion_count integer
+---@param _should_descend fun(expansion_count: integer, node: Node): boolean
+---@return boolean
+function Node:should_expand(_expansion_count, _should_descend)
+  return false
+end
+
+---@param expand_opts ApiTreeExpandOpts?
+function Node:expand(expand_opts)
+  if self.parent then
+    self.parent:expand(expand_opts)
+  end
+end
+
 return Node