docs(#3088): extract api/node.lua functions, doc TODO

Author: alex-courtis

doc/nvim-tree-lua.txt

@@ -158,36 +158,6 @@ Show the mappings:  `g?`
 ==============================================================================
 Quickstart: Custom Mappings             *nvim-tree-quickstart-custom-mappings*
 
-
-
-
-TODO #3088 remove dummy tags once entire API has been migrated
-
-*nvim_tree.api.node.navigate.diagnostics.next()*
-*nvim_tree.api.node.navigate.diagnostics.prev()*
-*nvim_tree.api.node.navigate.git.next()*
-*nvim_tree.api.node.navigate.git.prev()*
-*nvim_tree.api.node.navigate.parent()*
-*nvim_tree.api.node.navigate.parent_close()*
-*nvim_tree.api.node.navigate.sibling.first()*
-*nvim_tree.api.node.navigate.sibling.last()*
-*nvim_tree.api.node.navigate.sibling.next()*
-*nvim_tree.api.node.navigate.sibling.prev()*
-*nvim_tree.api.node.open.edit()*
-*nvim_tree.api.node.open.horizontal()*
-*nvim_tree.api.node.open.no_window_picker()*
-*nvim_tree.api.node.open.preview()*
-*nvim_tree.api.node.open.replace_tree_buffer()*
-*nvim_tree.api.node.open.tab()*
-*nvim_tree.api.node.open.toggle_group_empty()*
-*nvim_tree.api.node.open.vertical()*
-*nvim_tree.api.node.run.cmd()*
-*nvim_tree.api.node.run.system()*
-*nvim_tree.api.node.show_info_popup()*
-
-
-
-
 |nvim-tree-mappings-default| are applied by default however you may customise
 via |nvim_tree.Config| {on_attach} e.g. >lua
 
@@ -2949,6 +2919,167 @@ toggle({node})                                  *nvim_tree.api.marks.toggle()*
       • {node}  (`nvim_tree.api.Node`) file or directory
 
 
+==============================================================================
+Lua module: nvim_tree.api.node                            *nvim-tree-api-node*
+
+*nvim_tree.api.DirectoryLinkNode*
+    Extends: |nvim_tree.api.DirectoryNode|
+
+    DirectoryLink
+
+*nvim_tree.api.DirectoryNode*
+    Extends: |nvim_tree.api.Node|
+
+    Directory
+
+    Fields: ~
+      • {has_children}  (`boolean`)
+      • {nodes}         (`nvim_tree.api.Node[]`)
+      • {open}          (`boolean`)
+
+*nvim_tree.api.FileLinkNode*
+    Extends: |nvim_tree.api.FileNode|
+
+    File Link
+
+*nvim_tree.api.FileNode*
+    Extends: |nvim_tree.api.Node|
+
+    File
+
+    Fields: ~
+      • {extension}  (`string`)
+
+*nvim_tree.api.LinkNode*
+    Link mixin
+
+    Fields: ~
+      • {link_to}         (`string`)
+      • {fs_stat_target}  (`uv.fs_stat.result`)
+
+*nvim_tree.api.Node*
+    Base Node, Abstract
+
+    Fields: ~
+      • {type}           (`"file"|"directory"|"link"`) uv.fs_stat.result.type
+      • {absolute_path}  (`string`)
+      • {executable}     (`boolean`)
+      • {fs_stat}        (`uv.fs_stat.result?`)
+      • {git_status}     (`GitNodeStatus?`)
+      • {hidden}         (`boolean`)
+      • {name}           (`string`)
+      • {parent}         (`nvim_tree.api.DirectoryNode?`)
+      • {diag_severity}  (`lsp.DiagnosticSeverity?`)
+
+*nvim_tree.api.RootNode*
+    Extends: |nvim_tree.api.DirectoryNode|
+
+    Root Directory
+
+
+nvim_tree.api.node.buffer.delete()        *nvim_tree.api.node.buffer.delete()*
+
+nvim_tree.api.node.buffer.wipe()            *nvim_tree.api.node.buffer.wipe()*
+
+nvim_tree.api.node.collapse()                  *nvim_tree.api.node.collapse()*
+
+nvim_tree.api.node.expand()                      *nvim_tree.api.node.expand()*
+
+                              *nvim_tree.api.node.navigate.diagnostics.next()*
+nvim_tree.api.node.navigate.diagnostics.next()
+
+                    *nvim_tree.api.node.navigate.diagnostics.next_recursive()*
+nvim_tree.api.node.navigate.diagnostics.next_recursive()
+
+                              *nvim_tree.api.node.navigate.diagnostics.prev()*
+nvim_tree.api.node.navigate.diagnostics.prev()
+
+                    *nvim_tree.api.node.navigate.diagnostics.prev_recursive()*
+nvim_tree.api.node.navigate.diagnostics.prev_recursive()
+
+                                      *nvim_tree.api.node.navigate.git.next()*
+nvim_tree.api.node.navigate.git.next()
+
+                            *nvim_tree.api.node.navigate.git.next_recursive()*
+nvim_tree.api.node.navigate.git.next_recursive()
+
+                      *nvim_tree.api.node.navigate.git.next_skip_gitignored()*
+nvim_tree.api.node.navigate.git.next_skip_gitignored()
+
+                                      *nvim_tree.api.node.navigate.git.prev()*
+nvim_tree.api.node.navigate.git.prev()
+
+                            *nvim_tree.api.node.navigate.git.prev_recursive()*
+nvim_tree.api.node.navigate.git.prev_recursive()
+
+                      *nvim_tree.api.node.navigate.git.prev_skip_gitignored()*
+nvim_tree.api.node.navigate.git.prev_skip_gitignored()
+
+                                   *nvim_tree.api.node.navigate.opened.next()*
+nvim_tree.api.node.navigate.opened.next()
+
+                                   *nvim_tree.api.node.navigate.opened.prev()*
+nvim_tree.api.node.navigate.opened.prev()
+
+                                        *nvim_tree.api.node.navigate.parent()*
+nvim_tree.api.node.navigate.parent()
+
+                                  *nvim_tree.api.node.navigate.parent_close()*
+nvim_tree.api.node.navigate.parent_close()
+
+                                 *nvim_tree.api.node.navigate.sibling.first()*
+nvim_tree.api.node.navigate.sibling.first()
+
+                                  *nvim_tree.api.node.navigate.sibling.last()*
+nvim_tree.api.node.navigate.sibling.last()
+
+                                  *nvim_tree.api.node.navigate.sibling.next()*
+nvim_tree.api.node.navigate.sibling.next()
+
+                                  *nvim_tree.api.node.navigate.sibling.prev()*
+nvim_tree.api.node.navigate.sibling.prev()
+
+nvim_tree.api.node.open.drop()                *nvim_tree.api.node.open.drop()*
+
+nvim_tree.api.node.open.edit()                *nvim_tree.api.node.open.edit()*
+
+                                        *nvim_tree.api.node.open.horizontal()*
+nvim_tree.api.node.open.horizontal()
+
+                              *nvim_tree.api.node.open.horizontal_no_picker()*
+nvim_tree.api.node.open.horizontal_no_picker()
+
+                                  *nvim_tree.api.node.open.no_window_picker()*
+nvim_tree.api.node.open.no_window_picker()
+
+nvim_tree.api.node.open.preview()          *nvim_tree.api.node.open.preview()*
+
+                                 *nvim_tree.api.node.open.preview_no_picker()*
+nvim_tree.api.node.open.preview_no_picker()
+
+                               *nvim_tree.api.node.open.replace_tree_buffer()*
+nvim_tree.api.node.open.replace_tree_buffer()
+
+nvim_tree.api.node.open.tab()                  *nvim_tree.api.node.open.tab()*
+
+nvim_tree.api.node.open.tab_drop()        *nvim_tree.api.node.open.tab_drop()*
+
+                                *nvim_tree.api.node.open.toggle_group_empty()*
+nvim_tree.api.node.open.toggle_group_empty()
+
+nvim_tree.api.node.open.vertical()        *nvim_tree.api.node.open.vertical()*
+
+                                *nvim_tree.api.node.open.vertical_no_picker()*
+nvim_tree.api.node.open.vertical_no_picker()
+
+nvim_tree.api.node.run.cmd()                    *nvim_tree.api.node.run.cmd()*
+
+nvim_tree.api.node.run.system()              *nvim_tree.api.node.run.system()*
+
+                                        *nvim_tree.api.node.show_info_popup()*
+nvim_tree.api.node.show_info_popup()
+
+
 ==============================================================================
 Lua module: nvim_tree.api.tree                            *nvim-tree-api-tree*
 

lua/nvim-tree/_meta/api.lua

@@ -5,41 +5,6 @@ error("Cannot require a meta file")
 -- Nodes
 --
 
----Base Node, Abstract
----@class (exact) nvim_tree.api.Node
----@field type "file" | "directory" | "link" uv.fs_stat.result.type
----@field absolute_path string
----@field executable boolean
----@field fs_stat uv.fs_stat.result?
----@field git_status GitNodeStatus?
----@field hidden boolean
----@field name string
----@field parent nvim_tree.api.DirectoryNode?
----@field diag_severity lsp.DiagnosticSeverity?
-
----File
----@class (exact) nvim_tree.api.FileNode: nvim_tree.api.Node
----@field extension string
-
----Directory
----@class (exact) nvim_tree.api.DirectoryNode: nvim_tree.api.Node
----@field has_children boolean
----@field nodes nvim_tree.api.Node[]
----@field open boolean
-
----Root Directory
----@class (exact) nvim_tree.api.RootNode: nvim_tree.api.DirectoryNode
-
----Link mixin
----@class (exact) nvim_tree.api.LinkNode
----@field link_to string
----@field fs_stat_target uv.fs_stat.result
-
----File Link
----@class (exact) nvim_tree.api.FileLinkNode: nvim_tree.api.FileNode, nvim_tree.api.LinkNode
-
----DirectoryLink
----@class (exact) nvim_tree.api.DirectoryLinkNode: nvim_tree.api.DirectoryNode, nvim_tree.api.LinkNode
 
 --
 -- Various Types

lua/nvim-tree/api.lua

@@ -16,17 +16,17 @@ local UserDecorator = require("nvim-tree.renderer.decorator.user")
 
 local Api = {
   -- tree = {},
-  node = {
-    navigate = {
-      sibling = {},
-      git = {},
-      diagnostics = {},
-      opened = {},
-    },
-    run = {},
-    open = {},
-    buffer = {},
-  },
+  -- node = {
+  --   navigate = {
+  --     sibling = {},
+  --     git = {},
+  --     diagnostics = {},
+  --     opened = {},
+  --   },
+  --   run = {},
+  --   open = {},
+  --   buffer = {},
+  -- },
   -- events = {},
   -- marks = {
   --   bulk = {},
@@ -40,7 +40,7 @@ local Api = {
   -- config = {
   --   mappings = {},
   -- },
-  commands = {},
+  -- commands = {},
   -- diagnostics = {},
   decorator = {},
 }
@@ -308,6 +308,9 @@ local function open_or_expand_or_dir_up(mode, toggle_group)
   end
 end
 
+function Api.hydrate_node(n)
+  Api.node = n
+
 Api.node.open.edit = wrap_node(open_or_expand_or_dir_up("edit"))
 Api.node.open.drop = wrap_node(open_or_expand_or_dir_up("drop"))
 Api.node.open.tab_drop = wrap_node(open_or_expand_or_dir_up("tab_drop"))
@@ -358,6 +361,8 @@ Api.node.buffer.wipe = wrap_node(function(node, opts)
   actions.node.buffer.wipe(node, opts)
 end)
 
+end
+
 -- Api.git.reload = wrap_explorer("reload_git")
 
 function Api.hydrate_events(ev)

lua/nvim-tree/api/init.lua

@@ -5,5 +5,6 @@ return {
   health = require("nvim-tree.api.health"),
   map = require("nvim-tree.api.map"),
   marks = require("nvim-tree.api.marks"),
+  node = require("nvim-tree.api.node"),
   tree = require("nvim-tree.api.tree"),
 }