feat(files): load sync from user command, and async on refresh.

Author: cseickel

lua/neo-tree/command/init.lua

@@ -161,15 +161,15 @@ do_show_or_focus = function(args, state, force_navigate)
     manager.navigate(state, args.dir, args.reveal_file, function()
       -- navigate changes the window to neo-tree, so just quickly hop back to the original window
       vim.api.nvim_set_current_win(current_win)
-    end)
+    end, false)
   elseif args.action == "focus" then
     -- "focus" mean open and jump to the window if closed, and just focus it if already opened
     if window_exists then
       vim.api.nvim_set_current_win(state.winid)
     end
     if force_navigate or not window_exists then
       close_other_sources()
-      manager.navigate(state, args.dir, args.reveal_file)
+      manager.navigate(state, args.dir, args.reveal_file, nil, false)
     end
   end
 end

lua/neo-tree/defaults.lua

@@ -211,7 +211,7 @@ local config = {
         ["."] = "set_root",
       }
     },
-    async_directory_scan = true,
+    async_directory_scan = true, -- only applies to refreshes, it's alwsays sync when called from the Neotree commands.
     bind_to_cwd = true, -- true creates a 2-way binding between vim's cwd and neo-tree's root
     -- The renderer section provides the renderers that will be used to render the tree.
     --   The first level is the node type.

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

@@ -27,7 +27,7 @@ M.reveal_current_file = function()
   return manager.reveal_current_file(M.name)
 end
 
-local follow_internal = function(callback, force_show)
+local follow_internal = function(callback, force_show, async)
   log.trace("follow called")
   if vim.bo.filetype == "neo-tree" or vim.bo.filetype == "neo-tree-popup" then
     return
@@ -97,7 +97,7 @@ local follow_internal = function(callback, force_show)
     if type(callback) == "function" then
       callback()
     end
-  end)
+  end, async)
   return true
 end
 
@@ -110,7 +110,7 @@ M.follow = function(callback, force_show)
   end, 100, utils.debounce_strategy.CALL_LAST_ONLY)
 end
 
-M._navigate_internal = function(state, path, path_to_reveal, callback)
+M._navigate_internal = function(state, path, path_to_reveal, callback, async)
   log.trace("navigate_internal", state.current_position, path, path_to_reveal)
   state.dirty = false
   local is_search = utils.truthy(state.search_pattern)
@@ -135,14 +135,14 @@ M._navigate_internal = function(state, path, path_to_reveal, callback)
     )
     fs_scan.get_items(state, nil, path_to_reveal, callback)
   else
-    local is_split = state.current_position == "current"
+    local is_current = state.current_position == "current"
     local follow_file = state.follow_current_file
       and not is_search
-      and not is_split
+      and not is_current
       and manager.get_path_to_reveal()
     local handled = false
     if utils.truthy(follow_file) then
-      handled = follow_internal(callback, true)
+      handled = follow_internal(callback, true, async)
     end
     if not handled then
       local success, msg = pcall(renderer.position.save, state)
@@ -151,7 +151,7 @@ M._navigate_internal = function(state, path, path_to_reveal, callback)
       else
         log.trace("navigate_internal: FAILED to save position: ", msg)
       end
-      fs_scan.get_items(state, nil, nil, callback)
+      fs_scan.get_items(state, nil, nil, callback, async)
     end
   end
 
@@ -168,10 +168,10 @@ end
 ---@param path string Path to navigate to. If empty, will navigate to the cwd.
 ---@param path_to_reveal string Node to focus after the items are loaded.
 ---@param callback function Callback to call after the items are loaded.
-M.navigate = function(state, path, path_to_reveal, callback)
-  log.trace("navigate", path, path_to_reveal)
+M.navigate = function(state, path, path_to_reveal, callback, async)
+  log.trace("navigate", path, path_to_reveal, async)
   utils.debounce("filesystem_navigate", function()
-    M._navigate_internal(state, path, path_to_reveal, callback)
+    M._navigate_internal(state, path, path_to_reveal, callback, async)
   end, utils.debounce_strategy.CALL_FIRST_AND_LAST, 100)
 end
 
@@ -340,7 +340,16 @@ M.setup = function(config, global_config)
   -- Update the "modified" component
   manager.subscribe(M.name, {
     event = events.VIM_BUFFER_MODIFIED_SET,
-    handler = wrap(manager.redraw)
+    handler = function (arg)
+      local afile = arg.afile or ""
+      local source = afile:match("^neo%-tree ([%l%-]+) %[%d+%]")
+      if source then
+        log.trace("Ignoring vim_modified_set event from " .. source)
+        return
+      end
+      log.trace("refreshing due to vim_modified_set event: ", afile)
+      manager.redraw(M.name)
+    end
   })
 end
 

lua/neo-tree/sources/manager.lua

@@ -348,7 +348,8 @@ end
 ---@param path string Path to navigate to. If empty, will navigate to the cwd.
 ---@param path_to_reveal string Node to focus after the items are loaded.
 ---@param callback function Callback to call after the items are loaded.
-M.navigate = function(state_or_source_name, path, path_to_reveal, callback)
+---@param async boolean Whether to load the items asynchronously, may not be respected by all sources.
+M.navigate = function(state_or_source_name, path, path_to_reveal, callback, async)
   local state, source_name
   if type(state_or_source_name) == "string" then
     state = M.get_state(state_or_source_name)
@@ -360,7 +361,7 @@ M.navigate = function(state_or_source_name, path, path_to_reveal, callback)
     log.error("navigate: state_or_source_name must be a string or a table")
   end
   log.trace("navigate", source_name, path, path_to_reveal)
-  require("neo-tree.sources." .. source_name).navigate(state, path, path_to_reveal, callback)
+  require("neo-tree.sources." .. source_name).navigate(state, path, path_to_reveal, callback, async)
 end
 
 ---Redraws the tree without scanning the filesystem again. Use this after