tomas.mirchev/nvim-tree.lua
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: help sections and tidy (#2399)

Browse Source 
* doc: add nvim-tree-options, sort root level options

* doc: reorder default options, add sections

* doc: collapse opts spacing and tidy

* doc: tidy highlight groups
This commit is contained in:
Alexander Courtis 2023-09-03 15:52:33 +10:00 committed by GitHub
parent 323f65cb9c
commit a2b6e5ad2a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 964 additions and 886 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1790
doc/nvim-tree-lua.txt
View File

File diff suppressed because it is too large Load Diff

60
lua/nvim-tree.lua
View File

@ -364,34 +364,34 @@ local function setup_autocommands(opts)
end
local DEFAULT_OPTS = { -- BEGIN_DEFAULT_OPTS
on_attach = "default",
hijack_cursor = false,
auto_reload_on_write = true,
disable_netrw = false,
hijack_cursor = false,
hijack_netrw = true,
hijack_unnamed_buffer_when_opening = false,
sort = {
sorter = "name",
folders_first = true,
files_first = false,
},
root_dirs = {},
prefer_startup_root = false,
sync_root_with_cwd = false,
reload_on_bufenter = false,
respect_buf_cwd = false,
on_attach = "default",
select_prompts = false,
sort = {
sorter = "name",
folders_first = true,
files_first = false,
},
view = {
centralize_selection = false,
cursorline = true,
debounce_delay = 15,
width = 30,
hide_root_folder = false,
side = "left",
preserve_window_proportions = false,
number = false,
relativenumber = false,
signcolumn = "yes",
width = 30,
float = {
enable = false,
quit_on_focus_loss = true,
@ -408,13 +408,15 @@ local DEFAULT_OPTS = { -- BEGIN_DEFAULT_OPTS
renderer = {
add_trailing = false,
group_empty = false,
highlight_git = false,
highlight_diagnostics = false,
full_name = false,
highlight_opened_files = "none",
highlight_modified = "none",
root_folder_label = ":~:s?$?/..?",
indent_width = 2,
special_files = { "Cargo.toml", "Makefile", "README.md", "readme.md" },
symlink_destination = true,
highlight_git = false,
highlight_diagnostics = false,
highlight_opened_files = "none",
highlight_modified = "none",
indent_markers = {
enable = false,
inline_arrows = true,
@ -476,8 +478,6 @@ local DEFAULT_OPTS = { -- BEGIN_DEFAULT_OPTS
},
},
},
special_files = { "Cargo.toml", "Makefile", "README.md", "readme.md" },
symlink_destination = true,
},
hijack_directories = {
enable = true,
@ -492,6 +492,13 @@ local DEFAULT_OPTS = { -- BEGIN_DEFAULT_OPTS
cmd = "",
args = {},
},
git = {
enable = true,
show_on_dirs = true,
show_on_open_dirs = true,
disable_for_dirs = {},
timeout = 400,
},
diagnostics = {
enable = false,
show_on_dirs = false,
@ -508,6 +515,11 @@ local DEFAULT_OPTS = { -- BEGIN_DEFAULT_OPTS
error = "",
},
},
modified = {
enable = false,
show_on_dirs = true,
show_on_open_dirs = true,
},
filters = {
git_ignored = true,
dotfiles = false,
@ -516,23 +528,15 @@ local DEFAULT_OPTS = { -- BEGIN_DEFAULT_OPTS
custom = {},
exclude = {},
},
live_filter = {
prefix = "[FILTER]: ",
always_show_folders = true,
},
filesystem_watchers = {
enable = true,
debounce_delay = 50,
ignore_dirs = {},
},
git = {
enable = true,
show_on_dirs = true,
show_on_open_dirs = true,
disable_for_dirs = {},
timeout = 400,
},
modified = {
enable = false,
show_on_dirs = true,
show_on_open_dirs = true,
},
actions = {
use_system_clipboard = true,
change_dir = {
@ -574,10 +578,6 @@ local DEFAULT_OPTS = { -- BEGIN_DEFAULT_OPTS
trash = {
cmd = "gio trash",
},
live_filter = {
prefix = "[FILTER]: ",
always_show_folders = true,
},
tab = {
sync = {
open = false,