feat(filesystem): support .neotreeignore, .ignore, etc. (#1868)

Author: pynappo

README.md

@@ -462,6 +462,13 @@ require("neo-tree").setup({
       visible = false, -- when true, they will just be displayed differently than normal items
       hide_dotfiles = true,
       hide_gitignored = true,
+      hide_ignored = true, -- hide files that are ignored by other gitignore-like files
+      -- other gitignore-like files, in descending order of precedence.
+      ignore_files = {
+        ".neotreeignore",
+        -- ".ignore"
+        -- ".rgignore"
+      },
       hide_hidden = true, -- only works on Windows for hidden files/directories
       hide_by_name = {
         --"node_modules"

lua/neo-tree/defaults.lua

@@ -279,6 +279,12 @@ local config = {
       text_format = " ➛ %s", -- %s will be replaced with the symlink target's path.
     },
   },
+  -- The renderer section provides the renderers that will be used to render the tree.
+  --   The first level is the node type.
+  --   For each node type, you can specify a list of components to render.
+  --       Components are rendered in the order they are specified.
+  --         The first field in each component is the name of the function to call.
+  --         The rest of the fields are passed to the function as the "config" argument.
   renderers = {
     directory = {
       { "indent" },
@@ -503,22 +509,24 @@ local config = {
       sidebar = "tab",   -- sidebar is when position = left or right
       current = "window" -- current is when position = current
     },
-    check_gitignore_in_search = true, -- check gitignore status for files/directories when searching
-                                      -- setting this to false will speed up searches, but gitignored
-                                      -- items won't be marked if they are visible.
-    -- The renderer section provides the renderers that will be used to render the tree.
-    --   The first level is the node type.
-    --   For each node type, you can specify a list of components to render.
-    --       Components are rendered in the order they are specified.
-    --         The first field in each component is the name of the function to call.
-    --         The rest of the fields are passed to the function as the "config" argument.
+    -- check gitignore status for files/directories when searching.
+    -- setting this to false will speed up searches, but gitignored
+    -- items won't be marked if they are visible.
+    check_gitignore_in_search = true,
     filtered_items = {
       visible = false, -- when true, they will just be displayed differently than normal items
       force_visible_in_empty_folder = false, -- when true, hidden files will be shown if the root folder is otherwise empty
       children_inherit_highlights = true, -- whether children of filtered parents should inherit their parent's highlight group
       show_hidden_count = true, -- when true, the number of hidden items in each folder will be shown as the last entry
       hide_dotfiles = true,
       hide_gitignored = true,
+      hide_ignored = true, -- hide files that are ignored by other gitignore-like files
+      -- other gitignore-like files, in descending order of precedence.
+      ignore_files = {
+        ".neotreeignore",
+        ".ignore"
+        -- ".rgignore"
+      },
       hide_hidden = true, -- only works on Windows for hidden files/directories
       hide_by_name = {
         ".DS_Store",

lua/neo-tree/git/ignored.lua

@@ -46,6 +46,8 @@ end
 
 ---@param state neotree.State
 ---@param items neotree.FileItem[]
+---@param callback fun(results: string[])
+---@overload fun(state: neotree.State, items: neotree.FileItem[]):string[]
 M.mark_ignored = function(state, items, callback)
   local folders = {}
   log.trace("================================================================================")
@@ -54,50 +56,50 @@ M.mark_ignored = function(state, items, callback)
   for _, item in ipairs(items) do
     local folder = utils.split_path(item.path)
     if folder then
-      if not folders[folder] then
-        folders[folder] = {}
-      end
+      folders[folder] = folders[folder] or {}
       table.insert(folders[folder], item.path)
     end
   end
 
-  local function process_result(result)
+  ---@param results string[]
+  local function process_results(results)
     if utils.is_windows then
       --on Windows, git seems to return quotes and double backslash "path\\directory"
-      result = vim.tbl_map(function(item)
+      ---@param item string
+      results = vim.tbl_map(function(item)
         item = item:gsub("\\\\", "\\")
         return item
-      end, result)
+      end, results)
     else
       --check-ignore does not indicate directories the same as 'status' so we need to
       --add the trailing slash to the path manually if not on Windows.
-      log.trace("IGNORED: Checking types of", #result, "items to see which ones are directories")
-      for i, item in ipairs(result) do
+      log.trace("IGNORED: Checking types of", #results, "items to see which ones are directories")
+      for i, item in ipairs(results) do
         local stat = uv.fs_stat(item)
         if stat and stat.type == "directory" then
-          result[i] = item .. sep
+          results[i] = item .. sep
         end
       end
     end
-    result = vim.tbl_map(function(item)
+    ---@param item string
+    results = vim.tbl_map(function(item)
+      item = item:gsub("\\\\", "\\")
       -- remove leading and trailing " from git output
       item = item:gsub('^"', ""):gsub('"$', "")
       -- convert octal encoded lines to utf-8
       item = git_utils.octal_to_utf8(item)
       return item
-    end, result)
-    return result
+    end, results)
+    return results
   end
 
+  ---@param all_results string[]
   local function finalize(all_results)
-    local show_gitignored = state.filtered_items and state.filtered_items.hide_gitignored == false
-    log.trace("IGNORED: Comparing results to mark items as ignored:", show_gitignored)
     local ignored, not_ignored = 0, 0
     for _, item in ipairs(items) do
       if M.is_ignored(all_results, item.path, item.type) then
         item.filtered_by = item.filtered_by or {}
         item.filtered_by.gitignored = true
-        item.filtered_by.show_gitignored = show_gitignored
         ignored = ignored + 1
       else
         not_ignored = not_ignored + 1
@@ -107,6 +109,7 @@ M.mark_ignored = function(state, items, callback)
     log.trace("================================================================================")
   end
 
+  ---@type string[]
   local all_results = {}
   if type(callback) == "function" then
     local jobs = {}
@@ -145,14 +148,14 @@ M.mark_ignored = function(state, items, callback)
           log.trace("IGNORED: Running async git with args: ", args)
         end,
         on_exit = function(self, code, _)
-          local result
+          local results
           if code ~= 0 then
             log.debug("Failed to load ignored files for", folder, ":", self:stderr_result())
-            result = {}
+            results = {}
           else
-            result = self:result()
+            results = self:result()
           end
-          vim.list_extend(all_results, process_result(result))
+          vim.list_extend(all_results, process_results(results))
 
           running_jobs = running_jobs - 1
           completed_jobs = completed_jobs + 1
@@ -173,7 +176,7 @@ M.mark_ignored = function(state, items, callback)
         log.debug("Failed to load ignored files for", state.path, ":", result)
         result = {}
       end
-      vim.list_extend(all_results, process_result(result))
+      vim.list_extend(all_results, process_results(result))
     end
     finalize(all_results)
     return all_results

lua/neo-tree/health/init.lua

@@ -234,6 +234,7 @@ function M.check_config(config)
           validate("show_hidden_count", f.show_hidden_count, "boolean")
           validate("hide_dotfiles", f.hide_dotfiles, "boolean")
           validate("hide_gitignored", f.hide_gitignored, "boolean")
+          validate("hide_ignored", f.hide_ignored, "boolean")
           validate("hide_hidden", f.hide_hidden, "boolean")
           validate("hide_by_name", f.hide_by_name, v.array("string"))
           validate("hide_by_pattern", f.hide_by_pattern, v.array("string"))

lua/neo-tree/sources/common/components.lua

@@ -337,6 +337,7 @@ end
 
 ---@class neotree.Component.Common.FilteredBy
 ---@field [1] "filtered_by"?
+---@param node neotree.FileNode
 M.filtered_by = function(_, node, state)
   local fby = node.filtered_by
   if not state.filtered_items or type(fby) ~= "table" then
@@ -363,6 +364,11 @@ M.filtered_by = function(_, node, state)
         text = "(dotfile)",
         highlight = highlights.DOTFILE,
       }
+    elseif fby.ignored then
+      return {
+        text = ("(ignored by )"):format(fby.ignore_file),
+        highlight = highlights.IGNORED,
+      }
     elseif fby.hidden then
       return {
         text = "(hidden)",

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

@@ -115,8 +115,11 @@ local create_item, set_parents
 ---@field dotfiles boolean?
 ---@field hidden boolean?
 ---@field gitignored boolean?
+---@field ignore_file string?
+---@field ignored boolean?
 ---@field parent neotree.FileItemFilters?
 ---@field show_gitignored boolean?
+---@field show_ignored boolean?
 
 ---@class (exact) neotree.FileItemExtra
 ---@field status string? Git status
@@ -318,7 +321,7 @@ end
 ---@field folders table<string, neotree.FileItem.Directory|neotree.FileItem.Link?>
 ---@field nesting neotree.FileItem[]
 ---@field item_exists table<string, boolean?>
----@field all_items table<string, neotree.FileItem?>
+---@field all_items neotree.FileItem[]?
 ---@field path_to_reveal string?
 
 ---Create context to be used in other file-items functions.

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

@@ -292,6 +292,8 @@ end
 ---@field show_hidden_count boolean?
 ---@field hide_dotfiles boolean?
 ---@field hide_gitignored boolean?
+---@field hide_ignored boolean?
+---@field ignore_files string[]?
 ---@field hide_hidden boolean?
 ---@field hide_by_name string[]?
 ---@field hide_by_pattern string[]?
@@ -351,19 +353,22 @@ M.setup = function(config, global_config)
   config.filtered_items = config.filtered_items or {}
   config.enable_git_status = config.enable_git_status or global_config.enable_git_status
 
-  for _, key in ipairs({ "hide_by_pattern", "always_show_by_pattern", "never_show_by_pattern" }) do
-    local list = config.filtered_items[key]
-    if type(list) == "table" then
+  local filtered = config.filtered_items
+  if filtered then
+    for _, list in ipairs({
+      filtered.hide_by_pattern or {},
+      filtered.always_show_by_pattern or {},
+      filtered.never_show_by_pattern or {},
+    }) do
       for i, pattern in ipairs(list) do
         list[i] = glob.globtopattern(pattern)
       end
     end
-  end
-
-  for _, key in ipairs({ "hide_by_name", "always_show", "never_show" }) do
-    local list = config.filtered_items[key]
-    if type(list) == "table" then
-      config.filtered_items[key] = utils.list_to_dict(list)
+    for _, key in ipairs({ "hide_by_name", "always_show", "never_show" }) do
+      local list = filtered[key]
+      if type(list) == "table" then
+        filtered[key] = utils.list_to_dict(list)
+      end
     end
   end
 

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

@@ -11,6 +11,7 @@ local fs_watch = require("neo-tree.sources.filesystem.lib.fs_watch")
 local git = require("neo-tree.git")
 local events = require("neo-tree.events")
 local async = require("plenary.async")
+local ignored = require("neo-tree.sources.filesystem.lib.ignored")
 
 local M = {}
 
@@ -117,7 +118,7 @@ end
 local should_check_gitignore = function(context)
   local state = context.state
   if #context.all_items == 0 then
-    log.info("No items, skipping git ignored/status lookups")
+    log.debug("No items, skipping git ignored/status lookups")
     return false
   end
   if state.search_pattern and state.check_gitignore_in_search == false then
@@ -132,6 +133,7 @@ local should_check_gitignore = function(context)
   return true
 end
 
+---@param context neotree.sources.filesystem.Context
 local job_complete_async = function(context)
   local state = context.state
   local parent_id = context.parent_id
@@ -144,6 +146,8 @@ local job_complete_async = function(context)
   -- end
   if should_check_gitignore(context) then
     local mark_ignored_async = async.wrap(function(_state, _all_items, _callback)
+      ---lua-ls can't narrow this properly
+      ---@diagnostic disable-next-line: redundant-parameter
       git.mark_ignored(_state, _all_items, _callback)
     end, 3)
     local all_items = mark_ignored_async(state, context.all_items)
@@ -154,17 +158,23 @@ local job_complete_async = function(context)
       state.git_ignored = all_items
     end
   end
+
+  ignored.mark_ignored(state, context.all_items)
   return context
 end
 
+---@param context neotree.sources.filesystem.Context
 local job_complete = function(context)
   local state = context.state
   local parent_id = context.parent_id
 
   file_nesting.nest_items(context)
 
+  ignored.mark_ignored(state, context.all_items)
   if should_check_gitignore(context) then
     if require("neo-tree").config.git_status_async then
+      ---lua-ls can't narrow this properly
+      ---@diagnostic disable-next-line: redundant-parameter
       git.mark_ignored(state, context.all_items, function(all_items)
         if parent_id then
           vim.list_extend(state.git_ignored, all_items)
@@ -352,14 +362,14 @@ local function async_scan(context, path)
 
   -- from https://github.com/nvim-lua/plenary.nvim/blob/master/lua/plenary/scandir.lua
   local function read_dir(current_dir, ctx)
-    uv.fs_opendir(current_dir, function(err, dir)
-      if err then
-        log.error(current_dir, ": ", err)
+    uv.fs_opendir(current_dir, function(openerr, dir)
+      if openerr then
+        log.error(current_dir, ": ", openerr)
         return
       end
-      local function on_fs_readdir(err, entries)
-        if err then
-          log.error(current_dir, ": ", err)
+      local function on_fs_readdir(readerr, entries)
+        if readerr then
+          log.error(current_dir, ": ", readerr)
           return
         end
         if entries then
@@ -605,6 +615,7 @@ end
 ---@field is_a_never_show_file fun(filename: string?):boolean
 
 ---@class neotree.sources.filesystem.State : neotree.StateWithTree, neotree.Config.Filesystem
+---@field git_ignored neotree.FileItem[]
 ---@field path string
 
 ---@param state neotree.sources.filesystem.State