feat: redirect other files that try to open in a neo-tree window

Author: cseickel

lua/neo-tree.lua

@@ -47,6 +47,7 @@ local define_events = function()
   if events_setup then
     return
   end
+
   local v = vim.version()
   local diag_autocmd = "DiagnosticChanged"
   if v.major < 1 and v.minor < 6 then
@@ -57,14 +58,13 @@ local define_events = function()
   end)
 
   events.define_autocmd_event(events.VIM_BUFFER_CHANGED, { "BufWritePost", "BufFilePost" }, 200)
-
   events.define_autocmd_event(events.VIM_BUFFER_ADDED, { "BufAdd" }, 200)
-
   events.define_autocmd_event(events.VIM_BUFFER_DELETED, { "BufDelete" }, 200)
   events.define_autocmd_event(events.VIM_BUFFER_ENTER, { "BufEnter", "BufWinEnter" }, 0)
   events.define_autocmd_event(events.VIM_WIN_ENTER, { "WinEnter" }, 0)
   events.define_autocmd_event(events.VIM_DIR_CHANGED, { "DirChanged" }, 200)
   events.define_autocmd_event(events.VIM_TAB_CLOSED, { "TabClosed" })
+
   events_setup = true
 end
 
@@ -170,9 +170,7 @@ end
 
 M.win_enter_event = function()
   local win_id = vim.api.nvim_get_current_win()
-  local cfg = vim.api.nvim_win_get_config(win_id)
-  if cfg.relative > "" or cfg.external then
-    -- floating window, ignore
+  if utils.is_floating(win_id) then
     return
   end
   if vim.o.filetype == "neo-tree" then
@@ -239,6 +237,40 @@ M.setup = function(config)
 
   events.clear_all_events()
   define_events()
+
+  -- Prevent accidentally opening another file in the neo-tree window.
+  events.subscribe({
+    event = events.VIM_BUFFER_ENTER,
+    handler = function(args)
+      if utils.is_floating() then
+        return
+      end
+      local prior_buf = vim.fn.bufnr("#")
+      if prior_buf < 1 then
+        return
+      end
+      local prior_type = vim.api.nvim_buf_get_option(prior_buf, "filetype")
+      if prior_type == "neo-tree" and vim.bo.filetype ~= "neo-tree" then
+        local bufname = vim.fn.bufname()
+        vim.cmd("b#")
+        -- Using schedule at this point  fixes problem with syntax
+        -- highlighting in the buffer. I also prevents errors with diagnostics
+        -- trying to work with gthe buffer as it's being closed.
+        vim.schedule(function()
+          -- try to delete the buffer, only because if it was new it would take
+          -- on options from the neo-tree window that are undesirable.
+          pcall(vim.cmd, "bdelete " .. bufname)
+          local fake_state = {
+            window = {
+              position = "left",
+            },
+          }
+          utils.open_file(fake_state, bufname)
+        end)
+      end
+    end,
+  })
+
   if config.event_handlers ~= nil then
     for _, handler in ipairs(config.event_handlers) do
       events.subscribe(handler)

lua/neo-tree/sources/common/commands.lua

@@ -169,43 +169,8 @@ local open_with_cmd = function(state, open_cmd, toggle_directory)
     end
     return nil
   else
-    -- use last window if possible
-    local suitable_window_found = false
-    local nt = require("neo-tree")
-    if nt.config.open_files_in_last_window then
-      local prior_window = nt.get_prior_window()
-      if prior_window > 0 then
-        local success = pcall(vim.api.nvim_set_current_win, prior_window)
-        if success then
-          suitable_window_found = true
-        end
-      end
-    end
-    -- find a suitable window to open the file in
-    if not suitable_window_found then
-      if state.window.position == "right" then
-        vim.cmd("wincmd t")
-      else
-        vim.cmd("wincmd w")
-      end
-    end
-    local attempts = 0
-    while attempts < 4 and vim.bo.filetype == "neo-tree" do
-      attempts = attempts + 1
-      vim.cmd("wincmd w")
-    end
-    -- TODO: make this configurable, see issue #43
-    if vim.bo.filetype == "neo-tree" then
-      -- Neo-tree must be the only window, restore it's status as a sidebar
-      local winid = vim.api.nvim_get_current_win()
-      local width = utils.get_value(state, "window.width", 40)
-      vim.cmd("vsplit " .. node:get_id())
-      vim.api.nvim_win_set_width(winid, width)
-    else
-      vim.cmd(open_cmd .. " " .. node:get_id())
-    end
-    local events = require("neo-tree.events")
-    events.fire_event(events.FILE_OPENED, node:get_id())
+    local path = node:get_id()
+    utils.open_file(state, path, open_cmd)
   end
 end
 

lua/neo-tree/utils.lua

@@ -269,6 +269,15 @@ M.get_value = function(sourceObject, valuePath, defaultValue, strict_type_check)
   end
 end
 
+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)
+  if cfg.relative > "" or cfg.external then
+    return true
+  end
+  return false
+end
+
 M.map = function(tbl, fn)
   local t = {}
   for k, v in pairs(tbl) do
@@ -277,6 +286,53 @@ M.map = function(tbl, fn)
   return t
 end
 
+---Open file in the appropriate window.
+---@param state table The state of the source
+---@param path string The file to open
+---@param open_cmd string The vimcommand to use to open the file
+M.open_file = function(state, path, open_cmd)
+  open_cmd = open_cmd or "edit"
+  if M.truthy(path) then
+    -- use last window if possible
+    local suitable_window_found = false
+    local nt = require("neo-tree")
+    if nt.config.open_files_in_last_window then
+      local prior_window = nt.get_prior_window()
+      if prior_window > 0 then
+        local success = pcall(vim.api.nvim_set_current_win, prior_window)
+        if success then
+          suitable_window_found = true
+        end
+      end
+    end
+    -- find a suitable window to open the file in
+    if not suitable_window_found then
+      if state.window.position == "right" then
+        vim.cmd("wincmd t")
+      else
+        vim.cmd("wincmd w")
+      end
+    end
+    local attempts = 0
+    while attempts < 4 and vim.bo.filetype == "neo-tree" do
+      attempts = attempts + 1
+      vim.cmd("wincmd w")
+    end
+    -- TODO: make this configurable, see issue #43
+    if vim.bo.filetype == "neo-tree" then
+      -- Neo-tree must be the only window, restore it's status as a sidebar
+      local winid = vim.api.nvim_get_current_win()
+      local width = M.get_value(state, "window.width", 40)
+      vim.cmd("vsplit " .. path)
+      vim.api.nvim_win_set_width(winid, width)
+    else
+      vim.cmd(open_cmd .. " " .. path)
+    end
+    local events = require("neo-tree.events")
+    events.fire_event(events.FILE_OPENED, path)
+  end
+end
+
 M.reduce = function(list, memo, func)
   for _, i in ipairs(list) do
     memo = func(memo, i)
@@ -298,6 +354,7 @@ M.resolve_config_option = function(state, config_option, default_value)
     return opt
   end
 end
+
 ---The file system path separator for the current platform.
 M.path_separator = "/"
 M.is_windows = vim.fn.has("win32") == 1 or vim.fn.has("win32unix") == 1