luals types for expand_until, rename variable for consistency

Author: alex-courtis

doc/nvim-tree-lua.txt

@@ -1816,7 +1816,8 @@ tree.expand_all({opts})                      *nvim-tree-api.tree.expand_all()*
       • {opts} (table) optional parameters
 
     Options: ~
-      • {expand_until} (function) A function returning boolean that 
+      • {expand_until} (fun(expansion_count: integer, node: Node): boolean)
+        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.

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

@@ -42,7 +42,8 @@ local function expand_until_max_or_empty(expansion_count, node)
   return not should_halt and node.nodes and not node.open and not should_exclude
 end
 
-local function gen_iterator(should_expand)
+---@param expand_until fun(expansion_count: integer, node: Node): boolean
+local function gen_iterator(expand_until)
   local expansion_count = 0
   local function expand(node)
     populate_node(node)
@@ -59,13 +60,13 @@ local function gen_iterator(should_expand)
     Iterator.builder(parent.nodes)
       :hidden()
       :applier(function(node)
-        if should_expand(expansion_count, node, populate_node) then
+        if expand_until(expansion_count, node, populate_node) then
           expansion_count = expansion_count + 1
           expand(node)
         end
       end)
       :recursor(function(node)
-        local should_recurse = should_expand(expansion_count - 1, node, populate_node)
+        local should_recurse = expand_until(expansion_count - 1, node, populate_node)
         return expansion_count < M.MAX_FOLDER_DISCOVERY and should_recurse and node.nodes
       end)
       :iterate()

lua/nvim-tree/api.lua

@@ -146,7 +146,7 @@ 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
+---@field expand_until (fun(expansion_count: integer, node: Node): boolean)|nil
 
 Api.tree.expand_all = wrap_node(actions.tree.modifiers.expand_all.fn)