refactor(#2988): multi-instance change-dir (#3233)

* chore: moving root action dir-up to explorer class

* chore(explorer): moving requires to top level

* wip(explorer): moved all change-dir functions to explorer class

* wip(explorer): rename M.current_tab to self.current_tab

* chore(explorer): move change_dir root action to explorer and replace all places using change_dir to use it from explorer

* refactor(explorer): changing _foldername to folder_name

* wip(explorer): rename expand method to expand_dir_node and all places using it

* wip(explorer): mark private methods and remove add_profiling_to method

* fix: allow changing root to file`s parent directory and fix restrict_above_cwd config path

* refactor(api): moving change_root_to_node to Explorer:change_dir_to_node

* fix(explorer): get new explorer before redrawing on <C-]>

* docs(explorer): adding link to PR discussion for more context

* fix(explorer): correctly check config.actions.change_dir for change_dir related methods

* fix: correctly pass explorer as first arg when calling explorer methods in lua/nvim-tree

* fix: correctly pass args to change_dir

* fix: check for explorer before force_dirchange in open_on_directory

* fix: check if force_dirchange should call core.init

Author: Uanela

lua/nvim-tree.lua

@@ -11,6 +11,17 @@ local M = {
   init_root = "",
 }
 
+--- Helper function to execute some explorer method safely
+---@param fn string # key of explorer
+---@param ... any|nil
+---@return function|nil
+local function explorer_fn(fn, ...)
+  local explorer = core.get_explorer()
+  if explorer then
+    return explorer[fn](explorer, ...)
+  end
+end
+
 --- Update the tree root to a directory or the directory containing
 ---@param path string relative or absolute
 ---@param bufnr number|nil
@@ -47,7 +58,7 @@ function M.change_root(path, bufnr)
   -- test if in vim_cwd
   if utils.path_relative(path, vim_cwd) ~= path then
     if vim_cwd ~= cwd then
-      actions.root.change_dir.fn(vim_cwd)
+      explorer_fn("change_dir", vim_cwd)
     end
     return
   end
@@ -58,19 +69,19 @@ function M.change_root(path, bufnr)
 
   -- otherwise test M.init_root
   if _config.prefer_startup_root and utils.path_relative(path, M.init_root) ~= path then
-    actions.root.change_dir.fn(M.init_root)
+    explorer_fn("change_dir", M.init_root)
     return
   end
   -- otherwise root_dirs
   for _, dir in pairs(_config.root_dirs) do
     dir = vim.fn.fnamemodify(dir, ":p")
     if utils.path_relative(path, dir) ~= path then
-      actions.root.change_dir.fn(dir)
+      explorer_fn("change_dir", dir)
       return
     end
   end
   -- finally fall back to the folder containing the file
-  actions.root.change_dir.fn(vim.fn.fnamemodify(path, ":p:h"))
+  explorer_fn("change_dir", vim.fn.fnamemodify(path, ":p:h"))
 end
 
 function M.tab_enter()
@@ -110,7 +121,13 @@ function M.open_on_directory()
     return
   end
 
-  actions.root.change_dir.force_dirchange(bufname, true)
+
+  local explorer = core.get_explorer()
+  if not explorer then
+    core.init(bufname)
+  end
+
+  explorer_fn("force_dirchange", bufname, true, false)
 end
 
 ---@return table
@@ -134,7 +151,7 @@ end
 ---@param name string|nil
 function M.change_dir(name)
   if name then
-    actions.root.change_dir.fn(name)
+    explorer_fn("change_dir", name)
   end
 
   if _config.update_focused_file.update_root.enable then

lua/nvim-tree/actions/finders/find-file.lua

@@ -66,7 +66,7 @@ function M.fn(path)
             dir.open = true
           end
           if #dir.nodes == 0 then
-            core.get_explorer():expand(dir)
+            core.get_explorer():expand_dir_node(dir)
             if dir.group_next and incremented_line then
               line = line - 1
             end

lua/nvim-tree/actions/init.lua

@@ -4,13 +4,11 @@ M.finders = require("nvim-tree.actions.finders")
 M.fs = require("nvim-tree.actions.fs")
 M.moves = require("nvim-tree.actions.moves")
 M.node = require("nvim-tree.actions.node")
-M.root = require("nvim-tree.actions.root")
 M.tree = require("nvim-tree.actions.tree")
 
 function M.setup(opts)
   M.fs.setup(opts)
   M.node.setup(opts)
-  M.root.setup(opts)
   M.tree.setup(opts)
 end
 

lua/nvim-tree/actions/root/change-dir.lua

@@ -23,7 +23,7 @@ local function expand(node)
   node = node:last_group_node()
   node.open = true
   if #node.nodes == 0 then
-    core.get_explorer():expand(node)
+    core.get_explorer():expand_dir_node(node)
   end
 end
 
@@ -66,7 +66,7 @@ local function should_expand(expansion_count, node, should_descend)
 
   if not dir.open and should_descend(expansion_count, node) then
     if #node.nodes == 0 then
-      core.get_explorer():expand(dir) -- populate node.group_next
+      core.get_explorer():expand_dir_node(dir) -- populate node.group_next
     end
 
     if dir.group_next then

lua/nvim-tree/actions/root/init.lua

@@ -9,7 +9,6 @@ local keymap = require("nvim-tree.keymap")
 local notify = require("nvim-tree.notify")
 
 local DirectoryNode = require("nvim-tree.node.directory")
-local FileNode = require("nvim-tree.node.file")
 local FileLinkNode = require("nvim-tree.node.file-link")
 local RootNode = require("nvim-tree.node.root")
 local UserDecorator = require("nvim-tree.renderer.decorator.user")
@@ -158,23 +157,7 @@ Api.tree.change_root = wrap(function(...)
   require("nvim-tree").change_dir(...)
 end)
 
-Api.tree.change_root_to_node = wrap_node(function(node)
-  if node.name == ".." or node:is(RootNode) then
-    actions.root.change_dir.fn("..")
-    return
-  end
-
-  if node:is(FileNode) and node.parent ~= nil then
-    actions.root.change_dir.fn(node.parent:last_group_node().absolute_path)
-    return
-  end
-
-  if node:is(DirectoryNode) then
-    actions.root.change_dir.fn(node:last_group_node().absolute_path)
-    return
-  end
-end)
-
+Api.tree.change_root_to_node = wrap_node(wrap_explorer("change_dir_to_node"))
 Api.tree.change_root_to_parent = wrap_node(wrap_explorer("dir_up"))
 Api.tree.get_node_under_cursor = wrap_explorer("get_node_at_cursor")
 Api.tree.get_nodes = wrap_explorer("get_nodes")
@@ -281,7 +264,7 @@ local function open_or_expand_or_dir_up(mode, toggle_group)
     local dir = node:as(DirectoryNode)
 
     if root or node.name == ".." then
-      actions.root.change_dir.fn("..")
+      wrap_explorer("change_dir")("..")
     elseif dir then
       dir:expand_or_collapse(toggle_group)
     elseif not toggle_group then