feat(filesystem): add never_show_by_pattern option, closes #527

Author: cseickel

README.md

@@ -261,6 +261,9 @@ use {
               --".DS_Store",
               --"thumbs.db"
             },
+            never_show_by_pattern = { -- uses glob style patterns
+              --".null-ls_*",
+            },
           },
           follow_current_file = false, -- This will find and focus the file in the active buffer every
                                        -- time the current file is changed while the tree is open.

doc/neo-tree.txt

@@ -798,6 +798,9 @@ highlight group which will be applied when they are visible, see
             --".DS_Store",
             --"thumbs.db",
           },
+          never_show_by_pattern = { -- uses glob style patterns
+              --".null-ls_*",
+          },
         },
       }
     })
@@ -828,6 +831,10 @@ The `never_show` option is the same as `hide_by_name`, except that those items
 will remain hidden even if you toggle `visible` to true. This section takes
 precedence over the others.
 
+The `never_show_by_pattern` option is the same as `hide_by_pattern`, except that
+those items will remain hidden even if you toggle `visible` to true. This
+section takes precedence over the others.
+
 
 NETRW HIJACK BEHAVIOR                                    *neo-tree-netrw-hijack*
 

lua/neo-tree/defaults.lua

@@ -396,6 +396,9 @@ local config = {
         --".DS_Store",
         --"thumbs.db"
       },
+      never_show_by_pattern = { -- uses glob style patterns
+        --".null-ls_*",
+      },
     },
     find_by_full_path_words = false,  -- `false` means it only searches the tail of a path.
                                       -- `true` will change the filter into a full path

lua/neo-tree/sources/common/file-items.lua

@@ -112,6 +112,11 @@ function create_item(context, path, _type)
     if f.never_show[name] then
       item.filtered_by = item.filtered_by or {}
       item.filtered_by.never_show = true
+    else
+      if utils.is_filtered_by_pattern(f.never_show_by_pattern, path, name) then
+        item.filtered_by = item.filtered_by or {}
+        item.filtered_by.never_show = true
+      end
     end
     if f.always_show[name] then
       item.filtered_by = item.filtered_by or {}
@@ -121,15 +126,9 @@ function create_item(context, path, _type)
       item.filtered_by = item.filtered_by or {}
       item.filtered_by.name = true
     end
-    if f.hide_by_pattern then
-      for _, p in ipairs(f.hide_by_pattern) do
-        local separator_pattern = utils.is_windows and "\\" or "/"
-        local match = string.find(p, separator_pattern) and path or name
-        if string.find(match, p) then
-          item.filtered_by = item.filtered_by or {}
-          item.filtered_by.pattern = true
-        end
-      end
+    if utils.is_filtered_by_pattern(f.hide_by_pattern, path, name) then
+      item.filtered_by = item.filtered_by or {}
+      item.filtered_by.pattern = true
     end
     if f.hide_dotfiles and string.sub(name, 1, 1) == "." then
       item.filtered_by = item.filtered_by or {}

lua/neo-tree/sources/filesystem/init.lua

@@ -9,6 +9,7 @@ local events = require("neo-tree.events")
 local log = require("neo-tree.log")
 local manager = require("neo-tree.sources.manager")
 local git = require("neo-tree.git")
+local glob = require("neo-tree.sources.filesystem.lib.globtopattern")
 
 local M = { name = "filesystem" }
 
@@ -257,12 +258,12 @@ M.setup = function(config, global_config)
   config.filtered_items = config.filtered_items or {}
   config.enable_git_status = global_config.enable_git_status
 
-  local hide_by_pattern = config.filtered_items.hide_by_pattern
-  if hide_by_pattern then
-    local glob = require("neo-tree.sources.filesystem.lib.globtopattern")
-    for i, pattern in ipairs(hide_by_pattern) do
-      hide_by_pattern[i] = glob.globtopattern(pattern)
-      log.trace("hide_by_pattern: ", pattern, " -> ", hide_by_pattern[i])
+  for _, key in ipairs({ "hide_by_pattern", "never_show_by_pattern" }) do
+    local list = config.filtered_items[key]
+    if type(list) == "table" then
+      for i, pattern in ipairs(list) do
+        list[i] = glob.globtopattern(pattern)
+      end
     end
   end
 

lua/neo-tree/sources/filesystem/lib/fs_scan.lua

@@ -8,6 +8,7 @@ local file_items = require("neo-tree.sources.common.file-items")
 local log = require("neo-tree.log")
 local fs_watch = require("neo-tree.sources.filesystem.lib.fs_watch")
 local git = require("neo-tree.git")
+local events = require("neo-tree.events")
 
 local Path = require("plenary.path")
 local os_sep = Path.path.sep
@@ -23,13 +24,22 @@ local on_directory_loaded = function(context, dir_path)
   if state.use_libuv_file_watcher then
     local root = context.folders[dir_path]
     if root then
-      if root.is_link then
-        log.trace("Adding fs watcher for ", root.link_to)
-        fs_watch.watch_folder(root.link_to)
-      else
-        log.trace("Adding fs watcher for ", root.path)
-        fs_watch.watch_folder(root.path)
-      end
+      local target_path = root.is_link and root.link_to or root.path
+      local fs_watch_callback = vim.schedule_wrap(function(err, fname)
+        if err then
+          log.error("file_event_callback: ", err)
+          return
+        end
+        if context.is_a_never_show_file(fname) then
+          -- don't fire events for nodes that are designated as "never show"
+          return
+        else
+          events.fire_event(events.FS_EVENT, { afile = target_path })
+        end
+      end)
+
+      log.trace("Adding fs watcher for ", target_path)
+      fs_watch.watch_folder(target_path, fs_watch_callback)
     end
   end
 end
@@ -290,6 +300,22 @@ M.get_items = function(state, parent_id, path_to_reveal, callback, async, recurs
         context.paths_to_load = utils.unique(context.paths_to_load)
       end
     end
+
+    local filtered_items = state.filtered_items or {}
+    context.is_a_never_show_file = function(fname)
+      if fname then
+        local _, name = utils.split_path(fname)
+        if name then
+          if filtered_items.never_show and filtered_items.never_show[name] then
+            return true
+          end
+          if utils.is_filtered_by_pattern(filtered_items.never_show_by_pattern, fname, name) then
+            return true
+          end
+        end
+      end
+      return false
+    end
     if async then
       async_scan(context, path)
     else

lua/neo-tree/sources/filesystem/lib/fs_watch.lua

@@ -36,6 +36,8 @@ end
 
 ---Watch a directory for changes to it's children. Not recursive.
 ---@param path string The directory to watch.
+---@param custom_callback? function The callback to call when a change is detected.
+---@param allow_git_watch? boolean Allow watching of git folders.
 M.watch_folder = function(path, custom_callback, allow_git_watch)
   if not allow_git_watch then
     if path:find("/%.git$") or path:find("/%.git/") then
@@ -49,7 +51,7 @@ M.watch_folder = function(path, custom_callback, allow_git_watch)
     log.trace("Starting new fs watch on: ", path)
     local callback = custom_callback
       or vim.schedule_wrap(function(err, fname)
-        if fname and fname:match("^%._null-ls_.+") then
+        if fname and fname:match("^%.null[-]ls_.+") then
           -- null-ls temp file: https://github.com/jose-elias-alvarez/null-ls.nvim/pull/1075
           return
         end

lua/neo-tree/utils.lua

@@ -322,6 +322,28 @@ M.group_by = function(array, key)
   return result
 end
 
+---Determines if a file should be filtered by a given list of glob patterns.
+---@param pattern_list table The list of glob patterns to filter by.
+---@param path string The full path to the file.
+---@param name string|nil The name of the file.
+---@return boolean
+M.is_filtered_by_pattern = function(pattern_list, path, name)
+  if pattern_list == nil then
+    return false
+  end
+  if name == nil then
+    _, name = M.split_path(path)
+  end
+  for _, p in ipairs(pattern_list) do
+    local separator_pattern = M.is_windows and "\\" or "/"
+    local filename = string.find(p, separator_pattern) and path or name
+    if string.find(filename, p) then
+      return true
+    end
+  end
+  return false
+end
+
 M.is_floating = function(win_id)
   win_id = win_id or vim.api.nvim_get_current_win()
   local cfg = vim.api.nvim_win_get_config(win_id)