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

Author: kyazdani42

lua/nvim-tree/actions/change-dir.lua

@@ -35,7 +35,7 @@ function M.force_dirchange(foldername, with_open)
       vim.cmd("lcd " .. vim.fn.fnameescape(foldername))
     end
   end
-  require("nvim-tree.core").init(foldername)
+  core.init(foldername)
   if with_open then
     require("nvim-tree.lib").open()
   else

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

@@ -13,33 +13,35 @@ function M.fn(fname)
   end
   running[fname] = true
 
-  local i = view.is_root_folder_visible() and 1 or 0
+  local i = core.get_nodes_starting_line() - 1
   local tree_altered = false
 
   local function iterate_nodes(nodes)
     for _, node in ipairs(nodes) do
-      i = i + 1
-      if node.absolute_path == fname then
-        return i
-      end
-
-      local path_matches = node.nodes and vim.startswith(fname, node.absolute_path .. utils.path_separator)
-      if path_matches then
-        if not node.open then
-          node.open = true
-          tree_altered = true
-        end
-
-        if #node.nodes == 0 then
-          core.get_explorer():expand(node)
+      if not node.hidden then
+        i = i + 1
+        if node.absolute_path == fname then
+          return i
         end
 
-        if iterate_nodes(node.nodes) ~= nil then
-          return i
+        local path_matches = node.nodes and vim.startswith(fname, node.absolute_path .. utils.path_separator)
+        if path_matches then
+          if not node.open then
+            node.open = true
+            tree_altered = true
+          end
+
+          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" },
@@ -64,6 +65,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),
@@ -90,6 +92,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
@@ -58,7 +57,7 @@ function M.parent_node(should_close)
         parent.open = false
         altered_tree = true
       end
-      if not view.is_root_folder_visible() then
+      if not view.is_root_folder_visible(core.get_cwd()) then
         line = line - 1
       end
       view.set_cursor { line, 0 }
@@ -91,7 +90,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,7 +110,7 @@ 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() then
+    if not view.is_root_folder_visible(core.get_cwd()) then
       line = line - 1
     end
     view.set_cursor { line, 0 }
@@ -121,7 +120,7 @@ end
 function M.find_git_item(where)
   return function()
     local node_cur = lib().get_node_at_cursor()
-    local nodes_by_line = lib().get_nodes_by_line(core.get_explorer().nodes, view.View.hide_root_folder and 1 or 2)
+    local nodes_by_line = lib().get_nodes_by_line(core.get_explorer().nodes, core.get_nodes_starting_line())
 
     local cur, first, prev, nex = nil, nil, nil, nil
     for line, node in pairs(nodes_by_line) do

lua/nvim-tree/actions/search-node.lua

@@ -78,7 +78,7 @@ function M.fn()
   end
 
   if found_something and view.is_visible() then
-    if view.is_root_folder_visible() then
+    if view.is_root_folder_visible(core.get_cwd()) then
       index = index + 1
     end
 

lua/nvim-tree/core.lua

@@ -1,11 +1,12 @@
 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 = {}
 
-local first_init_done = false
-
 TreeExplorer = nil
+local first_init_done = false
 
 function M.init(foldername)
   TreeExplorer = explorer.Explorer.new(foldername)
@@ -15,12 +16,23 @@ function M.init(foldername)
   end
 end
 
+function M.get_cwd()
+  return TreeExplorer.cwd
+end
+
 function M.get_explorer()
   return TreeExplorer
 end
 
-function M.get_cwd()
-  return TreeExplorer.cwd
+function M.get_nodes_starting_line()
+  local offset = 2
+  if not 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
 
 return M

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, view.View.hide_root_folder and 1 or 2)[line]
+  if line == 1 and view.is_root_folder_visible() 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.

lua/nvim-tree/live-filter.lua

@@ -0,0 +1,142 @@
+-- TODO
+-- fix(movements): first/last siblings (K/J)
+-- fix(movements): next/prev siblings (>/<)
+-- fix(movements): parent node (P)
+-- fix(movements): close_node (backspace)
+-- fix(expansion): new expanded nodes are not filtered
+-- check(rendering): padding with indent markers
+-- improve: matching algorithm
+-- improve: folder expansion -> might involve performance issues that could be resolved with max depth search
+-- improve: user configuration
+-- improve: make prompt prettier
+-- finish: documentation
+local a = vim.api
+
+local view = require "nvim-tree.view"
+
+local M = {
+  filter = nil,
+  prefix = "Filtering on: ",
+  depth = 3,
+}
+
+local function redraw()
+  require("nvim-tree.renderer").draw()
+end
+
+local function reset_filter()
+  local function iterate(n)
+    n.hidden = false
+    if n.nodes then
+      for _, _n in pairs(n.nodes) do
+        iterate(_n)
+      end
+    end
+  end
+  iterate(TreeExplorer)
+end
+
+local overlay_bufnr = nil
+local overlay_winnr = nil
+
+function M.remove_overlay()
+  vim.cmd "augroup NvimTreeRecordFilter"
+  vim.cmd "au!"
+  vim.cmd "augroup END"
+
+  a.nvim_win_close(overlay_winnr, { force = true })
+  overlay_bufnr = nil
+  overlay_winnr = nil
+
+  if M.filter == "" then
+    M.filter = nil
+    reset_filter()
+    redraw()
+  end
+end
+
+local function matches(node)
+  local path = node.cwd or node.link_to or node.absolute_path
+  local name = vim.fn.fnamemodify(path, ":t")
+  return vim.fn.match(name, M.filter) ~= -1
+end
+
+local function apply_filter()
+  if not M.filter or M.filter == "" then
+    reset_filter()
+    return
+  end
+
+  local function iterate(node)
+    local filtered_nodes = 0
+    if node.nodes then
+      for _, n in pairs(node.nodes) do
+        if not iterate(n) then
+          filtered_nodes = filtered_nodes + 1
+        end
+      end
+    end
+
+    local has_nodes = #(node.nodes or {}) > filtered_nodes
+    if has_nodes or matches(node) then
+      node.hidden = false
+      return true
+    end
+
+    node.hidden = true
+    return false
+  end
+
+  iterate(TreeExplorer)
+end
+
+local function record_char()
+  vim.schedule(function()
+    M.filter = a.nvim_buf_get_lines(overlay_bufnr, 0, -1, false)[1]
+    apply_filter()
+    redraw()
+  end)
+end
+
+local function configure_buffer_overlay()
+  overlay_bufnr = a.nvim_create_buf(false, true)
+
+  a.nvim_buf_attach(overlay_bufnr, true, {
+    on_lines = record_char,
+  })
+  vim.cmd "augroup NvimTreeRecordFilter"
+  vim.cmd "au!"
+  vim.cmd "au InsertLeave * lua require'nvim-tree.live-filter'.remove_overlay()"
+  vim.cmd "augroup END"
+
+  a.nvim_buf_set_keymap(overlay_bufnr, "i", "<CR>", "<cmd>stopinsert<CR>", {})
+end
+
+local function create_overlay()
+  configure_buffer_overlay()
+  overlay_winnr = a.nvim_open_win(overlay_bufnr, true, {
+    col = 1,
+    row = 0,
+    relative = "cursor",
+    width = math.max(20, a.nvim_win_get_width(view.get_winnr()) - #M.prefix - 2),
+    height = 1,
+    border = "none",
+    style = "minimal",
+  })
+  a.nvim_buf_set_option(overlay_bufnr, "modifiable", true)
+  a.nvim_buf_set_lines(overlay_bufnr, 0, -1, false, { M.filter })
+  vim.cmd "startinsert"
+  a.nvim_win_set_cursor(overlay_winnr, { 1, #M.filter + 1 })
+end
+
+function M.start_filtering()
+  M.filter = M.filter or ""
+
+  redraw()
+  local row = require("nvim-tree.core").get_nodes_starting_line() - 1
+  view.set_cursor { row, #M.prefix - 1 }
+  -- needs scheduling to let the cursor move before initializing the window
+  vim.schedule(create_overlay)
+end
+
+return M