Merge remote-tracking branch 'origin/master' into live-filter-multiinstace

Author: alex-courtis

doc/nvim-tree-lua.txt

@@ -423,6 +423,7 @@ Following is the default configuration. See |nvim-tree-opts| for details.
         root_folder_label = ":~:s?$?/..?",
         indent_width = 2,
         special_files = { "Cargo.toml", "Makefile", "README.md", "readme.md" },
+        hidden_display = "none",
         symlink_destination = true,
         highlight_git = "none",
         highlight_diagnostics = "none",
@@ -878,6 +879,49 @@ Number of spaces for an each tree nesting level. Minimum 1.
 A list of filenames that gets highlighted with `NvimTreeSpecialFile`.
   Type: `table`, Default: `{ "Cargo.toml", "Makefile", "README.md", "readme.md", }`
 
+*nvim-tree.renderer.hidden_display*
+Show a summary of hidden files below the tree using `NvimTreeHiddenDisplay
+  Type: `function | string`, Default: `"none"`
+
+  Possible string values are:
+    - `"none"`:   Doesn't inform anything about hidden files.
+    - `"simple"`: Shows how many hidden files are in a folder.
+    - `"all"`:    Shows how many files are hidden and the number of hidden
+                files per reason why they're hidden.
+
+  Example `"all"`:
+    If a folder has 14 hidden items for various reasons, the display might
+    show: >
+    (14 total git: 5, dotfile: 9)
+<
+  If a function is provided, it receives a table `hidden_stats` where keys are
+  reasons and values are the count of hidden files for that reason.
+
+  The `hidden_stats` argument is structured as follows, where <num> is the
+  number of hidden files related to the field: >
+    hidden_stats = {
+      bookmark = <num>,
+      buf = <num>,
+      custom = <num>,
+      dotfile = <num>,
+      git = <num>,
+      live_filter = <num>,
+    }
+<
+  Example of function that can be passed: >
+    function(hidden_stats)
+      local total_count = 0
+      for reason, count in pairs(hidden_stats) do
+        total_count = total_count + count
+      end
+
+      if total_count > 0 then
+        return "(" .. tostring(total_count) .. " hidden)"
+      end
+      return nil
+    end
+<
+
 *nvim-tree.renderer.symlink_destination*
 Whether to show the destination of the symlink.
   Type: `boolean`, Default: `true`
@@ -2461,6 +2505,9 @@ Hidden: >
     NvimTreeModifiedFileHL      NvimTreeHiddenIcon
     NvimTreeModifiedFolderHL    NvimTreeHiddenFileHL
 <
+Hidden Display: >
+    NvimTreeHiddenDisplay       Conceal
+<
 Opened: >
     NvimTreeOpenedHL            Special
 <
@@ -2872,6 +2919,7 @@ highlight group is not, hard linking as follows: >
 |nvim-tree.renderer.add_trailing|
 |nvim-tree.renderer.full_name|
 |nvim-tree.renderer.group_empty|
+|nvim-tree.renderer.hidden_display|
 |nvim-tree.renderer.highlight_bookmarks|
 |nvim-tree.renderer.highlight_clipboard|
 |nvim-tree.renderer.highlight_diagnostics|

lua/nvim-tree.lua

@@ -398,6 +398,7 @@ local DEFAULT_OPTS = { -- BEGIN_DEFAULT_OPTS
     root_folder_label = ":~:s?$?/..?",
     indent_width = 2,
     special_files = { "Cargo.toml", "Makefile", "README.md", "readme.md" },
+    hidden_display = "none",
     symlink_destination = true,
     highlight_git = "none",
     highlight_diagnostics = "none",
@@ -647,6 +648,7 @@ local ACCEPTED_TYPES = {
     },
   },
   renderer = {
+    hidden_display = { "function", "string" },
     group_empty = { "boolean", "function" },
     root_folder_label = { "function", "string", "boolean" },
   },
@@ -680,6 +682,7 @@ local ACCEPTED_STRINGS = {
     signcolumn = { "yes", "no", "auto" },
   },
   renderer = {
+    hidden_display = { "none", "simple", "all" },
     highlight_git = { "none", "icon", "name", "all" },
     highlight_opened_files = { "none", "icon", "name", "all" },
     highlight_modified = { "none", "icon", "name", "all" },

lua/nvim-tree/appearance/init.lua

@@ -14,6 +14,7 @@ M.HIGHLIGHT_GROUPS = {
   -- Standard
   { group = "NvimTreeNormal", link = "Normal" },
   { group = "NvimTreeNormalFloat", link = "NormalFloat" },
+  { group = "NvimTreeNormalFloatBorder", link = "FloatBorder" },
   { group = "NvimTreeNormalNC", link = "NvimTreeNormal" },
 
   { group = "NvimTreeLineNr", link = "LineNr" },
@@ -81,6 +82,9 @@ M.HIGHLIGHT_GROUPS = {
   { group = "NvimTreeHiddenFileHL", link = "NvimTreeHiddenIcon" },
   { group = "NvimTreeHiddenFolderHL", link = "NvimTreeHiddenFileHL" },
 
+  -- Hidden Display
+  { group = "NvimTreeHiddenDisplay", link = "Conceal" },
+
   -- Opened
   { group = "NvimTreeOpenedHL", link = "Special" },
 

lua/nvim-tree/enum.lua

@@ -19,4 +19,15 @@ M.ICON_PLACEMENT = {
   right_align = 4,
 }
 
+---Reason for filter in filter.lua
+---@enum FILTER_REASON
+M.FILTER_REASON = {
+  none = 0, -- It's not filtered
+  git = 1,
+  buf = 2,
+  dotfile = 4,
+  custom = 8,
+  bookmark = 16,
+}
+
 return M

lua/nvim-tree/explorer/explore.lua

@@ -4,6 +4,7 @@ local explorer_node = require "nvim-tree.explorer.node"
 local git = require "nvim-tree.git"
 local log = require "nvim-tree.log"
 
+local FILTER_REASON = require("nvim-tree.enum").FILTER_REASON
 local Watcher = require "nvim-tree.watcher"
 
 local M = {}
@@ -16,7 +17,17 @@ local M = {}
 local function populate_children(handle, cwd, node, git_status, parent)
   local node_ignored = explorer_node.is_git_ignored(node)
   local nodes_by_path = utils.bool_record(node.nodes, "absolute_path")
+
   local filter_status = parent.filters:prepare(git_status)
+
+  node.hidden_stats = vim.tbl_deep_extend("force", node.hidden_stats or {}, {
+    git = 0,
+    buf = 0,
+    dotfile = 0,
+    custom = 0,
+    bookmark = 0,
+  })
+
   while true do
     local name, t = vim.loop.fs_scandir_next(handle)
     if not name then
@@ -28,8 +39,8 @@ local function populate_children(handle, cwd, node, git_status, parent)
 
     ---@type uv.fs_stat.result|nil
     local stat = vim.loop.fs_stat(abs)
-
-    if not parent.filters:should_filter(abs, stat, filter_status) and not nodes_by_path[abs] and Watcher.is_fs_event_capable(abs) then
+    local filter_reason = parent.filters:should_filter_as_reason(abs, stat, filter_status)
+    if filter_reason == FILTER_REASON.none and not nodes_by_path[abs] and Watcher.is_fs_event_capable(abs) then
       local child = nil
       if t == "directory" and vim.loop.fs_access(abs, "R") then
         child = builders.folder(node, abs, name, stat)
@@ -46,6 +57,12 @@ local function populate_children(handle, cwd, node, git_status, parent)
         nodes_by_path[child.absolute_path] = true
         explorer_node.update_git_status(child, node_ignored, git_status)
       end
+    else
+      for reason, value in pairs(FILTER_REASON) do
+        if filter_reason == value then
+          node.hidden_stats[reason] = node.hidden_stats[reason] + 1
+        end
+      end
     end
 
     log.profile_end(profile)

lua/nvim-tree/explorer/filters.lua

@@ -1,4 +1,5 @@
 local utils = require "nvim-tree.utils"
+local FILTER_REASON = require("nvim-tree.enum").FILTER_REASON
 
 ---@class Filters to handle all opts.filters and related API
 ---@field config table hydrated user opts.filters
@@ -223,4 +224,33 @@ function Filters:should_filter(path, fs_stat, status)
     or bookmark(self, path, fs_stat and fs_stat.type, status.bookmarks)
 end
 
+--- Check if the given path should be filtered, and provide the reason why it was
+---@param path string Absolute path
+---@param fs_stat uv.fs_stat.result|nil fs_stat of file
+---@param status table from prepare
+---@return FILTER_REASON
+function Filters:should_filter_as_reason(path, fs_stat, status)
+  if not self.config.enable then
+    return FILTER_REASON.none
+  end
+
+  if is_excluded(self, path) then
+    return FILTER_REASON.none
+  end
+
+  if git(self, path, status.git_status) then
+    return FILTER_REASON.git
+  elseif buf(self, path, status.bufinfo) then
+    return FILTER_REASON.buf
+  elseif dotfile(self, path) then
+    return FILTER_REASON.dotfile
+  elseif custom(self, path) then
+    return FILTER_REASON.custom
+  elseif bookmark(self, path, fs_stat and fs_stat.type, status.bookmarks) then
+    return FILTER_REASON.bookmark
+  else
+    return FILTER_REASON.none
+  end
+end
+
 return Filters

lua/nvim-tree/explorer/live-filter.lua

@@ -35,10 +35,17 @@ local function reset_filter(self, node_)
     return
   end
 
+  node_.hidden_stats = vim.tbl_deep_extend("force", node_.hidden_stats or {}, {
+    live_filter = 0,
+  })
+
   Iterator.builder(node_.nodes)
     :hidden()
     :applier(function(node)
       node.hidden = false
+      node.hidden_stats = vim.tbl_deep_extend("force", node.hidden_stats or {}, {
+        live_filter = 0,
+      })
     end)
     :iterate()
 end
@@ -95,6 +102,10 @@ function LiveFilter:apply_filter(node_)
     local filtered_nodes = 0
     local nodes = node.group_next and { node.group_next } or node.nodes
 
+    node.hidden_stats = vim.tbl_deep_extend("force", node.hidden_stats or {}, {
+      live_filter = 0,
+    })
+
     if nodes then
       for _, n in pairs(nodes) do
         iterate(n)
@@ -104,6 +115,8 @@ function LiveFilter:apply_filter(node_)
       end
     end
 
+    node.hidden_stats.live_filter = filtered_nodes
+
     local has_nodes = nodes and (self.always_show_folders or #nodes > filtered_nodes)
     local ok, is_match = pcall(matches, self, node)
     node.hidden = not (has_nodes or (ok and is_match))

lua/nvim-tree/explorer/reload.lua

@@ -4,6 +4,7 @@ local explorer_node = require "nvim-tree.explorer.node"
 local git = require "nvim-tree.git"
 local log = require "nvim-tree.log"
 
+local FILTER_REASON = require("nvim-tree.enum").FILTER_REASON
 local NodeIterator = require "nvim-tree.iterators.node-iterator"
 local Watcher = require "nvim-tree.watcher"
 
@@ -91,6 +92,16 @@ function M.reload(node, git_status)
   local node_ignored = explorer_node.is_git_ignored(node)
   ---@type table<string, Node>
   local nodes_by_path = utils.key_by(node.nodes, "absolute_path")
+
+  -- To reset we must 'zero' everything that we use
+  node.hidden_stats = vim.tbl_deep_extend("force", node.hidden_stats or {}, {
+    git = 0,
+    buf = 0,
+    dotfile = 0,
+    custom = 0,
+    bookmark = 0,
+  })
+
   while true do
     local name, t = vim.loop.fs_scandir_next(handle)
     if not name then
@@ -101,7 +112,8 @@ function M.reload(node, git_status)
     ---@type uv.fs_stat.result|nil
     local stat = vim.loop.fs_stat(abs)
 
-    if not explorer.filters:should_filter(abs, stat, filter_status) then
+    local filter_reason = explorer.filters:should_filter_as_reason(abs, stat, filter_status)
+    if filter_reason == FILTER_REASON.none then
       remain_childs[abs] = true
 
       -- Recreate node if type changes.
@@ -138,6 +150,12 @@ function M.reload(node, git_status)
           n.fs_stat = stat
         end
       end
+    else
+      for reason, value in pairs(FILTER_REASON) do
+        if filter_reason == value then
+          node.hidden_stats[reason] = node.hidden_stats[reason] + 1
+        end
+      end
     end
   end
 

lua/nvim-tree/node.lua

@@ -21,6 +21,7 @@
 ---@field group_next Node|nil
 ---@field nodes Node[]
 ---@field open boolean
+---@field hidden_stats table -- Each field of this table is a key for source and value for count
 
 ---@class FileNode: BaseNode
 ---@field extension string