feat(files): add option to use "git check-ignore" for gitignore checks, fixes #147

Author: cseickel

lua/neo-tree/defaults.lua

@@ -153,7 +153,7 @@ local config = {
     filters = {
       show_hidden = false,
       respect_gitignore = true,
-      gitignore_source = "git", -- or "plenary", which may be faster in a slow repo but less accurate
+      gitignore_source = "git status", -- or "git check-ignored", which may be faster in some repos
     },
     bind_to_cwd = true, -- true creates a 2-way binding between vim's cwd and neo-tree's root
     -- The renderer section provides the renderers that will be used to render the tree.

lua/neo-tree/git/init.lua

@@ -1,5 +1,6 @@
 local Path = require("plenary.path")
 local utils = require("neo-tree.utils")
+local log = require("neo-tree.log")
 
 local os_sep = Path.path.sep
 
@@ -124,6 +125,24 @@ M.status = function(exclude_directories)
   return git_status, git_root
 end
 
+M.load_ignored_per_directory = function(path)
+  if type(path) ~= "string" then
+    log.error("load_ignored_per_directory: path must be a string")
+    return {}
+  end
+  path = utils.path_join(path, "*")
+  local cmd = 'git check-ignore "' .. path .. '"'
+  local result = vim.fn.systemlist(cmd)
+  if vim.v.shell_error == 128 then
+    if utils.truthy(result) and vim.startswith(result[1], "fatal: not a git repository") then
+      return {}
+    end
+    log.error("Failed to load ignored files for ", path, ": ", result)
+    return {}
+  end
+  return result
+end
+
 M.load_ignored = function(path)
   local git_root = M.get_repository_root(path)
   if not git_root then

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

@@ -18,7 +18,7 @@ local function do_scan(context, path_to_scan)
   local paths_to_load = context.paths_to_load
   local folders = context.folders
   local filters = state.filters or {}
-  local use_gitignore_table = filters.respect_gitignore and filters.gitignore_source == "git"
+  local use_gitignore_table = filters.respect_gitignore and utils.truthy(state.git_ignored)
 
   scan.scan_dir_async(path_to_scan, {
     hidden = filters.show_hidden or false,
@@ -150,11 +150,18 @@ M.get_items_async = function(state, parent_id, path_to_reveal, callback)
         context.paths_to_load = utils.unique(context.paths_to_load)
       end
 
-      if state.filters.respect_gitignore and state.filters.gitignore_source == "git" then
-        state.git_ignored = git.load_ignored(state.path) or {}
-      else
-        state.git_ignored = {}
+      local ignored = {}
+      if state.filters.respect_gitignore then
+        if state.filters.gitignore_source == "git status" then
+          ignored = git.load_ignored(state.path)
+        elseif state.filters.gitignore_source == "git check-ignore" then
+          ignored = git.load_ignored_per_directory(state.path)
+          for _, p in ipairs(context.paths_to_load) do
+            vim.list_extend(ignored, git.load_ignored_per_directory(p))
+          end
+        end
       end
+      state.git_ignored = ignored
     end
     do_scan(context, parent_id or state.path)
   end

lua/neo-tree/utils.lua

@@ -329,6 +329,13 @@ M.is_subpath = function(base, path)
   return string.sub(path, 1, string.len(base)) == base
 end
 
+---The file system path separator for the current platform.
+M.path_separator = "/"
+M.is_windows = vim.fn.has("win32") == 1 or vim.fn.has("win32unix") == 1
+if M.is_windows == true then
+  M.path_separator = "\\"
+end
+
 ---Split string into a table of strings using a separator.
 ---@param inputString string The string to split.
 ---@param sep string The separator to use.
@@ -363,6 +370,27 @@ M.split_path = function(path)
   return parentPath, name
 end
 
+---Joins arbitrary number of paths together.
+---@param ... string The paths to join.
+---@return string
+M.path_join = function(...)
+  local args = { ... }
+  if #args == 0 then
+    return ""
+  end
+
+  local all_parts = {}
+  if type(args[1]) == "string" and args[1]:sub(1, 1) == M.path_separator then
+    all_parts[1] = ""
+  end
+
+  for _, arg in ipairs(args) do
+    arg_parts = M.split(arg, M.path_separator)
+    vim.list_extend(all_parts, arg_parts)
+  end
+  return table.concat(all_parts, M.path_separator)
+end
+
 local table_merge_internal
 ---Merges overrideTable into baseTable. This mutates baseTable.
 ---@param base_table table The base table that provides default values.