doc(#2934): split nvim_tree.Config into files, Sort and HijackDirectories populate others placeholder

Author: alex-courtis

doc/nvim-tree-lua.txt

@@ -3445,7 +3445,7 @@ highlight group is not, hard linking as follows: >
 |nvim-tree-api.tree.winid()|
 
 ==============================================================================
-Lua module: nvim_tree                                       *nvim-tree-module*
+Class: Config                                               *nvim-tree-config*
 
 *nvim_tree.Config*
 
@@ -3780,16 +3780,6 @@ Lua module: nvim_tree                                       *nvim-tree-module*
                     alphabetically by keymap) or `"desc"` (sort alphabetically
                     by description). Default: `"key"`
 
-*nvim_tree.Config.HijackDirectories*
-
-    Fields: ~
-      • {enable}?     (`boolean`, default: `true`) Hijack directory buffers.
-                      Disable this option if you use vim-dirvish or
-                      dirbuf.nvim. If `hijack_netrw` and `disable_netrw` are
-                      `false`, this feature will be disabled.
-      • {auto_open}?  (`boolean`, default: `true`) Opens the tree if the tree
-                      was previously closed.
-
 *nvim_tree.Config.LiveFilter*
     Configurations for the live_filtering feature. The live filter allows you
     to filter the tree nodes dynamically, based on regex matching (see
@@ -4121,33 +4111,6 @@ Lua module: nvim_tree                                       *nvim-tree-module*
       • {bottom}?  (`string`) Default: `"─"`
       • {none}?    (`string`) Default: `" "`
 
-*nvim_tree.Config.Sort*
-
-    Fields: ~
-      • {sorter}?         (`nvim_tree.SortOption|fun(nodes: table): nil`)
-                          Changes how files within the same directory are
-                          sorted. Can be one of `"name"`, `"case_sensitive"`,
-                          `"modification_time"`, `"extension"`, `"suffix"`,
-                          `"filetype"` or a function. `"extension"` uses all
-                          suffixes e.g. `foo.tar.gz` -> `.tar.gz` `"suffix"`
-                          uses the last e.g. `.gz` Default: `"name"` Function
-                          may perform a sort or return a string with one of
-                          the above methods. It is passed a table of nodes to
-                          be sorted, each node containing: - `absolute_path`:
-                          `string` - `executable`: `boolean` - `extension`:
-                          `string` - `filetype`: `string` - `link_to`:
-                          `string` - `name`: `string` - `type`: `"directory"`
-                          | `"file"` | `"link"`
-      • {folders_first}?  (`boolean`) Sort folders before files. Has no effect
-                          when |nvim-tree.sort.sorter| is a function. Default:
-                          `true` @see nvim-tree.sort.sorter
-      • {files_first}?    (`boolean`) Sort files before folders. Has no effect
-                          when |nvim-tree.sort.sorter| is a function. If set
-                          to `true` it overrides
-                          |nvim-tree.sort.folders_first|. Default: `false`
-                          @see nvim-tree.sort.sorter @see
-                          nvim-tree.sort.folders_first
-
 *nvim_tree.Config.SystemOpen*
 
     Fields: ~
@@ -4298,6 +4261,53 @@ Lua module: nvim_tree                                       *nvim-tree-module*
 
 
 
+==============================================================================
+Class: Config.Sort                                     *nvim-tree-config-sort*
+
+*nvim_tree.Config.Sort*
+
+    Fields: ~
+      • {sorter}?         (`nvim_tree.SortOption|fun(nodes: table): nil`)
+                          Changes how files within the same directory are
+                          sorted. Can be one of `"name"`, `"case_sensitive"`,
+                          `"modification_time"`, `"extension"`, `"suffix"`,
+                          `"filetype"` or a function. `"extension"` uses all
+                          suffixes e.g. `foo.tar.gz` -> `.tar.gz` `"suffix"`
+                          uses the last e.g. `.gz` Default: `"name"` Function
+                          may perform a sort or return a string with one of
+                          the above methods. It is passed a table of nodes to
+                          be sorted, each node containing: - `absolute_path`:
+                          `string` - `executable`: `boolean` - `extension`:
+                          `string` - `filetype`: `string` - `link_to`:
+                          `string` - `name`: `string` - `type`: `"directory"`
+                          | `"file"` | `"link"`
+      • {folders_first}?  (`boolean`) Sort folders before files. Has no effect
+                          when |nvim-tree.sort.sorter| is a function. Default:
+                          `true` @see nvim-tree.sort.sorter
+      • {files_first}?    (`boolean`) Sort files before folders. Has no effect
+                          when |nvim-tree.sort.sorter| is a function. If set
+                          to `true` it overrides
+                          |nvim-tree.sort.folders_first|. Default: `false`
+                          @see nvim-tree.sort.sorter @see
+                          nvim-tree.sort.folders_first
+
+
+
+==============================================================================
+Class: Config.HijackDirectories          *nvim-tree-config-hijack-directories*
+
+*nvim_tree.Config.HijackDirectories*
+
+    Fields: ~
+      • {enable}?     (`boolean`, default: `true`) Hijack directory buffers.
+                      Disable this option if you use vim-dirvish or
+                      dirbuf.nvim. If `hijack_netrw` and `disable_netrw` are
+                      `false`, this feature will be disabled.
+      • {auto_open}?  (`boolean`, default: `true`) Opens the tree if the tree
+                      was previously closed.
+
+
+
 ==============================================================================
 Lua module: nvim_tree.api                                      *nvim-tree-api*
 

lua/nvim-tree/_meta/config/actions.lua

@@ -0,0 +1,2 @@
+---@meta
+error("Cannot require a meta file")

lua/nvim-tree/_meta/config.lua lua/nvim-tree/_meta/config/config.lualua/nvim-tree/_meta/config.lua renamed to lua/nvim-tree/_meta/config/config.lua

@@ -126,20 +126,6 @@ error("Cannot require a meta file")
 ---|nvim_tree.Config.Log|
 ---@field log? nvim_tree.Config.Log
 
---
--- HijackDirectories
---
-
----@class nvim_tree.Config.HijackDirectories
----
----Hijack directory buffers. Disable this option if you use vim-dirvish or dirbuf.nvim. If `hijack_netrw` and `disable_netrw` are `false`, this feature will be disabled.
----(default: `true`)
----@field enable? boolean
----
----Opens the tree if the tree was previously closed.
----(default: `true`)
----@field auto_open? boolean
-
 --
 -- Renderer
 --
@@ -339,15 +325,6 @@ error("Cannot require a meta file")
 ---@class nvim_tree.Config.Help
 ---@field sort_by? nvim_tree.HelpSortOption Defines how mappings are sorted in the help window. Can be `"key"` (sort alphabetically by keymap) or `"desc"` (sort alphabetically by description). Default: `"key"`
 
---
--- Sort
---
-
----@class nvim_tree.Config.Sort
----@field sorter? nvim_tree.SortOption|fun(nodes: table): nil Changes how files within the same directory are sorted. Can be one of `"name"`, `"case_sensitive"`, `"modification_time"`, `"extension"`, `"suffix"`, `"filetype"` or a function. `"extension"` uses all suffixes e.g. `foo.tar.gz` -> `.tar.gz` `"suffix"` uses the last e.g. `.gz` Default: `"name"` Function may perform a sort or return a string with one of the above methods. It is passed a table of nodes to be sorted, each node containing: - `absolute_path`: `string` - `executable`: `boolean` - `extension`: `string` - `filetype`: `string` - `link_to`: `string` - `name`: `string` - `type`: `"directory"` | `"file"` | `"link"`
----@field folders_first? boolean Sort folders before files. Has no effect when |nvim-tree.sort.sorter| is a function. Default: `true` @see nvim-tree.sort.sorter
----@field files_first? boolean Sort files before folders. Has no effect when |nvim-tree.sort.sorter| is a function. If set to `true` it overrides |nvim-tree.sort.folders_first|. Default: `false` @see nvim-tree.sort.sorter @see nvim-tree.sort.folders_first
-
 --
 -- Filters
 --

lua/nvim-tree/_meta/config/diagnostics.lua

@@ -0,0 +1,2 @@
+---@meta
+error("Cannot require a meta file")

lua/nvim-tree/_meta/config/filesystem_watchers.lua

@@ -0,0 +1,2 @@
+---@meta
+error("Cannot require a meta file")

lua/nvim-tree/_meta/config/filters.lua

@@ -0,0 +1,2 @@
+---@meta
+error("Cannot require a meta file")

lua/nvim-tree/_meta/config/git.lua

@@ -0,0 +1,3 @@
+---@meta
+error("Cannot require a meta file")
+

lua/nvim-tree/_meta/config/help.lua

@@ -0,0 +1,2 @@
+---@meta
+error("Cannot require a meta file")

lua/nvim-tree/_meta/config/hijack_directories.lua

@@ -0,0 +1,12 @@
+---@meta
+error("Cannot require a meta file")
+
+---@class nvim_tree.Config.HijackDirectories
+---
+---Hijack directory buffers. Disable this option if you use vim-dirvish or dirbuf.nvim. If `hijack_netrw` and `disable_netrw` are `false`, this feature will be disabled.
+---(default: `true`)
+---@field enable? boolean
+---
+---Opens the tree if the tree was previously closed.
+---(default: `true`)
+---@field auto_open? boolean

lua/nvim-tree/_meta/config/live_filter.lua

@@ -0,0 +1,2 @@
+---@meta
+error("Cannot require a meta file")