use Node everywhere in luadoc

Author: alex-courtis

lua/nvim-tree/actions/fs/create-file.lua

@@ -39,7 +39,7 @@ local function get_containing_folder(node)
   return node.absolute_path:sub(0, -node_name_size - 1)
 end
 
----@param node Node|nil
+---@param node Node?
 function M.fn(node)
   local cwd = core.get_cwd()
   if cwd == nil then

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

@@ -61,10 +61,10 @@ local function gen_iterator()
   end
 end
 
----@param base_node table
-function M.fn(base_node)
+---@param node Node
+function M.fn(node)
   local explorer = core.get_explorer()
-  local node = base_node.nodes and base_node or explorer
+  node = node.nodes and node or explorer
   if gen_iterator()(node) then
     notify.warn("expansion iteration was halted after " .. M.MAX_FOLDER_DISCOVERY .. " discovered folders")
   end

lua/nvim-tree/api.lua

@@ -198,7 +198,7 @@ Api.fs.copy.basename = wrap_node(wrap_explorer_member("clipboard", "copy_basenam
 Api.fs.copy.relative_path = wrap_node(wrap_explorer_member("clipboard", "copy_path"))
 
 ---@param mode string
----@param node table
+---@param node Node
 local function edit(mode, node)
   local path = node.absolute_path
   if node.link_to and not node.nodes then

lua/nvim-tree/buffers.lua

@@ -21,7 +21,7 @@ function M.reload_modified()
   end
 end
 
----@param node table
+---@param node Node
 ---@return boolean
 function M.is_modified(node)
   return node
@@ -32,7 +32,7 @@ function M.is_modified(node)
 end
 
 ---A buffer exists for the node's absolute path
----@param node table
+---@param node Node
 ---@return boolean
 function M.is_opened(node)
   return node and vim.fn.bufloaded(node.absolute_path) > 0

lua/nvim-tree/explorer/init.lua

@@ -228,7 +228,7 @@ function Explorer:_load(node)
 end
 
 ---@private
----@param nodes_by_path table
+---@param nodes_by_path Node[]
 ---@param node_ignored boolean
 ---@param status table|nil
 ---@return fun(node: Node): table

lua/nvim-tree/explorer/live-filter.lua

@@ -23,7 +23,7 @@ function LiveFilter:new(opts, explorer)
   return o
 end
 
----@param node_ Node|nil
+---@param node_ Node?
 local function reset_filter(self, node_)
   node_ = node_ or self.explorer
 
@@ -85,7 +85,7 @@ local function matches(self, node)
   return vim.regex(self.filter):match_str(name) ~= nil
 end
 
----@param node_ Node|nil
+---@param node_ Node?
 function LiveFilter:apply_filter(node_)
   if not self.filter or self.filter == "" then
     reset_filter(self, node_)

lua/nvim-tree/explorer/sorters.lua

@@ -111,7 +111,7 @@ local function split_merge(t, first, last, comparator)
 end
 
 ---Perform a merge sort using sorter option.
----@param t table nodes
+---@param t Node[]
 function Sorter:sort(t)
   if self.user then
     local t_user = {}

lua/nvim-tree/lib.lua

@@ -42,8 +42,9 @@ function M.get_node_at_cursor()
   return utils.get_nodes_by_line(core.get_explorer().nodes, core.get_nodes_starting_line())[cursor[1]]
 end
 
+---TODO move to node
 ---Create a sanitized partial copy of a node, populating children recursively.
----@param node Node|nil
+---@param node Node?
 ---@return Node|nil cloned node
 local function clone_node(node)
   if not node then
@@ -83,6 +84,7 @@ function M.get_nodes()
   return clone_node(core.get_explorer())
 end
 
+---TODO move to node
 ---Group empty folders
 -- Recursively group nodes
 ---@param node Node
@@ -99,6 +101,7 @@ function M.group_empty_folders(node)
   return node.nodes
 end
 
+---TODO move to node
 ---Ungroup empty folders
 -- If a node is grouped, ungroup it: put node.group_next to the node.nodes and set node.group_next to nil
 ---@param node Node
@@ -111,6 +114,7 @@ function M.ungroup_empty_folders(node)
   end
 end
 
+---TODO move to node
 ---@param node Node
 ---@return Node[]
 function M.get_all_nodes_in_group(node)
@@ -123,6 +127,7 @@ function M.get_all_nodes_in_group(node)
   return nodes
 end
 
+---TODO move to node
 -- Toggle group empty folders
 ---@param head_node Node
 local function toggle_group_folders(head_node)
@@ -135,6 +140,7 @@ local function toggle_group_folders(head_node)
   end
 end
 
+---TODO move to node
 ---@param node Node
 function M.expand_or_collapse(node, toggle_group)
   local explorer = core.get_explorer()

lua/nvim-tree/log.lua

@@ -71,7 +71,7 @@ end
 --- Write to log file the inspection of a node
 --- defaults to the node under cursor if none is provided
 ---@param typ string as per log.types config
----@param node table|nil node to be inspected
+---@param node Node? node to be inspected
 ---@param fmt string for string.format
 ---@vararg any arguments for string.format
 function M.node(typ, node, fmt, ...)

lua/nvim-tree/node/init.lua

@@ -21,7 +21,7 @@ local BaseNode = {}
 
 ---@alias Node RootNode|BaseNode|DirectoryNode|FileNode|LinkNode
 
----@param o BaseNode|nil
+---@param o BaseNode?
 ---@return BaseNode
 function BaseNode:new(o)
   o = o or {}

lua/nvim-tree/renderer/builder.lua

@@ -189,7 +189,7 @@ function Builder:build_symlink(node)
 end
 
 ---@private
----@param node table
+---@param node Node
 ---@return HighlightedString icon
 ---@return HighlightedString name
 function Builder:build_file(node)

lua/nvim-tree/renderer/components/diagnostics.lua

@@ -14,7 +14,7 @@ local M = {
 }
 
 ---Diagnostics highlight group and position when highlight_diagnostics.
----@param node table
+---@param node Node
 ---@return HL_POSITION position none when no status
 ---@return string|nil group only when status
 function M.get_highlight(node)
@@ -38,7 +38,7 @@ function M.get_highlight(node)
 end
 
 ---diagnostics icon if there is a status
----@param node table
+---@param node Node
 ---@return HighlightedString|nil modified icon
 function M.get_icon(node)
   if node and M.config.diagnostics.enable and M.config.renderer.icons.show.diagnostics then

lua/nvim-tree/renderer/components/padding.lua

@@ -59,7 +59,7 @@ end
 ---@param depth integer
 ---@param idx integer
 ---@param nodes_number integer
----@param node table
+---@param node Node
 ---@param markers table
 ---@return HighlightedString[]
 function M.get_indent_markers(depth, idx, nodes_number, node, markers, early_stop)
@@ -79,7 +79,7 @@ function M.get_indent_markers(depth, idx, nodes_number, node, markers, early_sto
   return { str = str, hl = { "NvimTreeIndentMarker" } }
 end
 
----@param node table
+---@param node Node
 ---@return HighlightedString[]|nil
 function M.get_arrows(node)
   if not M.config.icons.show.folder_arrow then

lua/nvim-tree/utils.lua

@@ -120,7 +120,7 @@ end
 
 -- Find the line number of a node.
 -- Return -1 is node is nil or not found.
----@param node Node|nil
+---@param node Node?
 ---@return integer
 function M.find_node_line(node)
   if not node then
@@ -472,7 +472,7 @@ end
 ---Focus node passed as parameter if visible, otherwise focus first visible parent.
 ---If none of the parents is visible focus root.
 ---If node is nil do nothing.
----@param node Node|nil node to focus
+---@param node Node? node to focus
 function M.focus_node_or_parent(node)
   local explorer = require("nvim-tree.core").get_explorer()
 
@@ -548,7 +548,7 @@ function M.array_remove_nils(array)
   end, array)
 end
 
----@param f fun(node: Node|nil)
+---@param f fun(node: Node?)
 ---@return function
 function M.inject_node(f)
   return function()