feat(marks): add navigation next and previous

Author: kyazdani42

doc/nvim-tree-lua.txt

@@ -1262,6 +1262,18 @@ You can toggle marks on files/folders with
 default.
 
 To get the list of marked paths, you can call
-`require("nvim-tree.marks").get_marks()`. This will return `{string}`.
+`require("nvim-tree.marks").get_marks()`. This will return `{node}`.
+
+*nvim-tree.bookmarks.navigation*
+
+Navigation for marks is not bound by default in nvim-tree because we don't
+want to focus the tree view each time we wish to switch to another mark.
+
+This requires binding bookmark navigation yourself.
+
+-- in your lua configuration
+vim.keymap.set("n", "<leader>mn", require("nvim-tree.marks.navigation").next)
+vim.keymap.set("n", "<leader>mp", require("nvim-tree.marks.navigation").prev)
+vim.keymap.set("n", "<leader>ms", require("nvim-tree.marks.navigation").select)
 
  vim:tw=78:ts=4:sw=4:et:ft=help:norl:

lua/nvim-tree/actions/fs/create-file.lua

@@ -8,13 +8,6 @@ local core = require "nvim-tree.core"
 
 local M = {}
 
-local function focus_file(file)
-  local _, i = utils.find_node(core.get_explorer().nodes, function(node)
-    return node.absolute_path == file
-  end)
-  require("nvim-tree.view").set_cursor { i + 1, 1 }
-end
-
 local function create_file(file)
   if utils.file_exists(file) then
     print(file .. " already exists. Overwrite? y/n")
@@ -112,7 +105,7 @@ function M.fn(node)
     end
     -- INFO: defer needed when reload is automatic (watchers)
     vim.defer_fn(function()
-      focus_file(new_file_path)
+      utils.focus_file(new_file_path)
     end, 150)
   end)
 end

lua/nvim-tree/marks.lua renamed to lua/nvim-tree/marks/init.lua

@@ -7,7 +7,7 @@ local NvimTreeMarks = {}
 local M = {}
 
 local function add_mark(node)
-  NvimTreeMarks[node.absolute_path] = true
+  NvimTreeMarks[node.absolute_path] = node
   M.draw()
 end
 
@@ -30,8 +30,8 @@ end
 
 function M.get_marks()
   local list = {}
-  for k in pairs(NvimTreeMarks) do
-    table.insert(list, k)
+  for _, n in pairs(NvimTreeMarks) do
+    table.insert(list, n)
   end
   return list
 end

lua/nvim-tree/marks/navigation.lua

@@ -0,0 +1,112 @@
+local Iterator = require "nvim-tree.iterators.node-iterator"
+local core = require "nvim-tree.core"
+local Marks = require "nvim-tree.marks"
+local open_file = require "nvim-tree.actions.node.open-file"
+local utils = require "nvim-tree.utils"
+local lib = require "nvim-tree.lib"
+
+local function get_prev_or_next_mark(node, idx_iter)
+  local found_idx = -1
+  local marks = Marks.get_marks()
+
+  for i, n in ipairs(marks) do
+    if n.absolute_path == node.absolute_path then
+      found_idx = i + idx_iter
+      break
+    end
+  end
+
+  if found_idx == -1 then
+    return
+  end
+
+  if found_idx > #marks then
+    found_idx = 1
+  elseif found_idx == 0 then
+    found_idx = #marks
+  end
+
+  return marks[found_idx]
+end
+
+local function get_nearest(node, where)
+  local prev = nil
+  local found = false
+
+  local next = Iterator.builder(core.get_explorer().nodes)
+    :matcher(function()
+      return found == true
+    end)
+    :recursor(function(n)
+      return n.open and n.nodes
+    end)
+    :applier(function(n)
+      if Marks.get_mark(n) then
+        prev = n
+      end
+      if n.absolute_path == node.absolute_path then
+        found = true
+      end
+    end)
+    :iterate()
+
+  if found then
+    if where == "next" then
+      return next
+    else
+      return prev
+    end
+  end
+end
+
+local function get(where, node)
+  if not node then
+    return Marks.get_marks()[1]
+  end
+
+  local is_next = where == "next"
+  if Marks.get_mark(node) then
+    return get_prev_or_next_mark(node, is_next and 1 or -1)
+  else
+    return get_nearest(node, where)
+  end
+end
+
+local function open_or_focus(node)
+  if node and not node.nodes then
+    open_file.fn("edit", node.absolute_path)
+  elseif next then
+    utils.focus_file(node.absolute_path)
+    end
+end
+
+local function navigate_to(where)
+  return function()
+    local node = lib.get_node_at_cursor()
+    local next = get(where, node)
+    open_or_focus(next)
+  end
+end
+
+local M = {}
+
+M.next = navigate_to "next"
+M.prev = navigate_to "prev"
+
+function M.select()
+  local list = vim.tbl_map(function(n)
+    return n.absolute_path
+  end, Marks.get_marks())
+
+  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 = Marks.get_mark { absolute_path = choice }
+    open_or_focus(node)
+  end)
+end
+
+return M

lua/nvim-tree/utils.lua

@@ -207,6 +207,13 @@ function M.rename_loaded_buffers(old_path, new_path)
   end
 end
 
+function M.focus_file(path)
+  local _, i = M.find_node(require("nvim-tree.core").get_explorer().nodes, function(node)
+    return node.absolute_path == path
+  end)
+  require("nvim-tree.view").set_cursor { i + 1, 1 }
+end
+
 --- @param path string path to file or directory
 --- @return boolean
 function M.file_exists(path)