docs(#3088): collapse node and fs submodules

Author: alex-courtis

doc/nvim-tree-lua.txt

@@ -2494,6 +2494,36 @@ API: fs                                                     *nvim-tree-api-fs*
 clear_clipboard()                         *nvim_tree.api.fs.clear_clipboard()*
     Clear the nvim-tree clipboard.
 
+copy.absolute_path({node})             *nvim_tree.api.fs.copy.absolute_path()*
+    Copy the absolute path to the system clipboard.
+
+    Parameters: ~
+      • {node}  (`nvim_tree.api.Node?`)
+
+copy.basename({node})                       *nvim_tree.api.fs.copy.basename()*
+    Copy the name with extension omitted to the system clipboard.
+
+    Parameters: ~
+      • {node}  (`nvim_tree.api.Node?`)
+
+copy.filename({node})                       *nvim_tree.api.fs.copy.filename()*
+    Copy the name to the system clipboard.
+
+    Parameters: ~
+      • {node}  (`nvim_tree.api.Node?`)
+
+copy.node({node})                               *nvim_tree.api.fs.copy.node()*
+    Copy to the nvim-tree clipboard.
+
+    Parameters: ~
+      • {node}  (`nvim_tree.api.Node?`)
+
+copy.relative_path({node})             *nvim_tree.api.fs.copy.relative_path()*
+    Copy the path relative to the tree root to the system clipboard.
+
+    Parameters: ~
+      • {node}  (`nvim_tree.api.Node?`)
+
 create({node})                                     *nvim_tree.api.fs.create()*
     Prompt to create a file or directory.
 
@@ -2566,40 +2596,6 @@ trash({node})                                       *nvim_tree.api.fs.trash()*
       • {node}  (`nvim_tree.api.Node?`)
 
 
-==============================================================================
-API: fs.copy                                           *nvim-tree-api-fs-copy*
-
-absolute_path({node})                  *nvim_tree.api.fs.copy.absolute_path()*
-    Copy the absolute path to the system clipboard.
-
-    Parameters: ~
-      • {node}  (`nvim_tree.api.Node?`)
-
-basename({node})                            *nvim_tree.api.fs.copy.basename()*
-    Copy the name with extension omitted to the system clipboard.
-
-    Parameters: ~
-      • {node}  (`nvim_tree.api.Node?`)
-
-filename({node})                            *nvim_tree.api.fs.copy.filename()*
-    Copy the name to the system clipboard.
-
-    Parameters: ~
-      • {node}  (`nvim_tree.api.Node?`)
-
-node({node})                                    *nvim_tree.api.fs.copy.node()*
-    Copy to the nvim-tree clipboard.
-
-    Parameters: ~
-      • {node}  (`nvim_tree.api.Node?`)
-
-relative_path({node})                  *nvim_tree.api.fs.copy.relative_path()*
-    Copy the path relative to the tree root to the system clipboard.
-
-    Parameters: ~
-      • {node}  (`nvim_tree.api.Node?`)
-
-
 ==============================================================================
 API: health                                             *nvim-tree-api-health*
 
@@ -2723,154 +2719,134 @@ expand({node}, {opts})                           *nvim_tree.api.node.expand()*
                   Return `true` if `node` should be expanded.
                   `expansion_count` is the total number of folders expanded.
 
-run.cmd({node})                                 *nvim_tree.api.node.run.cmd()*
-    Enter |cmdline| with the full path of the node and the cursor at the start
-    of the line.
-
-    Parameters: ~
-      • {node}  (`nvim_tree.api.Node?`) directory or file
-
-run.system({node})                           *nvim_tree.api.node.run.system()*
-    Execute |nvim_tree.config.system_open|.
-
-    Parameters: ~
-      • {node}  (`nvim_tree.api.Node?`) directory or file
-
-show_info_popup({node})                 *nvim_tree.api.node.show_info_popup()*
-    Open a popup window showing: fullpath, size, accessed, modified, created.
-
-    Parameters: ~
-      • {node}  (`nvim_tree.api.Node?`) directory or file
-
-
-==============================================================================
-API: node.navigate                               *nvim-tree-api-node-navigate*
-
                               *nvim_tree.api.node.navigate.diagnostics.next()*
-diagnostics.next({node})
+navigate.diagnostics.next({node})
     Navigate to the next item showing diagnostic status.
 
     Parameters: ~
       • {node}  (`nvim_tree.api.Node?`) directory or file
 
                     *nvim_tree.api.node.navigate.diagnostics.next_recursive()*
-diagnostics.next_recursive({node})
+navigate.diagnostics.next_recursive({node})
     Navigate to the next item showing diagnostic status, recursively. Needs
     |nvim_tree.config.diagnostics| {show_on_dirs}
 
     Parameters: ~
       • {node}  (`nvim_tree.api.Node?`) directory or file
 
                               *nvim_tree.api.node.navigate.diagnostics.prev()*
-diagnostics.prev({node})
+navigate.diagnostics.prev({node})
     Navigate to the previous item showing diagnostic status.
 
     Parameters: ~
       • {node}  (`nvim_tree.api.Node?`) directory or file
 
                     *nvim_tree.api.node.navigate.diagnostics.prev_recursive()*
-diagnostics.prev_recursive({node})
+navigate.diagnostics.prev_recursive({node})
     Navigate to the previous item showing diagnostic status, recursively.
     Needs |nvim_tree.config.diagnostics| {show_on_dirs}
 
     Parameters: ~
       • {node}  (`nvim_tree.api.Node?`) directory or file
 
-git.next({node})                      *nvim_tree.api.node.navigate.git.next()*
+navigate.git.next({node})             *nvim_tree.api.node.navigate.git.next()*
     Navigate to the next item showing git status.
 
     Parameters: ~
       • {node}  (`nvim_tree.api.Node?`) directory or file
 
                             *nvim_tree.api.node.navigate.git.next_recursive()*
-git.next_recursive({node})
+navigate.git.next_recursive({node})
     Navigate to the next item showing git status, recursively. Needs
     |nvim_tree.config.git| {show_on_dirs}
 
     Parameters: ~
       • {node}  (`nvim_tree.api.Node?`) directory or file
 
                       *nvim_tree.api.node.navigate.git.next_skip_gitignored()*
-git.next_skip_gitignored({node})
+navigate.git.next_skip_gitignored({node})
     Navigate to the next item showing git status, skipping `.gitignore`
 
     Parameters: ~
       • {node}  (`nvim_tree.api.Node?`) directory or file
 
-git.prev({node})                      *nvim_tree.api.node.navigate.git.prev()*
+navigate.git.prev({node})             *nvim_tree.api.node.navigate.git.prev()*
     Navigate to the previous item showing git status.
 
     Parameters: ~
       • {node}  (`nvim_tree.api.Node?`) directory or file
 
                             *nvim_tree.api.node.navigate.git.prev_recursive()*
-git.prev_recursive({node})
+navigate.git.prev_recursive({node})
     Navigate to the previous item showing git status, recursively. Needs
     |nvim_tree.config.git| {show_on_dirs}
 
     Parameters: ~
       • {node}  (`nvim_tree.api.Node?`) directory or file
 
                       *nvim_tree.api.node.navigate.git.prev_skip_gitignored()*
-git.prev_skip_gitignored({node})
+navigate.git.prev_skip_gitignored({node})
     Navigate to the previous item showing git status, skipping `.gitignore`
 
     Parameters: ~
       • {node}  (`nvim_tree.api.Node?`) directory or file
 
-opened.next({node})                *nvim_tree.api.node.navigate.opened.next()*
+                                   *nvim_tree.api.node.navigate.opened.next()*
+navigate.opened.next({node})
     Navigate to the next |bufloaded()| file.
 
     Parameters: ~
       • {node}  (`nvim_tree.api.Node?`) directory or file
 
-opened.prev({node})                *nvim_tree.api.node.navigate.opened.prev()*
+                                   *nvim_tree.api.node.navigate.opened.prev()*
+navigate.opened.prev({node})
     Navigate to the previous |bufloaded()| file.
 
     Parameters: ~
       • {node}  (`nvim_tree.api.Node?`) directory or file
 
-parent({node})                          *nvim_tree.api.node.navigate.parent()*
+navigate.parent({node})                 *nvim_tree.api.node.navigate.parent()*
     Navigate to the parent directory of the node.
 
     Parameters: ~
       • {node}  (`nvim_tree.api.Node?`) directory or file
 
-parent_close({node})              *nvim_tree.api.node.navigate.parent_close()*
+                                  *nvim_tree.api.node.navigate.parent_close()*
+navigate.parent_close({node})
     Navigate to the parent directory of the node, closing it.
 
     Parameters: ~
       • {node}  (`nvim_tree.api.Node?`) directory or file
 
-sibling.first({node})            *nvim_tree.api.node.navigate.sibling.first()*
+                                 *nvim_tree.api.node.navigate.sibling.first()*
+navigate.sibling.first({node})
     Navigate to the first node in the current node's folder.
 
     Parameters: ~
       • {node}  (`nvim_tree.api.Node?`) directory or file
 
-sibling.last({node})              *nvim_tree.api.node.navigate.sibling.last()*
+                                  *nvim_tree.api.node.navigate.sibling.last()*
+navigate.sibling.last({node})
     Navigate to the last node in the current node's folder.
 
     Parameters: ~
       • {node}  (`nvim_tree.api.Node?`) directory or file
 
-sibling.next({node})              *nvim_tree.api.node.navigate.sibling.next()*
+                                  *nvim_tree.api.node.navigate.sibling.next()*
+navigate.sibling.next({node})
     Navigate to the next node in the current node's folder, wraps.
 
     Parameters: ~
       • {node}  (`nvim_tree.api.Node?`) directory or file
 
-sibling.prev({node})              *nvim_tree.api.node.navigate.sibling.prev()*
+                                  *nvim_tree.api.node.navigate.sibling.prev()*
+navigate.sibling.prev({node})
     Navigate to the previous node in the current node's folder, wraps.
 
     Parameters: ~
       • {node}  (`nvim_tree.api.Node?`) directory or file
 
-
-==============================================================================
-API: node.open                                       *nvim-tree-api-node-open*
-
-edit({node}, {opts})                          *nvim_tree.api.node.open.edit()*
+open.edit({node}, {opts})                     *nvim_tree.api.node.open.edit()*
     • file: open as per |nvim_tree.config.actions.open_file|
     • directory: expand or collapse
     • root: change directory up
@@ -2883,7 +2859,7 @@ edit({node}, {opts})                          *nvim_tree.api.node.open.edit()*
                 • {focus}? (`boolean`, default: false) Keep focus in the tree
                   when opening the file.
 
-horizontal({node}, {opts})              *nvim_tree.api.node.open.horizontal()*
+open.horizontal({node}, {opts})         *nvim_tree.api.node.open.horizontal()*
     Open file in a new horizontal split.
 
     Parameters: ~
@@ -2895,7 +2871,7 @@ horizontal({node}, {opts})              *nvim_tree.api.node.open.horizontal()*
                   when opening the file.
 
                               *nvim_tree.api.node.open.horizontal_no_picker()*
-horizontal_no_picker({node}, {opts})
+open.horizontal_no_picker({node}, {opts})
     Open file in a new horizontal split without using the window picker.
 
     Parameters: ~
@@ -2907,7 +2883,7 @@ horizontal_no_picker({node}, {opts})
                   when opening the file.
 
                                   *nvim_tree.api.node.open.no_window_picker()*
-no_window_picker({node}, {opts})
+open.no_window_picker({node}, {opts})
     Open file without using the window picker.
 
     Parameters: ~
@@ -2918,7 +2894,7 @@ no_window_picker({node}, {opts})
                 • {focus}? (`boolean`, default: false) Keep focus in the tree
                   when opening the file.
 
-preview({node}, {opts})                    *nvim_tree.api.node.open.preview()*
+open.preview({node}, {opts})               *nvim_tree.api.node.open.preview()*
     Open file with |'bufhidden'| set to `delete`.
 
     Parameters: ~
@@ -2930,7 +2906,7 @@ preview({node}, {opts})                    *nvim_tree.api.node.open.preview()*
                   when opening the file.
 
                                  *nvim_tree.api.node.open.preview_no_picker()*
-preview_no_picker({node}, {opts})
+open.preview_no_picker({node}, {opts})
     Open file with |'bufhidden'| set to `delete` without using the window
     picker.
 
@@ -2943,13 +2919,13 @@ preview_no_picker({node}, {opts})
                   when opening the file.
 
                                *nvim_tree.api.node.open.replace_tree_buffer()*
-replace_tree_buffer({node})
+open.replace_tree_buffer({node})
     Open file in place: in the nvim-tree window.
 
     Parameters: ~
       • {node}  (`nvim_tree.api.Node?`) file
 
-tab({node}, {opts})                            *nvim_tree.api.node.open.tab()*
+open.tab({node}, {opts})                       *nvim_tree.api.node.open.tab()*
     Open file in a new tab.
 
     Parameters: ~
@@ -2960,15 +2936,15 @@ tab({node}, {opts})                            *nvim_tree.api.node.open.tab()*
                 • {focus}? (`boolean`, default: false) Keep focus in the tree
                   when opening the file.
 
-tab_drop({node})                          *nvim_tree.api.node.open.tab_drop()*
+open.tab_drop({node})                     *nvim_tree.api.node.open.tab_drop()*
     Switch to tab containing window with selected file if it exists. Open file
     in new tab otherwise.
 
     Parameters: ~
       • {node}  (`nvim_tree.api.Node?`) directory or file
 
                                 *nvim_tree.api.node.open.toggle_group_empty()*
-toggle_group_empty({node}, {opts})
+open.toggle_group_empty({node}, {opts})
     Toggle |nvim_tree.config.renderer| {group_empty} for a directory. Needs
     {group_empty} set.
 
@@ -2980,7 +2956,7 @@ toggle_group_empty({node}, {opts})
                 • {focus}? (`boolean`, default: false) Keep focus in the tree
                   when opening the file.
 
-vertical({node}, {opts})                  *nvim_tree.api.node.open.vertical()*
+open.vertical({node}, {opts})             *nvim_tree.api.node.open.vertical()*
     Open file in a new vertical split.
 
     Parameters: ~
@@ -2992,7 +2968,7 @@ vertical({node}, {opts})                  *nvim_tree.api.node.open.vertical()*
                   when opening the file.
 
                                 *nvim_tree.api.node.open.vertical_no_picker()*
-vertical_no_picker({node}, {opts})
+open.vertical_no_picker({node}, {opts})
     Open file in a new vertical split without using the window picker.
 
     Parameters: ~
@@ -3003,6 +2979,25 @@ vertical_no_picker({node}, {opts})
                 • {focus}? (`boolean`, default: false) Keep focus in the tree
                   when opening the file.
 
+run.cmd({node})                                 *nvim_tree.api.node.run.cmd()*
+    Enter |cmdline| with the full path of the node and the cursor at the start
+    of the line.
+
+    Parameters: ~
+      • {node}  (`nvim_tree.api.Node?`) directory or file
+
+run.system({node})                           *nvim_tree.api.node.run.system()*
+    Execute |nvim_tree.config.system_open|.
+
+    Parameters: ~
+      • {node}  (`nvim_tree.api.Node?`) directory or file
+
+show_info_popup({node})                 *nvim_tree.api.node.show_info_popup()*
+    Open a popup window showing: fullpath, size, accessed, modified, created.
+
+    Parameters: ~
+      • {node}  (`nvim_tree.api.Node?`) directory or file
+
 
 ==============================================================================
 API: tree                                                 *nvim-tree-api-tree*