feat: Allow to expand nodes until certain condition is met

Author: ghostbuster91

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

@@ -30,17 +30,30 @@ end
 ---@param expansion_count integer
 ---@param node Node
 ---@return boolean
-local function should_expand(expansion_count, node)
+local function descend_until_max_or_empty(expansion_count, node)
   local dir = node:as(DirectoryNode)
   if not dir then
     return false
   end
+
   local should_halt = expansion_count >= M.MAX_FOLDER_DISCOVERY
   local should_exclude = M.EXCLUDE[dir.name]
-  return not should_halt and not dir.open and not should_exclude
+
+  return not should_halt and not should_exclude
+end
+
+---@param expansion_count integer
+---@param node Node
+---@param should_descend fun(expansion_count: integer, node: Node): boolean
+---@return boolean
+local function should_expand(expansion_count, node, should_descend)
+  local dir = node:as(DirectoryNode)
+  return dir and not dir.open and should_descend(expansion_count, node)
 end
 
-local function gen_iterator()
+
+---@param should_descend fun(expansion_count: integer, node: Node): boolean
+local function gen_iterator(should_descend)
   local expansion_count = 0
 
   return function(parent)
@@ -52,7 +65,7 @@ local function gen_iterator()
     Iterator.builder(parent.nodes)
       :hidden()
       :applier(function(node)
-        if should_expand(expansion_count, node) then
+        if should_expand(expansion_count, node, should_descend) then
           expansion_count = expansion_count + 1
           node = node:as(DirectoryNode)
           if node then
@@ -61,7 +74,19 @@ local function gen_iterator()
         end
       end)
       :recursor(function(node)
-        return expansion_count < M.MAX_FOLDER_DISCOVERY and (node.group_next and { node.group_next } or (node.open and node.nodes))
+        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()
 
@@ -72,12 +97,13 @@ local function gen_iterator()
 end
 
 ---@param node Node?
-local function expand_node(node)
+---@param expand_opts ApiTreeExpandAllOpts?
+local function expand_node(node, expand_opts)
   if not node then
     return
   end
-
-  if gen_iterator()(node) then
+  local descend_until = (expand_opts and expand_opts.descend_until) or descend_until_max_or_empty
+  if gen_iterator(descend_until)(node) then
     notify.warn("expansion iteration was halted after " .. M.MAX_FOLDER_DISCOVERY .. " discovered folders")
   end
 
@@ -89,18 +115,20 @@ end
 
 ---Expand the directory node or the root
 ---@param node Node
-function M.all(node)
-  expand_node(node and node:as(DirectoryNode) or core.get_explorer())
+---@param expand_opts ApiTreeExpandAllOpts?
+function M.all(node, expand_opts)
+  expand_node(node and node:as(DirectoryNode) or core.get_explorer(), expand_opts)
 end
 
 ---Expand the directory node or parent node
 ---@param node Node
-function M.node(node)
+---@param expand_opts ApiTreeExpandAllOpts?
+function M.node(node, expand_opts)
   if not node then
     return
   end
 
-  expand_node(node:is(FileNode) and node.parent or node:as(DirectoryNode))
+  expand_node(node:is(FileNode) and node.parent or node:as(DirectoryNode), expand_opts)
 end
 
 function M.setup(opts)

lua/nvim-tree/api.lua

@@ -121,6 +121,45 @@ local function wrap_explorer_member(explorer_member, member_method)
   end)
 end
 
+---
+---@class NodeEditOpts
+---@field quit_on_open boolean|nil default false
+---@field focus boolean|nil default true
+
+---@param mode string
+---@param node Node
+---@param edit_opts NodeEditOpts?
+local function edit(mode, node, edit_opts)
+  local file_link = node:as(FileLinkNode)
+  local path = file_link and file_link.link_to or node.absolute_path
+  local cur_tabpage = vim.api.nvim_get_current_tabpage()
+
+  local explorer = core.get_explorer()
+
+  actions.node.open_file.fn(mode, path)
+
+  edit_opts = edit_opts or {}
+
+  local mode_unsupported_quit_on_open = mode == "drop" or mode == "tab_drop" or mode == "edit_in_place"
+  if not mode_unsupported_quit_on_open and edit_opts.quit_on_open then
+    if explorer then
+      explorer.view:close(cur_tabpage, "api.edit " .. mode)
+    end
+  end
+
+  local mode_unsupported_focus = mode == "drop" or mode == "tab_drop" or mode == "edit_in_place"
+  local focus = edit_opts.focus == nil or edit_opts.focus == true
+  if not mode_unsupported_focus and not focus then
+    -- if mode == "tabnew" a new tab will be opened and we need to focus back to the previous tab
+    if mode == "tabnew" then
+      vim.cmd(":tabprev")
+    end
+    if explorer then
+      explorer.view:focus()
+    end
+  end
+end
+
 ---@class ApiTreeOpenOpts
 ---@field path string|nil path
 ---@field current_window boolean|nil default false
@@ -186,7 +225,25 @@ Api.tree.search_node = wrap(actions.finders.search_node.fn)
 ---@field keep_buffers boolean|nil default false
 
 Api.tree.collapse_all = wrap(actions.tree.modifiers.collapse.all)
+
+---@class ApiTreeExpandAllOpts
+---@field descend_until (fun(expansion_count: integer, node: Node): boolean)|nil
+
 Api.tree.expand_all = wrap_node(actions.tree.modifiers.expand.all)
+
+Api.tree.toggle_descend_until = wrap_node(function(node, descend_until)
+  if node.open then
+    local dir = node:as(DirectoryNode)
+    dir:expand_or_collapse("edit")
+  else
+    if node.nodes then
+      actions.tree.modifiers.expand.all(node, { descend_until = descend_until })
+    else
+      edit("edit", node)
+    end
+  end
+end)
+
 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")
@@ -225,44 +282,6 @@ Api.fs.copy.absolute_path = wrap_node(wrap_explorer_member("clipboard", "copy_ab
 Api.fs.copy.filename = wrap_node(wrap_explorer_member("clipboard", "copy_filename"))
 Api.fs.copy.basename = wrap_node(wrap_explorer_member("clipboard", "copy_basename"))
 Api.fs.copy.relative_path = wrap_node(wrap_explorer_member("clipboard", "copy_path"))
----
----@class NodeEditOpts
----@field quit_on_open boolean|nil default false
----@field focus boolean|nil default true
-
----@param mode string
----@param node Node
----@param edit_opts NodeEditOpts?
-local function edit(mode, node, edit_opts)
-  local file_link = node:as(FileLinkNode)
-  local path = file_link and file_link.link_to or node.absolute_path
-  local cur_tabpage = vim.api.nvim_get_current_tabpage()
-
-  local explorer = core.get_explorer()
-
-  actions.node.open_file.fn(mode, path)
-
-  edit_opts = edit_opts or {}
-
-  local mode_unsupported_quit_on_open = mode == "drop" or mode == "tab_drop" or mode == "edit_in_place"
-  if not mode_unsupported_quit_on_open and edit_opts.quit_on_open then
-    if explorer then
-      explorer.view:close(cur_tabpage, "api.edit " .. mode)
-    end
-  end
-
-  local mode_unsupported_focus = mode == "drop" or mode == "tab_drop" or mode == "edit_in_place"
-  local focus = edit_opts.focus == nil or edit_opts.focus == true
-  if not mode_unsupported_focus and not focus then
-    -- if mode == "tabnew" a new tab will be opened and we need to focus back to the previous tab
-    if mode == "tabnew" then
-      vim.cmd(":tabprev")
-    end
-    if explorer then
-      explorer.view:focus()
-    end
-  end
-end
 
 ---@param mode string
 ---@param toggle_group boolean?