feat(#1850): add "no bookmark" filter (#2571)

* feat(#1850): add no bookmark filter

* feat(#1850): add no bookmark filter - style

lua/nvim-tree/actions/tree-modifiers/toggles.lua

@@ -31,6 +31,11 @@ function M.no_buffer()
   reload()
 end
 
+function M.no_bookmark()
+  filters.config.filter_no_bookmark = not filters.config.filter_no_bookmark
+  reload()
+end
+
 function M.dotfiles()
   filters.config.filter_dotfiles = not filters.config.filter_dotfiles
   reload()

lua/nvim-tree/api.lua

@@ -136,6 +136,8 @@ Api.tree.toggle_custom_filter = wrap(require("nvim-tree.actions.tree-modifiers.t
 
 Api.tree.toggle_hidden_filter = wrap(require("nvim-tree.actions.tree-modifiers.toggles").dotfiles)
 
+Api.tree.toggle_no_bookmark_filter = wrap(require("nvim-tree.actions.tree-modifiers.toggles").no_bookmark)
+
 Api.tree.toggle_help = wrap(require("nvim-tree.help").toggle)
 
 Api.tree.is_tree_buf = wrap(require("nvim-tree.utils").is_nvim_tree_buf)

lua/nvim-tree/explorer/filters.lua

@@ -1,4 +1,5 @@
 local utils = require "nvim-tree.utils"
+local marks = require "nvim-tree.marks"
 
 local M = {
   ignore_list = {},
@@ -69,6 +70,12 @@ local function dotfile(path)
   return M.config.filter_dotfiles and utils.path_basename(path):sub(1, 1) == "."
 end
 
+---@param path string
+---@param bookmarks table<string, boolean> absolute paths bookmarked
+local function bookmark(path, bookmarks)
+  return M.config.filter_no_bookmark and not bookmarks[path]
+end
+
 ---@param path string
 ---@return boolean
 local function custom(path)
@@ -103,17 +110,23 @@ end
 --- git_status: reference
 --- unloaded_bufnr: copy
 --- bufinfo: empty unless no_buffer set: vim.fn.getbufinfo { buflisted = 1 }
+--- bookmarks: absolute paths to boolean
 function M.prepare(git_status, unloaded_bufnr)
   local status = {
     git_status = git_status or {},
     unloaded_bufnr = unloaded_bufnr,
     bufinfo = {},
+    bookmarks = {},
   }
 
   if M.config.filter_no_buffer then
     status.bufinfo = vim.fn.getbufinfo { buflisted = 1 }
   end
 
+  for _, node in pairs(marks.get_marks()) do
+    status.bookmarks[node.absolute_path] = true
+  end
+
   return status
 end
 
@@ -127,7 +140,11 @@ function M.should_filter(path, status)
     return false
   end
 
-  return git(path, status.git_status) or buf(path, status.bufinfo, status.unloaded_bufnr) or dotfile(path) or custom(path)
+  return git(path, status.git_status)
+    or buf(path, status.bufinfo, status.unloaded_bufnr)
+    or dotfile(path)
+    or custom(path)
+    or bookmark(path, status.bookmarks)
 end
 
 function M.setup(opts)
@@ -137,6 +154,7 @@ function M.setup(opts)
     filter_git_ignored = opts.filters.git_ignored,
     filter_git_clean = opts.filters.git_clean,
     filter_no_buffer = opts.filters.no_buffer,
+    filter_no_bookmark = opts.filters.no_bookmark,
   }
 
   M.ignore_list = {}

lua/nvim-tree/keymap.lua

@@ -64,14 +64,15 @@ function M.default_on_attach(bufnr)
   vim.keymap.set('n', 'e',       api.fs.rename_basename,              opts('Rename: Basename'))
   vim.keymap.set('n', ']e',      api.node.navigate.diagnostics.next,  opts('Next Diagnostic'))
   vim.keymap.set('n', '[e',      api.node.navigate.diagnostics.prev,  opts('Prev Diagnostic'))
-  vim.keymap.set('n', 'F',       api.live_filter.clear,               opts('Clean Filter'))
-  vim.keymap.set('n', 'f',       api.live_filter.start,               opts('Filter'))
+  vim.keymap.set('n', 'F',       api.live_filter.clear,               opts('Live Filter: Clear'))
+  vim.keymap.set('n', 'f',       api.live_filter.start,               opts('Live Filter: Start'))
   vim.keymap.set('n', 'g?',      api.tree.toggle_help,                opts('Help'))
   vim.keymap.set('n', 'gy',      api.fs.copy.absolute_path,           opts('Copy Absolute Path'))
   vim.keymap.set('n', 'H',       api.tree.toggle_hidden_filter,       opts('Toggle Filter: Dotfiles'))
   vim.keymap.set('n', 'I',       api.tree.toggle_gitignore_filter,    opts('Toggle Filter: Git Ignore'))
   vim.keymap.set('n', 'J',       api.node.navigate.sibling.last,      opts('Last Sibling'))
   vim.keymap.set('n', 'K',       api.node.navigate.sibling.first,     opts('First Sibling'))
+  vim.keymap.set('n', 'M',       api.tree.toggle_no_bookmark_filter,  opts('Toggle Filter: No Bookmark'))
   vim.keymap.set('n', 'm',       api.marks.toggle,                    opts('Toggle Bookmark'))
   vim.keymap.set('n', 'o',       api.node.open.edit,                  opts('Open'))
   vim.keymap.set('n', 'O',       api.node.open.no_window_picker,      opts('Open: No Window Picker'))