Add documentation

Author: ghostbuster91

doc/nvim-tree-lua.txt

@@ -1808,10 +1808,29 @@ tree.collapse_all({keep_buffers})          *nvim-tree-api.tree.collapse_all()*
     Parameters: ~
       • {keep_buffers} (boolean) do not collapse nodes with open buffers.
 
-tree.expand_all()                            *nvim-tree-api.tree.expand_all()*
+tree.expand_all({opts})                      *nvim-tree-api.tree.expand_all()*
     Recursively expand all nodes in the tree.
     Folder: only the nodes underneath that folder.
 
+    Parameters: ~
+      • {opts} (table) optional parameters
+
+    Options: ~
+      • {expand_until} (function) A function returning boolean that 
+        specifies terminating condition for node/tree expansion. If not
+        provided the function that expands recursively entire node/tree will be
+        used.
+        Example: >
+
+        -- expand only 5 levels deep
+        local function my_expand(expansion_count, node)
+          local should_halt = expansion_count >= 5
+          return not should_halt
+        end
+
+        -- on_attach
+        vim.keymap.set('n', 'Z', api.tree.expand_all(node, { expand_until = my_expand }))
+<
                                   *nvim-tree-api.tree.toggle_enable_filters()*
 tree.toggle_enable_filters()
     Toggle |nvim-tree.filters.enable| all filters.

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

@@ -39,8 +39,7 @@ end
 local function expand_until_max_or_empty(expansion_count, node)
   local should_halt = expansion_count >= M.MAX_FOLDER_DISCOVERY
   local should_exclude = M.EXCLUDE[node.name]
-  local result = not should_halt and node.nodes and not node.open and not should_exclude
-  return result
+  return not should_halt and node.nodes and not node.open and not should_exclude
 end
 
 local function gen_iterator(should_expand_fn)
@@ -74,8 +73,9 @@ local function gen_iterator(should_expand_fn)
 end
 
 ---@param base_node table
-function M.fn(base_node, expand_until)
-  expand_until = expand_until or expand_until_max_or_empty
+---@param expand_opts ApiTreeExpandAllOpts|nil
+function M.fn(base_node, expand_opts)
+  local expand_until = (expand_opts and expand_opts.expand_until) or expand_until_max_or_empty
   local node = base_node.nodes and base_node or core.get_explorer()
   if gen_iterator(expand_until)(node) then
     notify.warn("expansion iteration was halted after " .. M.MAX_FOLDER_DISCOVERY .. " discovered folders")

lua/nvim-tree/api.lua

@@ -144,7 +144,12 @@ Api.tree.get_nodes = wrap(lib.get_nodes)
 Api.tree.find_file = wrap(actions.tree.find_file.fn)
 Api.tree.search_node = wrap(actions.finders.search_node.fn)
 Api.tree.collapse_all = wrap(actions.tree.modifiers.collapse_all.fn)
+
+---@class ApiTreeExpandAllOpts
+---@field expand_until function|nil
+
 Api.tree.expand_all = wrap_node(actions.tree.modifiers.expand_all.fn)
+
 Api.tree.toggle_enable_filters = wrap(actions.tree.modifiers.toggles.enable)
 Api.tree.toggle_gitignore_filter = wrap(actions.tree.modifiers.toggles.git_ignored)
 Api.tree.toggle_git_clean_filter = wrap(actions.tree.modifiers.toggles.git_clean)