Added a new option auto_reload_on_write to allow users to disable it for performance reasons (#956)

This commit is contained in:
Steve Vermeulen 2022-02-09 20:06:07 +00:00 committed by GitHub
parent 5744c469a6
commit 4ec8c9f364
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 40 additions and 30 deletions

View File

@ -40,15 +40,16 @@ Note that options under the `g:` command should be set **BEFORE** running the se
-- following options are the default -- following options are the default
-- each of these are documented in `:help nvim-tree.OPTION_NAME` -- each of these are documented in `:help nvim-tree.OPTION_NAME`
require'nvim-tree'.setup { require'nvim-tree'.setup {
disable_netrw = true, disable_netrw = true,
hijack_netrw = true, hijack_netrw = true,
open_on_setup = false, open_on_setup = false,
ignore_ft_on_setup = {}, ignore_ft_on_setup = {},
auto_close = false, auto_close = false,
open_on_tab = false, auto_reload_on_write = true,
hijack_cursor = false, open_on_tab = false,
update_cwd = false, hijack_cursor = false,
update_to_buf_dir = { update_cwd = false,
update_to_buf_dir = {
enable = true, enable = true,
auto_open = true, auto_open = true,
}, },

View File

@ -71,19 +71,20 @@ function.
> >
require'nvim-tree'.setup { require'nvim-tree'.setup {
disable_netrw = true, disable_netrw = true,
hijack_netrw = true, hijack_netrw = true,
open_on_setup = false, open_on_setup = false,
ignore_ft_on_setup = {}, ignore_ft_on_setup = {},
update_to_buf_dir = { update_to_buf_dir = {
enable = true, enable = true,
auto_open = true, auto_open = true,
}, },
auto_close = false, auto_close = false,
open_on_tab = false, auto_reload_on_write = true,
hijack_cursor = false, open_on_tab = false,
update_cwd = false, hijack_cursor = false,
diagnostics = { update_cwd = false,
diagnostics = {
enable = false, enable = false,
show_on_dirs = false, show_on_dirs = false,
icons = { icons = {
@ -171,6 +172,11 @@ Here is a list of the options available in the setup call:
type: `boolean` type: `boolean`
default: `false` default: `false`
*nvim-tree.auto_reload_on_write*
- |auto_reload_on_write|: reloads the explorer every time a buffer is written to
type: `boolean`
default: `true`
*nvim-tree.open_on_tab* *nvim-tree.open_on_tab*
- |open_on_tab|: opens the tree automatically when switching tabpage or opening a new - |open_on_tab|: opens the tree automatically when switching tabpage or opening a new
tabpage if the tree was previously open. tabpage if the tree was previously open.

View File

@ -280,7 +280,9 @@ local function setup_autocommands(opts)
-- reset highlights when colorscheme is changed -- reset highlights when colorscheme is changed
vim.cmd "au ColorScheme * lua require'nvim-tree'.reset_highlight()" vim.cmd "au ColorScheme * lua require'nvim-tree'.reset_highlight()"
vim.cmd "au BufWritePost * lua require'nvim-tree.actions.reloaders'.reload_explorer()" if opts.auto_reload_on_write then
vim.cmd "au BufWritePost * lua require'nvim-tree.actions.reloaders'.reload_explorer()"
end
vim.cmd "au User FugitiveChanged,NeogitStatusRefreshed lua require'nvim-tree.actions.reloaders'.reload_git()" vim.cmd "au User FugitiveChanged,NeogitStatusRefreshed lua require'nvim-tree.actions.reloaders'.reload_git()"
if opts.auto_close then if opts.auto_close then
@ -309,19 +311,20 @@ local function setup_autocommands(opts)
end end
local DEFAULT_OPTS = { local DEFAULT_OPTS = {
disable_netrw = true, disable_netrw = true,
hijack_netrw = true, hijack_netrw = true,
open_on_setup = false, open_on_setup = false,
open_on_tab = false, open_on_tab = false,
update_to_buf_dir = { update_to_buf_dir = {
enable = true, enable = true,
auto_open = true, auto_open = true,
}, },
auto_close = false, auto_close = false,
hijack_cursor = false, auto_reload_on_write = true,
update_cwd = false, hijack_cursor = false,
hide_root_folder = false, update_cwd = false,
update_focused_file = { hide_root_folder = false,
update_focused_file = {
enable = false, enable = false,
update_cwd = false, update_cwd = false,
ignore_list = {} ignore_list = {}