feat(live-filter): add ability to live filter out nodes in the tree

Author: kyazdani42

lua/nvim-tree/actions/find-file.lua

@@ -29,35 +29,37 @@ function M.fn(fname)
 
   local function iterate_nodes(nodes)
     for _, node in ipairs(nodes) do
-      i = i + 1
+      if not node.hidden then
+        i = i + 1
 
-      if not node.absolute_path or not uv.fs_stat(node.absolute_path) then
-        break
-      end
-
-      -- match against node absolute and link, as symlinks themselves will differ
-      if node.absolute_path == fname_real or node.link_to == fname_real then
-        return i
-      end
-      local abs_match = vim.startswith(fname_real, node.absolute_path .. utils.path_separator)
-      local link_match = node.link_to and vim.startswith(fname_real, node.link_to .. utils.path_separator)
-      local path_matches = node.nodes and (abs_match or link_match)
-      if path_matches then
-        if not node.open then
-          node.open = true
-          tree_altered = true
+        if not node.absolute_path or not uv.fs_stat(node.absolute_path) then
+          break
         end
 
-        if #node.nodes == 0 then
-          core.get_explorer():expand(node)
+        -- match against node absolute and link, as symlinks themselves will differ
+        if node.absolute_path == fname_real or node.link_to == fname_real then
+          return i
         end
+        local abs_match = vim.startswith(fname_real, node.absolute_path .. utils.path_separator)
+        local link_match = node.link_to and vim.startswith(fname_real, node.link_to .. utils.path_separator)
+        local path_matches = node.nodes and (abs_match or link_match)
+        if path_matches then
+          if not node.open then
+            node.open = true
+            tree_altered = true
+          end
 
-        if iterate_nodes(node.nodes) ~= nil then
-          return i
+          if #node.nodes == 0 then
+            core.get_explorer():expand(node)
+          end
+
+          if iterate_nodes(node.nodes) ~= nil then
+            return i
+          end
+          -- mandatory to iterate i
+        elseif node.open then
+          iterate_nodes(node.nodes)
         end
-        -- mandatory to iterate i
-      elseif node.open then
-        iterate_nodes(node.nodes)
       end
     end
   end

lua/nvim-tree/actions/init.lua

@@ -40,6 +40,7 @@ local M = {
     { key = "]c", action = "next_git_item" },
     { key = "-", action = "dir_up" },
     { key = "s", action = "system_open" },
+    { key = "f", action = "live_filter" },
     { key = "q", action = "close" },
     { key = "g?", action = "toggle_help" },
     { key = "W", action = "collapse_all" },
@@ -65,6 +66,7 @@ local keypress_funcs = {
   first_sibling = require("nvim-tree.actions.movements").sibling(-math.huge),
   full_rename = require("nvim-tree.actions.rename-file").fn(true),
   last_sibling = require("nvim-tree.actions.movements").sibling(math.huge),
+  live_filter = require("nvim-tree.live-filter").start_filtering,
   next_git_item = require("nvim-tree.actions.movements").find_git_item "next",
   next_sibling = require("nvim-tree.actions.movements").sibling(1),
   parent_node = require("nvim-tree.actions.movements").parent_node(false),
@@ -92,6 +94,11 @@ function M.on_keypress(action)
   if view.is_help_ui() and action ~= "toggle_help" then
     return
   end
+
+  if action == "live_filter" then
+    return keypress_funcs[action]()
+  end
+
   local node = lib.get_node_at_cursor()
   if not node then
     return

lua/nvim-tree/actions/movements.lua

@@ -3,7 +3,6 @@ local view = require "nvim-tree.view"
 local diagnostics = require "nvim-tree.diagnostics"
 local renderer = require "nvim-tree.renderer"
 local core = require "nvim-tree.core"
-
 local lib = function()
   return require "nvim-tree.lib"
 end
@@ -20,16 +19,18 @@ local function get_line_from_node(node, find_parent)
   local line = core.get_nodes_starting_line()
   local function iter(nodes, recursive)
     for _, _node in ipairs(nodes) do
-      local n = lib().get_last_group_node(_node)
-      if node_path == n.absolute_path then
-        return line, _node
-      end
+      if not _node.hidden then
+        local n = lib().get_last_group_node(_node)
+        if node_path == n.absolute_path then
+          return line, _node
+        end
 
-      line = line + 1
-      if _node.open == true and recursive then
-        local _, child = iter(_node.nodes, recursive)
-        if child ~= nil then
-          return line, child
+        line = line + 1
+        if _node.open == true and recursive then
+          local _, child = iter(_node.nodes, recursive)
+          if child ~= nil then
+            return line, child
+          end
         end
       end
     end
@@ -38,36 +39,28 @@ local function get_line_from_node(node, find_parent)
 end
 
 function M.parent_node(should_close)
+  should_close = should_close or false
+
   return function(node)
     if node.name == ".." then
       return
     end
 
-    should_close = should_close or false
-    local altered_tree = false
-
-    local iter = get_line_from_node(node, true)
+    local line, parent = get_line_from_node(node, true)(core.get_explorer().nodes, true)
     if node.open == true and should_close then
       node.open = false
-      altered_tree = true
+      view.set_cursor { line, 0 }
     else
-      local line, parent = iter(core.get_explorer().nodes, true)
       if parent == nil then
         line = 1
       elseif should_close then
         parent.open = false
-        altered_tree = true
-      end
-      if not view.is_root_folder_visible(core.get_cwd()) then
-        line = line - 1
       end
       view.set_cursor { line, 0 }
     end
 
-    if altered_tree then
-      diagnostics.update()
-      renderer.draw()
-    end
+    diagnostics.update()
+    renderer.draw()
   end
 end
 
@@ -91,7 +84,7 @@ function M.sibling(direction)
     end
 
     if line > 0 then
-      parent = core.get_explorer()
+      parent = core.get_explorer().nodes
     else
       _, parent = iter(core.get_explorer().nodes, true)
       if parent ~= nil and #parent.nodes > 1 then
@@ -111,9 +104,6 @@ function M.sibling(direction)
     local target_node = parent.nodes[index]
 
     line, _ = get_line_from_node(target_node)(core.get_explorer().nodes, true)
-    if not view.is_root_folder_visible(core.get_cwd()) then
-      line = line - 1
-    end
     view.set_cursor { line, 0 }
   end
 end

lua/nvim-tree/core.lua

@@ -1,5 +1,6 @@
 local events = require "nvim-tree.events"
 local explorer = require "nvim-tree.explorer"
+local live_filter = require "nvim-tree.live-filter"
 local view = require "nvim-tree.view"
 
 local M = {}
@@ -28,6 +29,9 @@ function M.get_nodes_starting_line()
   if view.is_root_folder_visible(M.get_cwd()) then
     offset = offset + 1
   end
+  if live_filter.filter then
+    return offset + 1
+  end
   return offset
 end
 

lua/nvim-tree/explorer/explore.lua

@@ -6,6 +6,7 @@ local builders = require "nvim-tree.explorer.node-builders"
 local common = require "nvim-tree.explorer.common"
 local sorters = require "nvim-tree.explorer.sorters"
 local filters = require "nvim-tree.explorer.filters"
+local live_filter = require "nvim-tree.live-filter"
 
 local M = {}
 
@@ -66,6 +67,7 @@ function M.explore(node, status)
   end
 
   sorters.merge_sort(node.nodes, sorters.node_comparator)
+  live_filter.apply_filter(node)
   return node.nodes
 end
 

lua/nvim-tree/explorer/reload.lua

@@ -6,6 +6,7 @@ local builders = require "nvim-tree.explorer.node-builders"
 local common = require "nvim-tree.explorer.common"
 local filters = require "nvim-tree.explorer.filters"
 local sorters = require "nvim-tree.explorer.sorters"
+local live_filter = require "nvim-tree.live-filter"
 
 local M = {}
 
@@ -89,6 +90,7 @@ function M.reload(node, status)
   end
 
   sorters.merge_sort(node.nodes, sorters.node_comparator)
+  live_filter.apply_filter(node)
   return node.nodes
 end
 

lua/nvim-tree/lib.lua

@@ -14,12 +14,14 @@ function M.get_nodes_by_line(nodes_all, line_start)
   local line = line_start
   local function iter(nodes)
     for _, node in ipairs(nodes) do
-      nodes_by_line[line] = node
-      line = line + 1
-      if node.open == true then
-        local child = iter(node.nodes)
-        if child ~= nil then
-          return child
+      if not node.hidden then
+        nodes_by_line[line] = node
+        line = line + 1
+        if node.open == true then
+          local child = iter(node.nodes)
+          if child ~= nil then
+            return child
+          end
         end
       end
     end
@@ -32,27 +34,25 @@ function M.get_node_at_cursor()
   if not core.get_explorer() then
     return
   end
+
   local winnr = view.get_winnr()
-  local hide_root_folder = view.View.hide_root_folder
   if not winnr then
     return
   end
+
   local cursor = api.nvim_win_get_cursor(view.get_winnr())
   local line = cursor[1]
   if view.is_help_ui() then
     local help_lines = require("nvim-tree.renderer.help").compute_lines()
     local help_text = M.get_nodes_by_line(help_lines, 1)[line]
     return { name = help_text }
-  else
-    if line == 1 and core.get_explorer().cwd ~= "/" and not hide_root_folder then
-      return { name = ".." }
-    end
+  end
 
-    if core.get_explorer().cwd == "/" then
-      line = line + 1
-    end
-    return M.get_nodes_by_line(core.get_explorer().nodes, core.get_nodes_starting_line())[line]
+  if line == 1 and view.is_root_folder_visible(core.get_cwd()) then
+    return { name = ".." }
   end
+
+  return M.get_nodes_by_line(core.get_explorer().nodes, core.get_nodes_starting_line())[line]
 end
 
 -- If node is grouped, return the last node in the group. Otherwise, return the given node.