feat(view): add filters.no_buffer

Author: alex-courtis

doc/nvim-tree-lua.txt

@@ -304,9 +304,10 @@ Subsequent calls to setup will replace the previous configuration.
       },
       filters = {
         dotfiles = false,
+        git_clean = false,
+        no_buffer = false,
         custom = {},
         exclude = {},
-        git_clean = false,
       },
       filesystem_watchers = {
         enable = true,
@@ -893,6 +894,12 @@ Filtering options.
     *nvim-tree.filters.git_clean*
     Do not show files with no git status. This will show ignored files when
     |nvim-tree.git.ignore| is set, as they are effectively dirty.
+    Toggle via the `toggle_git_clean` action, default mapping `C`.
+      Type: `boolean`, Default: `false`
+
+    *nvim-tree.filters.no_buffer*
+    Do not show files that have no open buffer.
+    Toggle via the `toggle_no_buffer` action, default mapping `B`.
       Type: `boolean`, Default: `false`
 
     *nvim-tree.filters.custom*
@@ -1181,6 +1188,7 @@ exists.
     - expand_all
     - toggle_gitignore_filter
     - toggle_git_clean_filter
+    - toggle_no_buffer_filter
     - toggle_custom_filter
     - toggle_hidden_filter
     - toggle_help
@@ -1315,6 +1323,7 @@ DEFAULT MAPPINGS                                     *nvim-tree-default-mappings
 `C`               toggle_git_clean    toggle visibility of git clean via |filters.git_clean| option
 `I`               toggle_git_ignored  toggle visibility of files/folders hidden via |git.ignore| option
 `H`               toggle_dotfiles     toggle visibility of dotfiles via |filters.dotfiles| option
+`B`               toggle_no_buffer    toggle visibility of files/folders hidden via |filters.no_buffer| option
 `U`               toggle_custom       toggle visibility of files/folders hidden via |filters.custom| option
 `R`               refresh             refresh the tree
 `a`               create              add a file; leaving a trailing `/` will add a directory
@@ -1365,6 +1374,7 @@ DEFAULT MAPPINGS                                     *nvim-tree-default-mappings
     { key = "C",                              action = "toggle_git_clean" },
     { key = "I",                              action = "toggle_git_ignored" },
     { key = "H",                              action = "toggle_dotfiles" },
+    { key = "B",                              action = "toggle_no_buffer" },
     { key = "U",                              action = "toggle_custom" },
     { key = "R",                              action = "refresh" },
     { key = "a",                              action = "create" },

lua/nvim-tree.lua

@@ -582,9 +582,10 @@ local DEFAULT_OPTS = { -- BEGIN_DEFAULT_OPTS
   },
   filters = {
     dotfiles = false,
+    git_clean = false,
+    no_buffer = false,
     custom = {},
     exclude = {},
-    git_clean = false,
   },
   filesystem_watchers = {
     enable = true,

lua/nvim-tree/actions/dispatch.lua

@@ -13,6 +13,7 @@ local Actions = {
   toggle_custom = require("nvim-tree.actions.tree-modifiers.toggles").custom,
   toggle_git_ignored = require("nvim-tree.actions.tree-modifiers.toggles").git_ignored,
   toggle_git_clean = require("nvim-tree.actions.tree-modifiers.toggles").git_clean,
+  toggle_no_buffer = require("nvim-tree.actions.tree-modifiers.toggles").no_buffer,
 
   -- Filesystem operations
   copy_absolute_path = require("nvim-tree.actions.fs.copy-paste").copy_absolute_path,

lua/nvim-tree/actions/finders/search-node.lua

@@ -14,6 +14,8 @@ local function search(search_dir, input_path)
   local function iter(dir)
     local realpath, path, name, stat, handle, _
 
+    local bufinfo = vim.fn.getbufinfo { bufloaded = 1, buflisted = 1 }
+
     handle, _ = vim.loop.fs_scandir(dir)
     if not handle then
       return
@@ -34,7 +36,7 @@ local function search(search_dir, input_path)
         break
       end
 
-      if not filters.should_ignore(path) then
+      if not filters.should_ignore(path, bufinfo) then
         if string.find(path, "/" .. input_path .. "$") then
           return path
         end

lua/nvim-tree/actions/init.lua

@@ -91,6 +91,11 @@ local DEFAULT_MAPPINGS = {
     action = "toggle_dotfiles",
     desc = "toggle visibility of dotfiles via |filters.dotfiles| option",
   },
+  {
+    key = "B",
+    action = "toggle_no_buffer",
+    desc = "toggle visibility of files/folders hidden via |filters.no_buffer| option",
+  },
   {
     key = "U",
     action = "toggle_custom",

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

@@ -20,6 +20,11 @@ function M.git_clean()
   return reloaders.reload_explorer()
 end
 
+function M.no_buffer()
+  filters.config.filter_no_buffer = not filters.config.filter_no_buffer
+  return reloaders.reload_explorer()
+end
+
 function M.dotfiles()
   filters.config.filter_dotfiles = not filters.config.filter_dotfiles
   return reloaders.reload_explorer()

lua/nvim-tree/api.lua

@@ -39,6 +39,7 @@ Api.tree.collapse_all = require("nvim-tree.actions.tree-modifiers.collapse-all")
 Api.tree.expand_all = inject_node(require("nvim-tree.actions.tree-modifiers.expand-all").fn)
 Api.tree.toggle_gitignore_filter = require("nvim-tree.actions.tree-modifiers.toggles").git_ignored
 Api.tree.toggle_git_clean_filter = require("nvim-tree.actions.tree-modifiers.toggles").git_clean
+Api.tree.toggle_no_buffer_filter = require("nvim-tree.actions.tree-modifiers.toggles").no_buffer
 Api.tree.toggle_custom_filter = require("nvim-tree.actions.tree-modifiers.toggles").custom
 Api.tree.toggle_hidden_filter = require("nvim-tree.actions.tree-modifiers.toggles").dotfiles
 Api.tree.toggle_help = require("nvim-tree.actions.tree-modifiers.toggles").help

lua/nvim-tree/explorer/explore.lua

@@ -15,6 +15,7 @@ end
 local function populate_children(handle, cwd, node, status)
   local node_ignored = node.git_status == "!!"
   local nodes_by_path = utils.bool_record(node.nodes, "absolute_path")
+  local bufinfo = vim.fn.getbufinfo { bufloaded = 1, buflisted = 1 }
   while true do
     local name, t = vim.loop.fs_scandir_next(handle)
     if not name then
@@ -23,7 +24,11 @@ local function populate_children(handle, cwd, node, status)
 
     local abs = utils.path_join { cwd, name }
     t = get_type_from(t, abs)
-    if not filters.should_ignore(abs) and not filters.should_ignore_git(abs, status) and not nodes_by_path[abs] then
+    if
+      not filters.should_ignore(abs, bufinfo)
+      and not filters.should_ignore_git(abs, status)
+      and not nodes_by_path[abs]
+    then
       local child = nil
       if t == "directory" and vim.loop.fs_access(abs, "R") then
         child = builders.folder(node, abs, name)

lua/nvim-tree/explorer/filters.lua

@@ -16,14 +16,27 @@ end
 
 ---Check if the given path should be ignored.
 ---@param path string Absolute path
+---@param bufinfo table vim.fn.getbufinfo { bufloaded = 1, buflisted = 1 }
 ---@return boolean
-function M.should_ignore(path)
+function M.should_ignore(path, bufinfo)
   local basename = utils.path_basename(path)
 
+  -- exclusions override all filters
   if is_excluded(path) then
     return false
   end
 
+  -- filter files with no open buffer and directories containing no open buffers
+  if M.config.filter_no_buffer and type(bufinfo) == "table" then
+    for _, buf in ipairs(bufinfo) do
+      if buf.name:find(path, 1, true) then
+        return false
+      end
+    end
+    return true
+  end
+
+  -- filter dotfiles
   if M.config.filter_dotfiles then
     if basename:sub(1, 1) == "." then
       return true
@@ -34,6 +47,7 @@ function M.should_ignore(path)
     return false
   end
 
+  -- filter custom regexes
   local relpath = utils.path_relative(path, vim.loop.cwd())
   for pat, _ in pairs(M.ignore_list) do
     if vim.fn.match(relpath, pat) ~= -1 or vim.fn.match(basename, pat) ~= -1 then
@@ -56,20 +70,20 @@ function M.should_ignore_git(path, status)
     return false
   end
 
-  -- exclusions override all
+  -- exclusions override all filters
   if is_excluded(path) then
     return false
   end
 
-  -- default to clean
+  -- default status to clean
   local st = status.files[path] or status.dirs[path] or "  "
 
-  -- ignored overrides clean as they are effectively dirty
+  -- filter ignored; overrides clean as they are effectively dirty
   if M.config.filter_git_ignored and st == "!!" then
     return true
   end
 
-  -- clean last
+  -- filter clean
   if M.config.filter_git_clean and st == "  " then
     return true
   end
@@ -83,6 +97,7 @@ function M.setup(opts)
     filter_dotfiles = opts.filters.dotfiles,
     filter_git_ignored = opts.git.ignore,
     filter_git_clean = opts.filters.git_clean,
+    filter_no_buffer = opts.filters.no_buffer,
   }
 
   M.ignore_list = {}

lua/nvim-tree/explorer/reload.lua

@@ -44,6 +44,8 @@ function M.reload(node, status)
 
   local ps = log.profile_start("reload %s", node.absolute_path)
 
+  local bufinfo = vim.fn.getbufinfo { bufloaded = 1, buflisted = 1 }
+
   if node.group_next then
     node.nodes = { node.group_next }
     node.group_next = nil
@@ -71,7 +73,7 @@ function M.reload(node, status)
 
     local abs = utils.path_join { cwd, name }
     t = t or (fs_stat_cached(abs) or {}).type
-    if not filters.should_ignore(abs) and not filters.should_ignore_git(abs, status) then
+    if not filters.should_ignore(abs, bufinfo) and not filters.should_ignore_git(abs, status) then
       child_names[abs] = true
 
       -- Recreate node if type changes.