Skip to content

Commit 7c69cb5

Browse files
alex-courtisalex-courtis
committed
doc(#2934): tidy and correct nvim_tree.Config.HijackDirectories, format and order nvim_tree.Config
1 parent aa24290 commit 7c69cb5

2 files changed

Lines changed: 97 additions & 34 deletions

File tree

‎doc/nvim-tree-lua.txt‎

Lines changed: 38 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -3502,25 +3502,44 @@ Lua module: nvim_tree *nvim-tree-module*
35023502
event of a problem please
35033503
disable the experiment and
35043504
raise an issue.
3505-
• {hijack_directories}? (`nvim_tree.Config.HijackDirectories`)
3506-
• {renderer}? (`nvim_tree.Config.Renderer`)
3507-
• {modified}? (`nvim_tree.Config.Modified`)
3508-
• {tab}? (`nvim_tree.Config.Tab`)
3509-
• {trash}? (`nvim_tree.Config.Trash`)
3510-
• {live_filter}? (`nvim_tree.Config.LiveFilter`)
3511-
• {system_open}? (`nvim_tree.Config.SystemOpen`)
3512-
• {help}? (`nvim_tree.Config.Help`)
35133505
• {sort}? (`nvim_tree.Config.Sort`)
3514-
• {filters}? (`nvim_tree.Config.Filters`)
3506+
|nvim_tree.Config.Sort|
3507+
• {view}? (`nvim_tree.Config.View`)
3508+
|nvim_tree.Config.View|
3509+
• {renderer}? (`nvim_tree.Config.Renderer`)
3510+
|nvim_tree.Config.Renderer|
3511+
• {hijack_directories}? (`nvim_tree.Config.HijackDirectories`)
3512+
|nvim_tree.Config.HijackDirectories|
35153513
• {update_focused_file}? (`nvim_tree.Config.UpdateFocusedFile`)
3514+
|nvim_tree.Config.UpdateFocusedFile|
3515+
• {system_open}? (`nvim_tree.Config.SystemOpen`)
3516+
|nvim_tree.Config.SystemOpen|
35163517
• {git}? (`nvim_tree.Config.Git`)
3518+
|nvim_tree.Config.Git|
35173519
• {diagnostics}? (`nvim_tree.Config.Diagnostics`)
3518-
• {notify}? (`nvim_tree.Config.Notify`)
3520+
|nvim_tree.Config.Diagnostics|
3521+
• {modified}? (`nvim_tree.Config.Modified`)
3522+
|nvim_tree.Config.Modified|
3523+
• {filters}? (`nvim_tree.Config.Filters`)
3524+
|nvim_tree.Config.Filters|
3525+
• {live_filter}? (`nvim_tree.Config.LiveFilter`)
3526+
|nvim_tree.Config.LiveFilter|
35193527
• {filesystem_watchers}? (`nvim_tree.Config.FilesystemWatchers`)
3520-
• {log}? (`nvim_tree.Config.Log`)
3521-
• {ui}? (`nvim_tree.Config.UI`)
3528+
|nvim_tree.Config.FilesystemWatchers|
35223529
• {actions}? (`nvim_tree.Config.Actions`)
3523-
• {view}? (`nvim_tree.Config.View`)
3530+
|nvim_tree.Config.Actions|
3531+
• {trash}? (`nvim_tree.Config.Trash`)
3532+
|nvim_tree.Config.Trash|
3533+
• {tab}? (`nvim_tree.Config.Tab`)
3534+
|nvim_tree.Config.Tab|
3535+
• {notify}? (`nvim_tree.Config.Notify`)
3536+
|nvim_tree.Config.Notify|
3537+
• {help}? (`nvim_tree.Config.Help`)
3538+
|nvim_tree.Config.Help|
3539+
• {ui}? (`nvim_tree.Config.UI`)
3540+
|nvim_tree.Config.UI|
3541+
• {log}? (`nvim_tree.Config.Log`)
3542+
|nvim_tree.Config.Log|
35243543

35253544
*nvim_tree.Config.Actions*
35263545

@@ -3766,12 +3785,12 @@ Lua module: nvim_tree *nvim-tree-module*
37663785
*nvim_tree.Config.HijackDirectories*
37673786

37683787
Fields: ~
3769-
• {enable}? (`boolean`) Enable the feature. Disable this option if
3770-
you use vim-dirvish or dirbuf.nvim. If `hijack_netrw`
3771-
and `disable_netrw` are `false`, this feature will be
3772-
disabled. Default: `true`
3773-
• {auto_open}? (`boolean`) Opens the tree if the tree was previously
3774-
closed. Default: `true`
3788+
• {enable}? (`boolean`, default: `true`) Hijack directory buffers.
3789+
Disable this option if you use vim-dirvish or
3790+
dirbuf.nvim. If `hijack_netrw` and `disable_netrw` are
3791+
`false`, this feature will be disabled.
3792+
• {auto_open}? (`boolean`, default: `true`) Opens the tree if the tree
3793+
was previously closed.
37753794

37763795
*nvim_tree.Config.LiveFilter*
37773796

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

Lines changed: 59 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -33,33 +33,77 @@ error("Cannot require a meta file")
3333
---@field sync_root_with_cwd? boolean Changes the tree root directory on `DirChanged` and refreshes the tree. Default: `false`
3434
---@field root_dirs? string[] Preferred root directories. Only relevant when `update_focused_file.update_root` is `true` Default: `{}` @see nvim-tree.update_focused_file.update_root
3535
---@field experimental? table Experimental features that may become default or optional functionality. In the event of a problem please disable the experiment and raise an issue.
36-
---@field hijack_directories? nvim_tree.Config.HijackDirectories
37-
---@field renderer? nvim_tree.Config.Renderer
38-
---@field modified? nvim_tree.Config.Modified
39-
---@field tab? nvim_tree.Config.Tab
40-
---@field trash? nvim_tree.Config.Trash
41-
---@field live_filter? nvim_tree.Config.LiveFilter
42-
---@field system_open? nvim_tree.Config.SystemOpen
43-
---@field help? nvim_tree.Config.Help
36+
---
37+
---|nvim_tree.Config.Sort|
4438
---@field sort? nvim_tree.Config.Sort
45-
---@field filters? nvim_tree.Config.Filters
39+
---
40+
---|nvim_tree.Config.View|
41+
---@field view? nvim_tree.Config.View
42+
---
43+
---|nvim_tree.Config.Renderer|
44+
---@field renderer? nvim_tree.Config.Renderer
45+
---
46+
---|nvim_tree.Config.HijackDirectories|
47+
---@field hijack_directories? nvim_tree.Config.HijackDirectories
48+
---
49+
---|nvim_tree.Config.UpdateFocusedFile|
4650
---@field update_focused_file? nvim_tree.Config.UpdateFocusedFile
51+
---
52+
---|nvim_tree.Config.SystemOpen|
53+
---@field system_open? nvim_tree.Config.SystemOpen
54+
---
55+
---|nvim_tree.Config.Git|
4756
---@field git? nvim_tree.Config.Git
57+
---
58+
---|nvim_tree.Config.Diagnostics|
4859
---@field diagnostics? nvim_tree.Config.Diagnostics
49-
---@field notify? nvim_tree.Config.Notify
60+
---
61+
---|nvim_tree.Config.Modified|
62+
---@field modified? nvim_tree.Config.Modified
63+
---
64+
---|nvim_tree.Config.Filters|
65+
---@field filters? nvim_tree.Config.Filters
66+
---
67+
---|nvim_tree.Config.LiveFilter|
68+
---@field live_filter? nvim_tree.Config.LiveFilter
69+
---
70+
---|nvim_tree.Config.FilesystemWatchers|
5071
---@field filesystem_watchers? nvim_tree.Config.FilesystemWatchers
51-
---@field log? nvim_tree.Config.Log
52-
---@field ui? nvim_tree.Config.UI
72+
---
73+
---|nvim_tree.Config.Actions|
5374
---@field actions? nvim_tree.Config.Actions
54-
---@field view? nvim_tree.Config.View
75+
---
76+
---|nvim_tree.Config.Trash|
77+
---@field trash? nvim_tree.Config.Trash
78+
---
79+
---|nvim_tree.Config.Tab|
80+
---@field tab? nvim_tree.Config.Tab
81+
---
82+
---|nvim_tree.Config.Notify|
83+
---@field notify? nvim_tree.Config.Notify
84+
---
85+
---|nvim_tree.Config.Help|
86+
---@field help? nvim_tree.Config.Help
87+
---
88+
---|nvim_tree.Config.UI|
89+
---@field ui? nvim_tree.Config.UI
90+
---
91+
---|nvim_tree.Config.Log|
92+
---@field log? nvim_tree.Config.Log
5593

5694
--
5795
-- HijackDirectories
5896
--
5997

6098
---@class nvim_tree.Config.HijackDirectories
61-
---@field enable? boolean Enable the feature. 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`
62-
---@field auto_open? boolean Opens the tree if the tree was previously closed. Default: `true`
99+
---
100+
---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.
101+
---(default: `true`)
102+
---@field enable? boolean
103+
---
104+
---Opens the tree if the tree was previously closed.
105+
---(default: `true`)
106+
---@field auto_open? boolean
63107

64108
--
65109
-- Renderer

0 commit comments

Comments
 (0)