feat: add enable_refresh_on_write option to disable auto refresh, closes #338

Author: cseickel

lua/neo-tree/defaults.lua

@@ -8,6 +8,7 @@ local config = {
   enable_diagnostics = true,
   enable_git_status = true,
   enable_modified_markers = true, -- Show markers for files with unsaved changes.
+  enable_refresh_on_write = true, -- Refresh the tree when a file is written. Only used if `use_libuv_file_watcher` is false.
   git_status_async = true,
   log_level = "info", -- "trace", "debug", "info", "warn", "error", "fatal"
   log_to_file = false, -- true, false, "/path/to/file.log", use :NeoTreeLogs to show the file

lua/neo-tree/sources/buffers/init.lua

@@ -132,10 +132,12 @@ M.setup = function(config, global_config)
   end
 
   local refresh_events = {
-    events.VIM_BUFFER_CHANGED,
     events.VIM_BUFFER_ADDED,
     events.VIM_BUFFER_DELETED,
   }
+  if global_config.enable_refresh_on_write then
+    table.insert(refresh_events, events.VIM_BUFFER_CHANGED)
+  end
   for _, e in ipairs(refresh_events) do
     manager.subscribe(M.name, {
       event = e,

lua/neo-tree/sources/filesystem/init.lua

@@ -320,18 +320,20 @@ M.setup = function(config, global_config)
     })
   else
     require("neo-tree.sources.filesystem.lib.fs_watch").unwatch_all()
-    manager.subscribe(M.name, {
-      event = events.VIM_BUFFER_CHANGED,
-      handler = function(arg)
-        local afile = arg.afile or ""
-        if utils.is_real_file(afile) then
-          log.trace("refreshing due to vim_buffer_changed event: ", afile)
-          manager.refresh(M.name)
-        else
-          log.trace("Ignoring vim_buffer_changed event for non-file: ", afile)
-        end
-      end,
-    })
+    if global_config.enable_refresh_on_write then
+      manager.subscribe(M.name, {
+        event = events.VIM_BUFFER_CHANGED,
+        handler = function(arg)
+          local afile = arg.afile or ""
+          if utils.is_real_file(afile) then
+            log.trace("refreshing due to vim_buffer_changed event: ", afile)
+            manager.refresh(M.name)
+          else
+            log.trace("Ignoring vim_buffer_changed event for non-file: ", afile)
+          end
+        end,
+      })
+    end
   end
 
   --Configure event handlers for cwd changes

lua/neo-tree/sources/git_status/init.lua

@@ -42,14 +42,16 @@ M.setup = function(config, global_config)
     })
   end
 
-  manager.subscribe(M.name, {
-    event = events.VIM_BUFFER_CHANGED,
-    handler = function(args)
-      if utils.is_real_file(args.afile) then
-        manager.refresh(M.name)
+  if global_config.enable_refresh_on_write then
+    manager.subscribe(M.name, {
+      event = events.VIM_BUFFER_CHANGED,
+      handler = function(args)
+        if utils.is_real_file(args.afile) then
+          manager.refresh(M.name)
+        end
       end
-    end
-  })
+    })
+  end
 
   if config.bind_to_cwd then
     manager.subscribe(M.name, {