fix(git): remove git_status_source option, only use check-ignore, fixes #193

Author: cseickel

lua/neo-tree/defaults.lua

@@ -189,7 +189,6 @@ local config = {
         --".DS_Store",
         --"thumbs.db"
       },
-      gitignore_source = "git check-ignored", -- or "git status", which may be faster in some repos
     },
     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/setup/deprecations.lua

@@ -41,6 +41,14 @@ M.migrate = function (config)
     end
   end
 
+  local removed = function(key)
+    local value = utils.get_value(config, key)
+    if type(value) ~= "nil" then
+      utils.set_value(config, key, nil)
+      migrations[#migrations + 1] = string.format("The `%s` option has been removed.", key)
+    end
+  end
+
   local renamed_value = function(key, old_value, new_value)
     local value = utils.get_value(config, key)
     if value == old_value then
@@ -56,7 +64,8 @@ M.migrate = function (config)
   moved("filesystem.filters", "filesystem.filtered_items")
   moved("filesystem.filters.show_hidden", "filesystem.filtered_items.hide_dotfiles", opposite)
   moved("filesystem.filters.respect_gitignore", "filesystem.filtered_items.hide_gitignored")
-  moved("filesystem.filters.gitignore_source", "filesystem.filtered_items.gitignore_source")
+  removed("filesystem.filters.gitignore_source")
+  removed("filesystem.filter_items.gitignore_source")
   renamed_value("filesystem.hijack_netrw_behavior", "open_split", "open_current")
   for _, source in ipairs({"filesystem", "buffers", "git_status"}) do
     renamed_value(source .. "window.position", "split", "current")

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

@@ -152,20 +152,16 @@ M.get_items_async = function(state, parent_id, path_to_reveal, callback)
       local f = state.filtered_items or {}
       local ignored = {}
       if f.hide_gitignored then
-        if f.gitignore_source == "git status" then
-          ignored = git.load_ignored(state.path)
-        elseif f.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
+        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
       state.git_ignored = ignored
     else
       -- just update the ignored list for this dir if we are using the per dir 'check-ignore' option
       local f = state.filtered_items or {}
-      if f.hide_gitignored and f.gitignore_source == "git check-ignore" then
+      if f.hide_gitignored then
         state.git_ignored = state.git_ignored or {}
         vim.list_extend(state.git_ignored, git.load_ignored_per_directory(parent_id))
       end

lua/neo-tree/ui/highlights.lua

@@ -107,19 +107,6 @@ M.setup = function()
   create_highlight_group(M.FLOAT_TITLE, {}, float_border_hl.background, normal_hl.foreground)
   create_highlight_group(M.TITLE_BAR, {}, float_border_hl.foreground, nil)
 
-  local added = create_highlight_group(
-    M.GIT_ADDED,
-    { "GitGutterAdd", "GitSignsAdd" },
-    nil,
-    "5faf5f"
-  )
-  create_highlight_group(M.GIT_DELETED, { "GitGutterDelete", "GitSignsDelete" }, nil, "ff5900")
-  create_highlight_group(M.GIT_MODIFIED, { "GitGutterChange", "GitSignsChange" }, nil, "d7af5f")
-  local conflict = create_highlight_group(M.GIT_CONFLICT, {}, nil, "ff8700", "italic,bold")
-  create_highlight_group(M.GIT_IGNORED, { M.DOTFILE }, nil, nil)
-  create_highlight_group(M.GIT_RENAMED, { M.GIT_MODIFIED }, nil, nil)
-  create_highlight_group(M.GIT_UNTRACKED, {}, nil, conflict.foreground, "italic")
-
   create_highlight_group(M.BUFFER_NUMBER, { "SpecialChar" })
   create_highlight_group(M.DIM_TEXT, {}, nil, "505050")
   create_highlight_group(M.DOTFILE, {}, nil, "626262")
@@ -135,6 +122,19 @@ M.setup = function()
   create_highlight_group(M.ROOT_NAME, {}, nil, nil, "bold,italic")
   create_highlight_group(M.INDENT_MARKER, { M.DIM_TEXT })
   create_highlight_group(M.EXPANDER, { M.DIM_TEXT })
+
+  local added = create_highlight_group(
+    M.GIT_ADDED,
+    { "GitGutterAdd", "GitSignsAdd" },
+    nil,
+    "5faf5f"
+  )
+  create_highlight_group(M.GIT_DELETED, { "GitGutterDelete", "GitSignsDelete" }, nil, "ff5900")
+  create_highlight_group(M.GIT_MODIFIED, { "GitGutterChange", "GitSignsChange" }, nil, "d7af5f")
+  local conflict = create_highlight_group(M.GIT_CONFLICT, {}, nil, "ff8700", "italic,bold")
+  create_highlight_group(M.GIT_IGNORED, { M.DOTFILE }, nil, nil)
+  create_highlight_group(M.GIT_RENAMED, { M.GIT_MODIFIED }, nil, nil)
+  create_highlight_group(M.GIT_UNTRACKED, {}, nil, conflict.foreground, "italic")
 end
 
 return M