WIP, breaking changes in filters config

Author: cseickel

lua/neo-tree.lua

@@ -523,6 +523,27 @@ end
 M.setup = function(config, is_auto_config)
   local default_config = vim.deepcopy(defaults)
   config = vim.deepcopy(config or {})
+
+  local messages = require("neo-tree.deprecations").migrate(config)
+  if #messages > 0 then
+    for i, message in ipairs(messages) do
+      messages[i] = "  * " .. message
+    end
+    table.insert(messages, 1, "# Neo-tree configuration has been updated. Please review the changes below.")
+    local buf = vim.api.nvim_create_buf(false, true)
+    vim.api.nvim_buf_set_lines(buf, 0, -1, false, messages)
+    vim.api.nvim_buf_set_option(buf, "buftype", "nofile")
+    vim.api.nvim_buf_set_option(buf, "bufhidden", "wipe")
+    vim.api.nvim_buf_set_option(buf, "buflisted", false)
+    vim.api.nvim_buf_set_option(buf, "swapfile", false)
+    vim.api.nvim_buf_set_option(buf, "modifiable", false)
+    vim.api.nvim_buf_set_option(buf, "filetype", "markdown")
+    vim.defer_fn(function ()
+      vim.cmd("split")
+      vim.api.nvim_win_set_buf(0, buf)
+    end, 1000)
+  end
+
   if config.log_level ~= nil then
     M.set_log_level(config.log_level)
   end

lua/neo-tree/defaults.lua

@@ -155,17 +155,28 @@ local config = {
     --  return args
     --end,
     search_limit = 50, -- max number of search results when using filters
-    filters = {
-      show_hidden = false,
-      respect_gitignore = true,
-      gitignore_source = "git status", -- or "git check-ignored", which may be faster in some repos
-      exclude_items = {}, -- List of item names to skip, such as:
-                          -- { 'node-module', '.DS_Store' }
-      show_filtered = { -- Instead of hiding them completely, show them with a different
-        exclude = true, -- highlight group
-        gitignore = true,
-        hidden = true
-      }
+    --filters = {
+    --  show_hidden = false,
+    --  respect_gitignore = true,
+    --  gitignore_source = "git status", -- or "git check-ignored", which may be faster in some repos
+    --  exclude_items = {}, -- List of item names to skip, such as:
+    --                      -- { 'node-module', '.DS_Store' }
+    --  show_filtered = { -- Instead of hiding them completely, show them with a different
+    --    exclude = true, -- highlight group
+    --    gitignore = true,
+    --    hidden = true
+    --},
+    filtered_items = {
+      visible = false, -- if true, they will just be displayed differently than normal items
+      hide_dotfiles = true,
+      hide_gitignored = true,
+      hide_by_name = {
+        "node_modules"
+      },
+      never_show = {
+        ".DS_Store",
+        "thumbs.db"
+      },
     },
     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/deprecations.lua

@@ -0,0 +1,32 @@
+local utils = require "neo-tree.utils"
+
+local migrate = function (config)
+  local messages = {}
+
+  local moved = function (old, new, converter)
+    local exising = utils.get_value(config, old)
+    if type(exising) ~= "nil" then
+      if type(converter) == "function" then
+        exising = converter(exising)
+      end
+      utils.set_value(config, new, exising)
+      config[old] = nil
+      messages[#messages + 1] = string.format("The `%s` option has been deprecated, please use `%s` instead.", old, new)
+    end
+  end
+
+  local opposite = function (value)
+    return not value
+  end
+
+  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")
+
+  return messages
+end
+
+return {
+  migrate = migrate
+}

lua/neo-tree/setup/init.lua

@@ -79,7 +79,11 @@ M.git_status = function(config, node, state)
   end
   local git_status = git_status_lookup[node.path]
   if not git_status then
-    return {}
+    if node.filtered_by and node.filtered_by.gitignored then
+      git_status = "!!"
+    else
+      return {}
+    end
   end
 
   local highlight = highlights.FILE_NAME
@@ -93,6 +97,8 @@ M.git_status = function(config, node, state)
     highlight = highlights.GIT_MODIFIED
   elseif git_status:match("[ACRT]") then
     highlight = highlights.GIT_ADDED
+  elseif git_status:match("!") then
+    highlight = highlights.GIT_IGNORED
   end
 
   return {
@@ -148,9 +154,15 @@ M.name = function(config, node, state)
     end
   end
 
-  if node.filtered_by and #node.filtered_by > 0 then
-    text = text .. " (" .. node.filtered_by .. ")"
-    highlight = highlights.DIM_TEXT
+  if type(node.filtered_by) == "table" then
+    local fby = node.filtered_by
+    if fby.name then
+      highlight = highlights.HIDDEN_BY_NAME
+    elseif fby.dotfiles then
+      highlight = highlights.DOTFILE
+    elseif fby.gitignored then
+      highlight = highlights.GIT_IGNORED
+    end
   end
 
   return {

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

@@ -55,19 +55,21 @@ function create_item(context, path, _type)
   end
 
   local state = context.state
-  local filters = state.filters
-  if filters then
-    local exclude = filters.exclude_items or {}
-    if exclude[name] then
+  local f = state.filtered_items
+  if f then
+    if f.hide_by_name[name] then
       item.filtered_by = item.filtered_by or {}
-      item.filtered_by.exclude = true
-    elseif not filters.show_hidden and string.sub(item.name, 1, 1) == "." then
+      item.filtered_by.name = true
+    elseif f.never_show[name] then
       item.filtered_by = item.filtered_by or {}
-      item.filtered_by.hidden = true
-    elseif filters.respect_gitignore and utils.truthy(state.git_ignored) then
+      item.filtered_by.never_show = true
+    elseif f.hide_dotfiles and string.sub(item.name, 1, 1) == "." then
+      item.filtered_by = item.filtered_by or {}
+      item.filtered_by.dotfiles = true
+    elseif f.hide_gitignored and utils.truthy(state.git_ignored) then
       if git.is_ignored(state.git_ignored, path, _type) then
         item.filtered_by = item.filtered_by or {}
-        item.filtered_by.gitignore = true
+        item.filtered_by.gitignored = true
       end
     end
   end

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

@@ -5,6 +5,7 @@ local fs = require("neo-tree.sources.filesystem")
 local utils = require("neo-tree.utils")
 local filter = require("neo-tree.sources.filesystem.lib.filter")
 local manager = require("neo-tree.sources.manager")
+local log = require("neo-tree.log")
 
 local M = {}
 local refresh = utils.wrap(manager.refresh, "filesystem")
@@ -111,14 +112,15 @@ M.show_debug_info = cc.show_debug_info
 
 ---Toggles whether hidden files are shown or not.
 M.toggle_hidden = function(state)
-  state.filters.show_hidden = not state.filters.show_hidden
+  state.filtered_items.visible = not state.filtered_items.visible
+  log.info("Toggling hidden files: " .. tostring(state.filtered_items.visible))
   refresh()
 end
 
 ---Toggles whether the tree is filtered by gitignore or not.
 M.toggle_gitignore = function(state)
-  state.filters.respect_gitignore = not state.filters.respect_gitignore
-  refresh()
+  log.warn("`toggle_gitignore` has been removed, running toggle_hidden instead.")
+  M.toggle_hidden(state)
 end
 
 return M

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

@@ -44,7 +44,7 @@ local get_find_command = function(state)
 end
 
 M.find_files = function(opts)
-  local filters = opts.filters
+  local filters = opts.filtered_items
   local limit = opts.limit or 200
   local cmd = get_find_command(opts)
   local path = opts.path
@@ -73,10 +73,10 @@ M.find_files = function(opts)
   end
 
   if cmd == "fd" or cmd == "fdfind" then
-    if filters.show_hidden then
+    if filters.visible or not filters.hide_dotfiles then
       append("--hidden")
     end
-    if not filters.respect_gitignore then
+    if filters.visible or not filters.hide_gitignored then
       append("--no-ignore")
     end
     if full_path_words then
@@ -92,7 +92,7 @@ M.find_files = function(opts)
   elseif cmd == "find" then
     append(path)
     append("-type", "f,d")
-    if not filters.show_hidden then
+    if not filters.visible and filters.hide_dotfiles then
       append("-not", "-path", "*/.*")
     end
     if full_path_words then

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

@@ -17,12 +17,12 @@ local function do_scan(context, path_to_scan)
   local state = context.state
   local paths_to_load = context.paths_to_load
   local folders = context.folders
-  local filters = state.filters or {}
+  local filters = state.filtered_items or {}
 
   scan.scan_dir_async(path_to_scan, {
-    hidden = filters.show_hidden or false,
     search_pattern = state.search_pattern or nil,
-    respect_gitignore = filters.respect_gitignore and filters.gitignore_source == "plenary",
+    hidden = true,
+    respect_gitignore = false,
     add_dirs = true,
     depth = 1,
     on_insert = function(path, _type)
@@ -103,7 +103,7 @@ M.get_items_async = function(state, parent_id, path_to_reveal, callback)
   if state.search_pattern then
     -- Use the external command because the plenary search is slow
     filter_external.find_files({
-      filters = state.filters,
+      filtered_items = state.filtered_items,
       find_command = state.find_command,
       limit = state.search_limit or 50,
       path = root.path,
@@ -148,11 +148,12 @@ M.get_items_async = function(state, parent_id, path_to_reveal, callback)
         context.paths_to_load = utils.unique(context.paths_to_load)
       end
 
+      local f = state.filtered_items or {}
       local ignored = {}
-      if state.filters.respect_gitignore then
-        if state.filters.gitignore_source == "git status" then
+      if f.hide_gitignored then
+        if f.gitignore_source == "git status" then
           ignored = git.load_ignored(state.path)
-        elseif state.filters.gitignore_source == "git check-ignore" then
+        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))
@@ -162,9 +163,8 @@ M.get_items_async = function(state, parent_id, path_to_reveal, callback)
       state.git_ignored = ignored
     else
       -- just update the ignored list for this dir if we are using the per dir 'check-ignore' option
-      if
-        state.filters.respect_gitignore and state.filters.gitignore_source == "git check-ignore"
-      then
+      local f = state.filtered_items or {}
+      if f.hide_gitignored and f.gitignore_source == "git check-ignore" 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/sources/filesystem/lib/fs_scan.lua

@@ -16,11 +16,14 @@ M.GIT_ADDED = "NeoTreeGitAdded"
 M.GIT_CONFLICT = "NeoTreeGitConflict"
 M.GIT_MODIFIED = "NeoTreeGitModified"
 M.GIT_UNTRACKED = "NeoTreeGitUntracked"
+M.GIT_IGNORED = "NeoTreeGitIgnored"
 M.NORMAL = "NeoTreeNormal"
 M.NORMALNC = "NeoTreeNormalNC"
 M.ROOT_NAME = "NeoTreeRootName"
 M.TITLE_BAR = "NeoTreeTitleBar"
 M.INDENT_MARKER = "NeoTreeIndentMarker"
+M.DOTFILE = "NeoTreeDotfile"
+M.HIDDEN_BY_NAME = "NeoTreeHiddenByName"
 
 local function dec_to_hex(n)
   local hex = string.format("%06x", n)
@@ -111,6 +114,9 @@ M.setup = function()
 
   create_highlight_group(M.BUFFER_NUMBER, { "SpecialChar" })
   create_highlight_group(M.DIM_TEXT, {}, nil, "505050")
+  create_highlight_group(M.DOTFILE, {}, nil, "626262")
+  create_highlight_group(M.GIT_IGNORED, { M.DOTFILE }, nil, nil)
+  create_highlight_group(M.HIDDEN_BY_NAME, { M.DOTFILE }, nil, nil)
   create_highlight_group(M.CURSOR_LINE, { "CursorLine" }, nil, nil, "bold")
   create_highlight_group(M.DIRECTORY_NAME, {}, "NONE", "NONE")
   create_highlight_group(M.DIRECTORY_ICON, {}, nil, "73cef4")