fix(hijack): hijack more often, restore cursor if window changed (#1746)

Author: pynappo

.gitignore

@@ -46,3 +46,5 @@ tags
 .testcache
 .dependencies
 luacov.*.out
+
+tests/repro

lua/neo-tree.lua

@@ -13,11 +13,13 @@ end
 local new_user_config = nil
 
 ---Updates the config of neo-tree using the latest user config passed through setup, if any.
+---@return neotree.Config._Full
 M.ensure_config = function()
   if not M.config or new_user_config then
     M.config = require("neo-tree.setup").merge_config(new_user_config)
     new_user_config = nil
   end
+  return M.config
 end
 
 M.get_prior_window = function(ignore_filetypes, ignore_winfixbuf)
@@ -91,12 +93,7 @@ local function try_netrw_hijack(path)
     return false
   end
 
-  local netrw = require("neo-tree.setup.netrw")
-  if netrw.get_hijack_behavior() ~= "disabled" then
-    vim.cmd("silent! autocmd! FileExplorer *")
-    return netrw.hijack(path)
-  end
-  return false
+  return require("neo-tree.setup.netrw").hijack()
 end
 
 ---@param config neotree.Config

lua/neo-tree/setup/init.lua

@@ -195,6 +195,11 @@ M.buffer_enter_event = function()
   end
   last_buffer_enter_filetype = vim.bo.filetype
 
+  -- if vim is trying to open a dir, then we hijack it
+  if netrw.hijack() then
+    return
+  end
+
   -- For all others, make sure another buffer is not hijacking our window
   -- ..but not if the position is "current"
   local prior_buf = vim.fn.bufnr("#")
@@ -209,11 +214,6 @@ M.buffer_enter_event = function()
     return
   end
 
-  -- if vim is trying to open a dir, then we hijack it
-  if netrw.hijack() then
-    return
-  end
-
   if prior_type == "neo-tree" then
     local success, position = pcall(vim.api.nvim_buf_get_var, prior_buf, "neo_tree_position")
     if not success then
@@ -496,8 +496,10 @@ M.merge_config = function(user_config)
   events.clear_all_events()
   define_events()
 
-  -- Prevent accidentally opening another file in the neo-tree window.
+  -- Prevent netrw hijacking lazy-loading from conflicting with normal hijacking.
   vim.g.neotree_watching_bufenter = 1
+
+  -- Prevent accidentally opening another file in the neo-tree window.
   events.subscribe({
     event = events.VIM_BUFFER_ENTER,
     handler = M.buffer_enter_event,
@@ -670,6 +672,21 @@ M.merge_config = function(user_config)
     )
   end
 
+  ---@type neotree.Config.HijackNetrwBehavior[]
+  local disable_netrw_values = { "open_default", "open_current" }
+  local hijack_behavior = M.config.filesystem.hijack_netrw_behavior
+  if vim.tbl_contains(disable_netrw_values, hijack_behavior) then
+    -- Disable netrw autocmds
+    vim.cmd("silent! autocmd! FileExplorer *")
+  elseif hijack_behavior ~= "disabled" then
+    require("neo-tree.log").error(
+      "Invalid value for filesystem.hijack_netrw_behavior: '"
+        .. hijack_behavior
+        .. "', will default to 'disabled'"
+    )
+    M.config.filesystem.hijack_netrw_behavior = "disabled"
+  end
+
   if not M.config.enable_git_status then
     M.config.git_status_async = false
   end
@@ -678,14 +695,7 @@ M.merge_config = function(user_config)
   -- aren't, remove them
   local source_selector_sources = {}
   for _, ss_source in ipairs(M.config.source_selector.sources or {}) do
-    local source_match = false
-    for _, source in ipairs(M.config.sources) do
-      if ss_source.source == source then
-        source_match = true
-        break
-      end
-    end
-    if source_match then
+    if vim.tbl_contains(M.config.sources, ss_source.source) then
       table.insert(source_selector_sources, ss_source)
     else
       log.debug(string.format("Unable to locate Neo-tree extension %s", ss_source.source))

lua/neo-tree/setup/netrw.lua

@@ -8,88 +8,80 @@ local get_position = function(source_name)
   return pos
 end
 
+---@return neotree.Config.HijackNetrwBehavior
 M.get_hijack_behavior = function()
   nt.ensure_config()
-  local option = "filesystem.hijack_netrw_behavior"
-  local hijack_behavior = utils.get_value(nt.config, option, "open_default", true)
-  if hijack_behavior == "disabled" then
-    return hijack_behavior
-  elseif hijack_behavior == "open_default" then
-    return hijack_behavior
-  elseif hijack_behavior == "open_current" then
-    return hijack_behavior
-  else
-    require("neo-tree.log").error("Invalid value for " .. option .. ": " .. hijack_behavior)
-    return "disabled"
-  end
+  return nt.config.filesystem.hijack_netrw_behavior
 end
 
----@param path string? Path to hijack (sometimes bufname doesn't set in time)
 ---@return boolean hijacked Whether the hijack was successful
-M.hijack = function(path)
+M.hijack = function()
   local hijack_behavior = M.get_hijack_behavior()
   if hijack_behavior == "disabled" then
     return false
   end
 
   -- ensure this is a directory
-  local bufname = vim.api.nvim_buf_get_name(0)
-  if not utils.truthy(bufname) then
-    bufname = path or ""
-  end
-  local stats = uv.fs_stat(bufname)
-  if not stats then
-    return false
-  end
-  if stats.type ~= "directory" then
+  local dir_bufnr = vim.api.nvim_get_current_buf()
+  local path_to_hijack = vim.api.nvim_buf_get_name(dir_bufnr)
+  local stats = uv.fs_stat(path_to_hijack)
+  if not stats or stats.type ~= "directory" then
     return false
   end
 
   -- record where we are now
   local pos = get_position("filesystem")
   local should_open_current = hijack_behavior == "open_current" or pos == "current"
-  local winid = vim.api.nvim_get_current_win()
-  local dir_bufnr = vim.api.nvim_get_current_buf()
+  local dir_window = vim.api.nvim_get_current_win()
 
   -- Now actually open the tree, with a very quick debounce because this may be
   -- called multiple times in quick succession.
-  utils.debounce("hijack_netrw_" .. winid, function()
+  utils.debounce("hijack_netrw_" .. dir_window, function()
     local manager = require("neo-tree.sources.manager")
     local log = require("neo-tree.log")
     -- We will want to replace the "directory" buffer with either the "alternate"
     -- buffer or a new blank one.
-    local replace_with_bufnr = vim.fn.bufnr("#")
+    local replacement_buffer = vim.fn.bufnr("#")
     local is_currently_neo_tree = false
-    if replace_with_bufnr > 0 then
-      if vim.bo[replace_with_bufnr].filetype == "neo-tree" then
+    if replacement_buffer > 0 then
+      if vim.bo[replacement_buffer].filetype == "neo-tree" then
         -- don't hijack the current window if it's already a Neo-tree sidebar
-        local _, position = pcall(vim.api.nvim_buf_get_var, replace_with_bufnr, "neo_tree_position")
-        if position ~= "current" then
-          is_currently_neo_tree = true
+        local position = vim.b[replacement_buffer].neo_tree_position
+        if position == "current" then
+          replacement_buffer = -1
         else
-          replace_with_bufnr = -1
+          is_currently_neo_tree = true
         end
       end
     end
     if not should_open_current then
-      if replace_with_bufnr == dir_bufnr or replace_with_bufnr < 1 then
-        replace_with_bufnr = vim.api.nvim_create_buf(true, false)
-        log.trace("Created new buffer for netrw hijack", replace_with_bufnr)
+      if replacement_buffer == dir_bufnr or replacement_buffer < 1 then
+        replacement_buffer = vim.api.nvim_create_buf(true, false)
+        log.trace("Created new buffer for netrw hijack", replacement_buffer)
       end
     end
-    if replace_with_bufnr > 0 then
-      log.trace("Replacing buffer in netrw hijack", replace_with_bufnr)
-      pcall(vim.api.nvim_win_set_buf, winid, replace_with_bufnr)
+    if replacement_buffer > 0 then
+      log.trace("Replacing buffer in netrw hijack", replacement_buffer)
+      pcall(vim.api.nvim_win_set_buf, dir_window, replacement_buffer)
     end
-    local remove_dir_buf = vim.schedule_wrap(function()
+
+    -- If a window takes focus (e.g. lazy.nvim installing plugins on startup) in the time between the method call and
+    -- this debounced callback, we should focus that window over neo-tree.
+    local current_window = vim.api.nvim_get_current_win()
+    local should_restore_cursor = current_window ~= dir_window
+
+    local cleanup = vim.schedule_wrap(function()
       log.trace("Deleting buffer in netrw hijack", dir_bufnr)
       pcall(vim.api.nvim_buf_delete, dir_bufnr, { force = true })
+      if should_restore_cursor then
+        vim.api.nvim_set_current_win(current_window)
+      end
     end)
 
     local state
     if should_open_current and not is_currently_neo_tree then
       log.debug("hijack_netrw: opening current")
-      state = manager.get_state("filesystem", nil, winid)
+      state = manager.get_state("filesystem", nil, dir_window)
       state.current_position = "current"
     elseif is_currently_neo_tree then
       log.debug("hijack_netrw: opening in existing Neo-tree")
@@ -99,7 +91,8 @@ M.hijack = function(path)
       manager.close_all_except("filesystem")
       state = manager.get_state("filesystem")
     end
-    require("neo-tree.sources.filesystem")._navigate_internal(state, bufname, nil, remove_dir_buf)
+
+    require("neo-tree.sources.filesystem")._navigate_internal(state, path_to_hijack, nil, cleanup)
   end, 10, utils.debounce_strategy.CALL_LAST_ONLY)
 
   return true

lua/neo-tree/utils/init.lua

@@ -573,6 +573,7 @@ M.is_filtered_by_pattern = function(pattern_list, path, name)
   return false
 end
 
+---@param win_id integer?
 M.is_floating = function(win_id)
   win_id = win_id or vim.api.nvim_get_current_win()
   local cfg = vim.api.nvim_win_get_config(win_id)

plugin/neo-tree.lua

@@ -22,22 +22,15 @@ local function try_netrw_hijack(path)
     return false
   end
 
-  local netrw = require("neo-tree.setup.netrw")
-  if netrw.get_hijack_behavior() ~= "disabled" then
-    vim.cmd("silent! autocmd! FileExplorer *")
-    return netrw.hijack(path)
-  end
-  return false
+  return require("neo-tree.setup.netrw").hijack()
 end
 
 local augroup = vim.api.nvim_create_augroup("NeoTree_NetrwDeferred", { clear = true })
 
-vim.api.nvim_create_autocmd("BufEnter", {
+vim.api.nvim_create_autocmd({ "BufEnter" }, {
   group = augroup,
   callback = function(args)
-    if vim.g.neotree_watching_bufenter == 1 or try_netrw_hijack(args.file) then
-      vim.api.nvim_del_augroup_by_id(augroup)
-    end
+    return vim.g.neotree_watching_bufenter == 1 or try_netrw_hijack(args.file)
   end,
 })