refactor(#3255): ensure all args passed to api, fix incorrectly documented api interface

Author: alex-courtis

lua/nvim-tree/_meta/api/marks.lua

@@ -4,8 +4,9 @@ local nvim_tree = { api = { marks = {} } }
 ---
 ---Return the node if it is marked.
 ---
+---@param node? nvim_tree.api.Node file or directory
 ---@return nvim_tree.api.Node?
-function nvim_tree.api.marks.get() end
+function nvim_tree.api.marks.get(node) end
 
 ---
 ---Retrieve all marked nodes.

lua/nvim-tree/_meta/api/node.lua

@@ -29,36 +29,31 @@ function nvim_tree.api.node.open.edit(node, opts) end
 ---Open file in a new horizontal split.
 ---
 ---@param node? nvim_tree.api.Node file
----@param opts? nvim_tree.api.node.open.Opts optional
-function nvim_tree.api.node.open.horizontal(node, opts) end
+function nvim_tree.api.node.open.horizontal(node) end
 
 ---
 ---Open file in a new horizontal split without using the window picker.
 ---
 ---@param node? nvim_tree.api.Node file
----@param opts? nvim_tree.api.node.open.Opts optional
-function nvim_tree.api.node.open.horizontal_no_picker(node, opts) end
+function nvim_tree.api.node.open.horizontal_no_picker(node) end
 
 ---
 ---Open file without using the window picker.
 ---
 ---@param node? nvim_tree.api.Node file
----@param opts? nvim_tree.api.node.open.Opts optional
-function nvim_tree.api.node.open.no_window_picker(node, opts) end
+function nvim_tree.api.node.open.no_window_picker(node) end
 
 ---
 ---Open file with ['bufhidden'] set to `delete`.
 ---
 ---@param node? nvim_tree.api.Node directory or file
----@param opts? nvim_tree.api.node.open.Opts optional
-function nvim_tree.api.node.open.preview(node, opts) end
+function nvim_tree.api.node.open.preview(node) end
 
 ---
 ---Open file with ['bufhidden'] set to `delete` without using the window picker.
 ---
 ---@param node? nvim_tree.api.Node directory or file
----@param opts? nvim_tree.api.node.open.Opts optional
-function nvim_tree.api.node.open.preview_no_picker(node, opts) end
+function nvim_tree.api.node.open.preview_no_picker(node) end
 
 ---
 ---Open file in place: in the nvim-tree window.
@@ -70,8 +65,7 @@ function nvim_tree.api.node.open.replace_tree_buffer(node) end
 ---Open file in a new tab.
 ---
 ---@param node? nvim_tree.api.Node directory or file
----@param opts? nvim_tree.api.node.open.Opts optional
-function nvim_tree.api.node.open.tab(node, opts) end
+function nvim_tree.api.node.open.tab(node) end
 
 ---
 ---Switch to tab containing window with selected file if it exists. Open file in new tab otherwise.
@@ -83,22 +77,19 @@ function nvim_tree.api.node.open.tab_drop(node) end
 ---Toggle [nvim_tree.config.renderer] {group_empty} for a directory. Needs {group_empty} set.
 ---
 ---@param node? nvim_tree.api.Node directory
----@param opts? nvim_tree.api.node.open.Opts optional
-function nvim_tree.api.node.open.toggle_group_empty(node, opts) end
+function nvim_tree.api.node.open.toggle_group_empty(node) end
 
 ---
 ---Open file in a new vertical split.
 ---
 ---@param node? nvim_tree.api.Node file
----@param opts? nvim_tree.api.node.open.Opts optional
-function nvim_tree.api.node.open.vertical(node, opts) end
+function nvim_tree.api.node.open.vertical(node) end
 
 ---
 ---Open file in a new vertical split without using the window picker.
 ---
 ---@param node? nvim_tree.api.Node file
----@param opts? nvim_tree.api.node.open.Opts optional
-function nvim_tree.api.node.open.vertical_no_picker(node, opts) end
+function nvim_tree.api.node.open.vertical_no_picker(node) end
 
 ---
 ---@class nvim_tree.api.node.buffer.RemoveOpts

lua/nvim-tree/api/impl/post.lua

@@ -122,8 +122,8 @@ function M.hydrate(api)
 
   api.node.buffer.delete                       = _n(function(n, opts) require("nvim-tree.actions").node.buffer.delete(n, opts) end)
   api.node.buffer.wipe                         = _n(function(n, opts) require("nvim-tree.actions").node.buffer.wipe(n, opts) end)
-  api.node.collapse                            = _n(function(n) require("nvim-tree.actions").tree.collapse.node(n) end)
-  api.node.expand                              = en(function(e, n) e:expand_node(n) end)
+  api.node.collapse                            = _n(function(n, opts) require("nvim-tree.actions").tree.collapse.node(n, opts) end)
+  api.node.expand                              = en(function(e, n, opts) e:expand_node(n, opts) end)
   api.node.navigate.diagnostics.next           = __(function() require("nvim-tree.actions").moves.item.diagnostics_next() end)
   api.node.navigate.diagnostics.next_recursive = __(function() require("nvim-tree.actions").moves.item.diagnostics_next_recursive() end)
   api.node.navigate.diagnostics.prev           = __(function() require("nvim-tree.actions").moves.item.diagnostics_prev() end)