docs(#3088): old api is now impl, use new api

Author: alex-courtis

doc/nvim-tree-lua.txt

@@ -2647,6 +2647,18 @@ toggle({node})                                  *nvim_tree.api.marks.toggle()*
 ==============================================================================
 Lua module: nvim_tree.api.node                            *nvim-tree-api-node*
 
+*ApiNodeDeleteWipeBufferOpts*
+
+    Fields: ~
+      • {force}  (`boolean?`) default false
+
+*NodeEditOpts*
+
+    Fields: ~
+      • {quit_on_open}  (`boolean?`) default false
+      • {focus}         (`boolean?`) default true
+
+
 nvim_tree.api.node.buffer.delete()        *nvim_tree.api.node.buffer.delete()*
 
 nvim_tree.api.node.buffer.wipe()            *nvim_tree.api.node.buffer.wipe()*
@@ -2911,6 +2923,9 @@ toggle({opts})                                   *nvim_tree.api.tree.toggle()*
                   |window-ID|, overrides {current_window}
                 • {find_file}? (`boolean`, default: false) Find the current
                   buffer.
+                • {update_root}? (`boolean`, default: false) Update root
+                  following {find_file}, see
+                  |nvim_tree.Config.UpdateFocusedFile| {update_root}
                 • {focus}? (`boolean`, default: true) Focus the tree when
                   opening.
 

lua/nvim-tree.lua

@@ -793,9 +793,6 @@ function M.setup(conf)
 
   vim.g.NvimTreeSetup = 1
   vim.api.nvim_exec_autocmds("User", { pattern = "NvimTreeSetup" })
-
-  -- TODO #3088 remove this bootstrap once api/init.lua replaces old api.lua
-  require("nvim-tree.api.init")
 end
 
 vim.g.NvimTreeRequired = 1

lua/nvim-tree/_meta/api.lua

@@ -12,6 +12,11 @@ local nvim_tree = { api = { decorator = {} } }
 ---Names of builtin decorators or your decorator classes. Builtins are ordered lowest to highest priority.
 ---@alias nvim_tree.api.decorator.Name "Git" | "Opened" | "Hidden" | "Modified" | "Bookmarks" | "Diagnostics" | "Copied" | "Cut" | nvim_tree.api.decorator.UserDecorator
 
+---A string for rendering, with optional highlight groups to apply to it
+---@class (exact) nvim_tree.api.HighlightedString
+---@field str string
+---@field hl string[]
+
 ---Custom decorator, see :help nvim-tree-decorators
 ---
 ---@class (exact) nvim_tree.api.decorator.UserDecorator

lua/nvim-tree/_meta/api_decorator.lua

@@ -6,7 +6,7 @@ local finders_find_file = require("nvim-tree.actions.finders.find-file")
 local M = {}
 
 --- Find file or buffer
----@param opts ApiTreeFindFileOpts|nil|boolean legacy -> opts.buf
+---@param opts nvim_tree.api.tree.find_file.Opts|nil|boolean legacy -> opts.buf
 function M.fn(opts)
   -- legacy arguments
   if type(opts) == "string" then

lua/nvim-tree/actions/tree/find-file.lua

@@ -26,7 +26,7 @@ end
 
 ---Collapse a node, root if nil
 ---@param node Node?
----@param opts ApiCollapseOpts
+---@param opts nvim_tree.api.tree.collapse.Opts
 local function collapse(node, opts)
   local explorer = core.get_explorer()
   if not explorer then
@@ -60,7 +60,7 @@ local function collapse(node, opts)
 end
 
 
----@param opts ApiCollapseOpts|boolean|nil legacy -> opts.keep_buffers
+---@param opts nvim_tree.api.tree.collapse.Opts|boolean|nil legacy -> opts.keep_buffers
 function M.all(opts)
   -- legacy arguments
   if type(opts) == "boolean" then
@@ -73,7 +73,7 @@ function M.all(opts)
 end
 
 ---@param node Node
----@param opts ApiCollapseOpts?
+---@param opts nvim_tree.api.tree.collapse.Opts?
 function M.node(node, opts)
   collapse(node, opts or {})
 end

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

@@ -125,7 +125,7 @@ local function gen_iterator(should_descend)
 end
 
 ---@param node Node?
----@param expand_opts ApiTreeExpandOpts?
+---@param expand_opts nvim_tree.api.tree.expand.Opts?
 local function expand_node(node, expand_opts)
   if not node then
     return
@@ -141,14 +141,14 @@ end
 
 ---Expand the directory node or the root
 ---@param node Node
----@param expand_opts ApiTreeExpandOpts?
+---@param expand_opts nvim_tree.api.tree.expand.Opts?
 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
----@param expand_opts ApiTreeExpandOpts?
+---@param expand_opts nvim_tree.api.tree.expand.Opts?
 function M.node(node, expand_opts)
   if not node then
     return

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

@@ -5,7 +5,7 @@ local finders_find_file = require("nvim-tree.actions.finders.find-file")
 local M = {}
 
 ---Open the tree, focusing if already open.
----@param opts ApiTreeOpenOpts|nil|string legacy -> opts.path
+---@param opts nvim_tree.api.tree.open.Opts|nil|string legacy -> opts.path
 function M.fn(opts)
   -- legacy arguments
   if type(opts) == "string" then

lua/nvim-tree/actions/tree/open.lua

@@ -3,7 +3,7 @@ local view = require("nvim-tree.view")
 local M = {}
 
 ---Resize the tree, persisting the new size.
----@param opts ApiTreeResizeOpts|nil
+---@param opts nvim_tree.api.tree.resize.Opts|nil
 function M.fn(opts)
   if opts == nil then
     -- reset to config values

lua/nvim-tree/actions/tree/resize.lua

@@ -5,7 +5,7 @@ local finders_find_file = require("nvim-tree.actions.finders.find-file")
 local M = {}
 
 ---Toggle the tree.
----@param opts ApiTreeToggleOpts|nil|boolean legacy -> opts.find_file
+---@param opts nvim_tree.api.tree.toggle.Opts|nil|boolean legacy -> opts.find_file
 ---@param no_focus string|nil legacy -> opts.focus
 ---@param cwd boolean|nil legacy -> opts.path
 ---@param bang boolean|nil legacy -> opts.update_root