refactor(#2830): multi instance marks

Author: alex-courtis

doc/nvim-tree-lua.txt

@@ -2195,8 +2195,8 @@ marks.navigate.prev()                    *nvim-tree-api.marks.navigate.prev()*
     As per |nvim-tree-api.marks.navigate.next()|
 
 marks.navigate.select()                *nvim-tree-api.marks.navigate.select()*
-    Prompts for selection of a marked node as per
-    |nvim-tree-api.marks.navigate.next()|
+    Prompts for selection of a marked node, sorted by absolute paths.
+    A folder will be focused, a file will be opened.
 
 ==============================================================================
  6.8 API CONFIG                                         *nvim-tree-api.config*

lua/nvim-tree.lua

@@ -840,7 +840,6 @@ function M.setup(conf)
   require("nvim-tree.view").setup(opts)
   require("nvim-tree.lib").setup(opts)
   require("nvim-tree.renderer").setup(opts)
-  require("nvim-tree.marks").setup()
   require("nvim-tree.buffers").setup(opts)
   require("nvim-tree.help").setup(opts)
   require("nvim-tree.watcher").setup(opts)

lua/nvim-tree/api.lua

@@ -6,7 +6,6 @@ local actions = require "nvim-tree.actions"
 local appearance_diagnostics = require "nvim-tree.appearance.diagnostics"
 local events = require "nvim-tree.events"
 local help = require "nvim-tree.help"
-local marks_navigation = require "nvim-tree.marks.navigation"
 local keymap = require "nvim-tree.keymap"
 local notify = require "nvim-tree.notify"
 
@@ -256,12 +255,12 @@ Api.marks.get = wrap_node(wrap_explorer_member("marks", "get"))
 Api.marks.list = wrap_explorer_member("marks", "list")
 Api.marks.toggle = wrap_node(wrap_explorer_member("marks", "toggle"))
 Api.marks.clear = wrap_explorer_member("marks", "clear")
-Api.marks.bulk.delete = wrap_explorer_member("marks", "delete")
-Api.marks.bulk.trash = wrap_explorer_member("marks", "trash")
-Api.marks.bulk.move = wrap_explorer_member("marks", "move")
-Api.marks.navigate.next = wrap(marks_navigation.next)
-Api.marks.navigate.prev = wrap(marks_navigation.prev)
-Api.marks.navigate.select = wrap(marks_navigation.select)
+Api.marks.bulk.delete = wrap_explorer_member("marks", "bulk_delete")
+Api.marks.bulk.trash = wrap_explorer_member("marks", "bulk_trash")
+Api.marks.bulk.move = wrap_explorer_member("marks", "bulk_move")
+Api.marks.navigate.next = wrap_explorer_member("marks", "navigate_next")
+Api.marks.navigate.prev = wrap_explorer_member("marks", "navigate_prev")
+Api.marks.navigate.select = wrap_explorer_member("marks", "navigate_select")
 
 Api.config.mappings.get_keymap = wrap(keymap.get_keymap)
 Api.config.mappings.get_keymap_default = wrap(keymap.get_keymap_default)

lua/nvim-tree/explorer/init.lua

@@ -3,7 +3,7 @@ local notify = require "nvim-tree.notify"
 local watch = require "nvim-tree.explorer.watch"
 local explorer_node = require "nvim-tree.explorer.node"
 local Filters = require "nvim-tree.explorer.filters"
-local Marks = require "nvim-tree.marks"
+local Marks = {} -- circular dependencies
 local LiveFilter = require "nvim-tree.explorer.live-filter"
 local Sorters = require "nvim-tree.explorer.sorters"
 
@@ -85,6 +85,8 @@ function M.setup(opts)
   require("nvim-tree.explorer.explore").setup(opts)
   require("nvim-tree.explorer.reload").setup(opts)
   require("nvim-tree.explorer.watch").setup(opts)
+
+  Marks = require "nvim-tree.marks"
 end
 
 M.Explorer = Explorer

lua/nvim-tree/marks/init.lua

@@ -1,10 +1,12 @@
-local core = {} -- circular dependency
-local lib = {} -- circular dependency
+local Iterator = require "nvim-tree.iterators.node-iterator"
+local core = require "nvim-tree.core"
+local lib = require "nvim-tree.lib"
 local notify = require "nvim-tree.notify"
-local remove_file = {} -- circular dependency
-local rename_file = {} -- circular dependency
-local trash = {} -- circular dependency
-local renderer = {} -- circular dependency
+local open_file = require "nvim-tree.actions.node.open-file"
+local remove_file = require "nvim-tree.actions.fs.remove-file"
+local rename_file = require "nvim-tree.actions.fs.rename-file"
+local renderer = require "nvim-tree.renderer"
+local trash = require "nvim-tree.actions.fs.trash"
 local utils = require "nvim-tree.utils"
 
 ---@class Marks
@@ -84,7 +86,7 @@ end
 
 ---Delete marked; each removal will be optionally notified
 ---@public
-function Marks:delete()
+function Marks:bulk_delete()
   if not next(self.marks) then
     notify.warn "No bookmarks to delete."
     return
@@ -113,7 +115,7 @@ end
 
 ---Trash marked; each removal will be optionally notified
 ---@public
-function Marks:trash()
+function Marks:bulk_trash()
   if not next(self.marks) then
     notify.warn "No bookmarks to trash."
     return
@@ -142,7 +144,7 @@ end
 
 ---Move marked
 ---@public
-function Marks:move()
+function Marks:bulk_move()
   if not next(self.marks) then
     notify.warn "No bookmarks to move."
     return
@@ -183,13 +185,89 @@ function Marks:move()
   end)
 end
 
-function Marks.setup()
-  core = require "nvim-tree.core"
-  lib = require "nvim-tree.lib"
-  remove_file = require "nvim-tree.actions.fs.remove-file"
-  rename_file = require "nvim-tree.actions.fs.rename-file"
-  renderer = require "nvim-tree.renderer"
-  trash = require "nvim-tree.actions.fs.trash"
+---Focus nearest marked node in direction.
+---@private
+---@param up boolean
+function Marks:navigate(up)
+  local node = lib.get_node_at_cursor()
+  if not node then
+    return
+  end
+
+  local first, prev, next, last = nil, nil, nil, nil
+  local found = false
+
+  Iterator.builder(self.explorer.nodes)
+    :recursor(function(n)
+      return n.open and n.nodes
+    end)
+    :applier(function(n)
+      if n.absolute_path == node.absolute_path then
+        found = true
+        return
+      end
+
+      if not self:get(n) then
+        return
+      end
+
+      last = n
+      first = first or n
+
+      if found and not next then
+        next = n
+      end
+
+      if not found then
+        prev = n
+      end
+    end)
+    :iterate()
+
+  if not found then
+    return
+  end
+
+  if up then
+    utils.focus_node_or_parent(prev or last)
+  else
+    utils.focus_node_or_parent(next or first)
+  end
+end
+
+---@public
+function Marks:navigate_prev()
+  self:navigate(true)
+end
+
+---@public
+function Marks:navigate_next()
+  self:navigate(false)
+end
+
+---Prompts for selection of a marked node, sorted by absolute paths.
+---A folder will be focused, a file will be opened.
+---@public
+function Marks:navigate_select()
+  local list = vim.tbl_map(function(n)
+    return n.absolute_path
+  end, self:list())
+
+  table.sort(list)
+
+  vim.ui.select(list, {
+    prompt = "Select a file to open or a folder to focus",
+  }, function(choice)
+    if not choice or choice == "" then
+      return
+    end
+    local node = self:get { absolute_path = choice }
+    if node and not node.nodes and not utils.get_win_buf_from_path(node.absolute_path) then
+      open_file.fn("edit", node.absolute_path)
+    elseif node then
+      utils.focus_file(node.absolute_path)
+    end
+  end)
 end
 
 return Marks