feat: add api.tree.toggle_enable_filters (#2706)

* feat: toggle filters

* naming refactoring

* change name to enable

* fix default opt

* fix api name

* update doc

* remove default keybinding, toggle live filter

* add API doc

---------

Co-authored-by: Alexander Courtis <alex@courtis.org>

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

@@ -41,4 +41,9 @@ function M.dotfiles()
   reload()
 end
 
+function M.enable()
+  filters.config.enable = not filters.config.enable
+  reload()
+end
+
 return M

lua/nvim-tree/api.lua

@@ -128,6 +128,7 @@ Api.tree.find_file = wrap(actions.tree.find_file.fn)
 Api.tree.search_node = wrap(actions.finders.search_node.fn)
 Api.tree.collapse_all = wrap(actions.tree.modifiers.collapse_all.fn)
 Api.tree.expand_all = wrap_node(actions.tree.modifiers.expand_all.fn)
+Api.tree.toggle_enable_filters = wrap(actions.tree.modifiers.toggles.enable)
 Api.tree.toggle_gitignore_filter = wrap(actions.tree.modifiers.toggles.git_ignored)
 Api.tree.toggle_git_clean_filter = wrap(actions.tree.modifiers.toggles.git_clean)
 Api.tree.toggle_no_buffer_filter = wrap(actions.tree.modifiers.toggles.no_buffer)

lua/nvim-tree/explorer/filters.lua

@@ -150,6 +150,10 @@ end
 ---@param status table from prepare
 ---@return boolean
 function M.should_filter(path, status)
+  if not M.config.enable then
+    return false
+  end
+
   -- exclusions override all filters
   if is_excluded(path) then
     return false
@@ -160,6 +164,7 @@ end
 
 function M.setup(opts)
   M.config = {
+    enable = opts.filters.enable,
     filter_custom = true,
     filter_dotfiles = opts.filters.dotfiles,
     filter_git_ignored = opts.filters.git_ignored,

lua/nvim-tree/live-filter.lua

@@ -1,6 +1,7 @@
 local view = require "nvim-tree.view"
 local utils = require "nvim-tree.utils"
 local Iterator = require "nvim-tree.iterators.node-iterator"
+local filters = require "nvim-tree.explorer.filters"
 
 local M = {
   filter = nil,
@@ -56,6 +57,10 @@ end
 ---@param node Node
 ---@return boolean
 local function matches(node)
+  if not filters.config.enable then
+    return true
+  end
+
   local path = node.absolute_path
   local name = vim.fn.fnamemodify(path, ":t")
   return vim.regex(M.filter):match_str(name) ~= nil