feat!: add config to prevent replacing specific filetypes (#803)

default is set to not replace { "terminal", "trouble", "qf" }
set `open_files_do_not_replace_filetypes = {}` to restore previous behavior.
closes #564, closes #802

Author: cseickel

README.md

@@ -123,6 +123,7 @@ use {
         popup_border_style = "rounded",
         enable_git_status = true,
         enable_diagnostics = true,
+        open_files_do_not_replace_filetypes = { "terminal", "trouble", "qf" }, -- when opening files, do not use windows containing these filetypes
         sort_case_insensitive = false, -- used when sorting files and directories in the tree
         sort_function = nil , -- use a custom function for sorting files and directories in the tree 
         -- sort_function = function (a,b)

lua/neo-tree.lua

@@ -160,9 +160,13 @@ M.show_in_split = function(source_name, toggle_if_open)
   manager.show_in_split(source_name)
 end
 
-M.get_prior_window = function()
+M.get_prior_window = function(ignore_filetypes)
+  ignore_filetypes = ignore_filetypes or {}
+  local ignore = utils.list_to_dict(ignore_filetypes)
+  ignore["neo-tree"] = true
+
   local tabnr = vim.api.nvim_get_current_tabpage()
-  local wins = utils.get_value(M, "config.prior_windows", {})[tabnr]
+  local wins = utils.get_value(M, "config.prior_windows", {}, true)[tabnr]
   if wins == nil then
     return -1
   end
@@ -174,7 +178,7 @@ M.get_prior_window = function()
       if success and is_valid then
         local buf = vim.api.nvim_win_get_buf(last_win)
         local ft = vim.api.nvim_buf_get_option(buf, "filetype")
-        if ft ~= "neo-tree" then
+        if ignore[ft] ~= true then
           return last_win
         end
       end

lua/neo-tree/defaults.lua

@@ -34,6 +34,7 @@ local config = {
   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
   open_files_in_last_window = true, -- false = open files in top left window
+  open_files_do_not_replace_filetypes = { "terminal", "trouble", "qf" }, -- when opening files, do not use windows containing these filetypes
   popup_border_style = "NC", -- "double", "none", "rounded", "shadow", "single" or "solid"
   resize_timer_interval = 500, -- in ms, needed for containers to redraw right aligned and faded content
                                -- set to -1 to disable the resize timer entirely

lua/neo-tree/utils.lua

@@ -461,8 +461,11 @@ M.get_appropriate_window = function(state)
   -- use last window if possible
   local suitable_window_found = false
   local nt = require("neo-tree")
+  local ignore_ft = nt.config.open_files_do_not_replace_filetypes
+  local ignore = M.list_to_dict(ignore_ft)
+  ignore["neo-tree"] = true
   if nt.config.open_files_in_last_window then
-    local prior_window = nt.get_prior_window()
+    local prior_window = nt.get_prior_window(ignore)
     if prior_window > 0 then
       local success = pcall(vim.api.nvim_set_current_win, prior_window)
       if success then
@@ -480,13 +483,17 @@ M.get_appropriate_window = function(state)
   end
   local attempts = 0
   while attempts < 5 and not suitable_window_found do
-    if vim.bo.filetype == "neo-tree" or M.is_floating() then
+    if ignore[vim.bo.filetype] or M.is_floating() then
       attempts = attempts + 1
       vim.cmd("wincmd w")
     else
       suitable_window_found = true
     end
   end
+  if not suitable_window_found then
+    -- go back to the neotree window, this will forve it to open a new split
+    vim.api.nvim_set_current_win(current_window)
+  end
 
   local winid = vim.api.nvim_get_current_win()
   local is_neo_tree_window = vim.bo.filetype == "neo-tree"
@@ -515,7 +522,8 @@ M.open_file = function(state, path, open_cmd, bufnr)
   end
 
   if M.truthy(path) then
-    local escaped_path = bufnr or vim.fn.fnameescape(path)
+    local escaped_path = vim.fn.fnameescape(path)
+    local bufnr_or_path = bufnr or escaped_path
     local events = require("neo-tree.events")
     local result = true
     local err = nil
@@ -530,47 +538,58 @@ M.open_file = function(state, path, open_cmd, bufnr)
       return
     end
     if state.current_position == "current" then
-      result, err = pcall(vim.cmd, open_cmd .. " " .. escaped_path)
+      result, err = pcall(vim.cmd, open_cmd .. " " .. bufnr_or_path)
     else
       local winid, is_neo_tree_window = M.get_appropriate_window(state)
       vim.api.nvim_set_current_win(winid)
       -- TODO: make this configurable, see issue #43
       if is_neo_tree_window then
-        -- Neo-tree must be the only window, restore it's status as a sidebar
-        local default_width = 40
-        local width = M.get_value(state, "window.width", default_width, false)
-        local available_width = vim.api.nvim_win_get_width(0)
-        if type(width) == "string" then
-          if string.sub(width, -1) == "%" then
-            width = tonumber(string.sub(width, 1, #width - 1)) / 100
+        local width = vim.api.nvim_win_get_width(0)
+        if width == vim.o.columns then
+          -- Neo-tree must be the only window, restore it's status as a sidebar
+          local default_width = 40
+          width = M.get_value(state, "window.width", default_width, false)
+          local available_width = vim.api.nvim_win_get_width(0)
+          if type(width) == "string" then
+            if string.sub(width, -1) == "%" then
+              width = tonumber(string.sub(width, 1, #width - 1)) / 100
+            else
+              width = tonumber(width)
+            end
+            width = math.floor(available_width * width)
+          elseif type(width) == "function" then
+            width = width()
+            if type(width) ~= "number" then
+              width = default_width
+            else
+              width = math.floor(width)
+            end
+          elseif type(width) == "number" then
+            width = math.floor(width)
           else
-            width = tonumber(width)
-          end
-          width = math.floor(available_width * width)
-        elseif type(width) == "function" then
-          width = width()
-          if type(width) ~= "number" then
             width = default_width
-          else
-            width = math.floor(width)
           end
-        elseif type(width) == "number" then
-          width = math.floor(width)
-        else
-          width = default_width
         end
-        local nt = require("neo-tree")
-        local split_command = "vsplit "
+
+        local split_command = "vsplit"
         -- respect window position in user config when Neo-tree is the only window
-        if nt.config.window.position == "left" then
-          split_command = "rightbelow vs "
-        elseif nt.config.window.position == "right" then
-          split_command = "leftabove vs "
+        if state.current_position == "left" then
+          split_command = "rightbelow vs"
+        elseif state.current_position == "right" then
+          split_command = "leftabove vs"
+        end
+        if path == "[No Name]" then
+          result, err = pcall(vim.cmd, split_command)
+          if result then
+            vim.cmd("b" .. bufnr)
+          end
+        else
+          result, err = pcall(vim.cmd, split_command .. escaped_path)
         end
-        result, err = pcall(vim.cmd, split_command .. escaped_path)
+
         vim.api.nvim_win_set_width(winid, width)
       else
-        result, err = pcall(vim.cmd, open_cmd .. " " .. escaped_path)
+        result, err = pcall(vim.cmd, open_cmd .. " " .. bufnr_or_path)
       end
     end
     if result or err == "Vim(edit):E325: ATTENTION" then