feat(view): add filters.git_clean

Author: alex-courtis

doc/nvim-tree-lua.txt

@@ -293,7 +293,7 @@ Subsequent calls to setup will replace the previous configuration.
         debounce_delay = 50,
         severity = {
           min = vim.diagnostic.severity.HINT,
-          max = vim.diagnostic.severity.ERROR
+          max = vim.diagnostic.severity.ERROR,
         },
         icons = {
           hint = "",
@@ -306,6 +306,7 @@ Subsequent calls to setup will replace the previous configuration.
         dotfiles = false,
         custom = {},
         exclude = {},
+        git_clean = false,
       },
       filesystem_watchers = {
         enable = true,
@@ -889,6 +890,11 @@ Filtering options.
     Toggle via the `toggle_dotfiles` action, default mapping `H`.
       Type: `boolean`, Default: `false`
 
+    *nvim-tree.filters.git_clean*
+    Do not show files with no git status. This will show ignored files when
+    |nvim-tree.git.ignore| is set, as they are effectively dirty.
+      Type: `boolean`, Default: `false`
+
     *nvim-tree.filters.custom*
     Custom list of vim regex for file/directory names that will not be shown.
     Backslashes must be escaped e.g. "^\\.git". See |string-match|.
@@ -1305,6 +1311,7 @@ DEFAULT MAPPINGS                                     *nvim-tree-default-mappings
 `<Tab>`           preview             open the file as a preview (keeps the cursor in the tree)
 `K`               first_sibling       navigate to the first sibling of current file/directory
 `J`               last_sibling        navigate to the last sibling of current file/directory
+`C`               toggle_git_clean    toggle visibility of git clean via |filters.git_clean| option
 `I`               toggle_git_ignored  toggle visibility of files/folders hidden via |git.ignore| option
 `H`               toggle_dotfiles     toggle visibility of dotfiles via |filters.dotfiles| option
 `U`               toggle_custom       toggle visibility of files/folders hidden via |filters.custom| option
@@ -1354,6 +1361,7 @@ DEFAULT MAPPINGS                                     *nvim-tree-default-mappings
     { key = "<Tab>",                          action = "preview" },
     { key = "K",                              action = "first_sibling" },
     { key = "J",                              action = "last_sibling" },
+    { key = "C",                              action = "toggle_git_clean" },
     { key = "I",                              action = "toggle_git_ignored" },
     { key = "H",                              action = "toggle_dotfiles" },
     { key = "U",                              action = "toggle_custom" },

lua/nvim-tree.lua

@@ -584,6 +584,7 @@ local DEFAULT_OPTS = { -- BEGIN_DEFAULT_OPTS
     dotfiles = false,
     custom = {},
     exclude = {},
+    git_clean = false,
   },
   filesystem_watchers = {
     enable = true,

lua/nvim-tree/actions/dispatch.lua

@@ -12,6 +12,7 @@ local Actions = {
   toggle_dotfiles = require("nvim-tree.actions.tree-modifiers.toggles").dotfiles,
   toggle_custom = require("nvim-tree.actions.tree-modifiers.toggles").custom,
   toggle_git_ignored = require("nvim-tree.actions.tree-modifiers.toggles").git_ignored,
+  toggle_git_clean = require("nvim-tree.actions.tree-modifiers.toggles").git_clean,
 
   -- Filesystem operations
   copy_absolute_path = require("nvim-tree.actions.fs.copy-paste").copy_absolute_path,

lua/nvim-tree/actions/init.lua

@@ -76,6 +76,11 @@ local DEFAULT_MAPPINGS = {
     action = "last_sibling",
     desc = "navigate to the last sibling of current file/directory",
   },
+  {
+    key = "C",
+    action = "toggle_git_clean",
+    desc = "toggle visibility of git clean via |filters.git_clean| option",
+  },
   {
     key = "I",
     action = "toggle_git_ignored",

lua/nvim-tree/actions/tree-modifiers/toggles.lua

@@ -15,6 +15,11 @@ function M.git_ignored()
   return reloaders.reload_explorer()
 end
 
+function M.git_clean()
+  filters.config.filter_git_clean = not filters.config.filter_git_clean
+  return reloaders.reload_explorer()
+end
+
 function M.dotfiles()
   filters.config.filter_dotfiles = not filters.config.filter_dotfiles
   return reloaders.reload_explorer()

lua/nvim-tree/explorer/explore.lua

@@ -23,11 +23,7 @@ local function populate_children(handle, cwd, node, status)
 
     local abs = utils.path_join { cwd, name }
     t = get_type_from(t, abs)
-    if
-      not filters.should_ignore(abs)
-      and not filters.should_ignore_git(abs, status.files)
-      and not nodes_by_path[abs]
-    then
+    if not filters.should_ignore(abs) and not filters.should_ignore_git(abs, status) and not nodes_by_path[abs] then
       local child = nil
       if t == "directory" and vim.loop.fs_access(abs, "R") then
         child = builders.folder(node, abs, name)

lua/nvim-tree/explorer/filters.lua

@@ -52,16 +52,37 @@ function M.should_ignore(path)
 end
 
 function M.should_ignore_git(path, status)
-  return M.config.filter_git_ignored
-    and (M.config.filter_git_ignored and status and status[path] == "!!")
-    and not is_excluded(path)
+  if type(status) ~= "table" or type(status.files) ~= "table" or type(status.dirs) ~= "table" then
+    return false
+  end
+
+  -- exclusions override all
+  if is_excluded(path) then
+    return false
+  end
+
+  -- default to clean
+  local st = status.files[path] or status.dirs[path] or "  "
+
+  -- ignored overrides clean as they are effectively dirty
+  if M.config.filter_git_ignored and st == "!!" then
+    return true
+  end
+
+  -- clean last
+  if M.config.filter_git_clean and st == "  " then
+    return true
+  end
+
+  return false
 end
 
 function M.setup(opts)
   M.config = {
     filter_custom = true,
     filter_dotfiles = opts.filters.dotfiles,
     filter_git_ignored = opts.git.ignore,
+    filter_git_clean = opts.filters.git_clean,
   }
 
   M.ignore_list = {}

lua/nvim-tree/explorer/reload.lua

@@ -71,7 +71,7 @@ function M.reload(node, status)
 
     local abs = utils.path_join { cwd, name }
     t = t or (fs_stat_cached(abs) or {}).type
-    if not filters.should_ignore(abs) and not filters.should_ignore_git(abs, status.files) then
+    if not filters.should_ignore(abs) and not filters.should_ignore_git(abs, status) then
       child_names[abs] = true
 
       -- Recreate node if type changes.

lua/nvim-tree/renderer/components/icons.lua

@@ -85,7 +85,7 @@ end
 function M.setup(opts)
   M.config = opts.renderer.icons
 
-  M.devicons = pcall(require, "nvim-web-devicons") and require "nvim-web-devicons"
+  M.devicons = pcall(require, "nvim-web-devicons") and require "nvim-web-devicons" or nil
 end
 
 return M