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

Author: kyazdani42

lua/nvim-tree/live-filter.lua

@@ -0,0 +1,122 @@
+-- TODO
+-- getting the node list should apply the filter first (for get_node_at_cursor for instance)
+-- custom configuration
+-- placement bug with window (see todo/fixme)
+-- documentation
+-- more advanced matching algorithm
+-- asynchronous node discovery when folders are not yet loaded: (might involve performance issues -> max depth search could fix that)
+local a = vim.api
+
+local view = require "nvim-tree.view"
+
+local M = {
+  filter = nil,
+  prefix = "Filtering on: ",
+}
+
+local function redraw()
+  require("nvim-tree.renderer").draw()
+end
+
+function M.cancel_filter()
+  M.filter = nil
+  M.remove_overlay()
+  vim.cmd "stopinsert"
+  redraw()
+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
+end
+
+local function record_char()
+  vim.schedule(function()
+    M.filter = a.nvim_buf_get_lines(overlay_bufnr, 0, -1, false)[1]
+    redraw()
+  end)
+end
+
+local function configure_buffer_overloay()
+  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>", {})
+  a.nvim_buf_set_keymap(overlay_bufnr, "i", "<Esc>", "<cmd>lua require'nvim-tree.live-filter'.cancel_filter()<cr>", {})
+  a.nvim_buf_set_keymap(overlay_bufnr, "i", "<C-c>", "<cmd>lua require'nvim-tree.live-filter'.cancel_filter()<cr>", {})
+end
+
+-- TODO/FIXME: find why it doesn't properly place the column when the screen is split...
+local function create_overlay(row, col)
+  configure_buffer_overloay()
+  overlay_winnr = a.nvim_open_win(overlay_bufnr, true, {
+    col = col + 2,
+    row = row,
+    relative = "win",
+    anchor = "NW",
+    win = view.get_winnr(),
+    width = 100,
+    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 = view.hide_root_folder or TreeExplorer.cwd == "/" and 1 or 2
+  a.nvim_win_set_cursor(view.get_winnr(), { row, #M.prefix })
+  create_overlay(row - 1, #M.prefix)
+end
+
+local function matches(node, filter)
+  local path = node.cwd or node.link_to or node.absolute_path
+  local name = require("nvim-tree.utils").path_relative(path, vim.loop.cwd())
+  return vim.fn.match(name, filter) ~= -1
+end
+
+function M.filter_nodes()
+  if not M.filter or M.filter == "" then
+    return TreeExplorer
+  end
+
+  local function iterate(node)
+    if node.nodes then
+      node.nodes = vim.tbl_filter(function(_node)
+        return iterate(_node) ~= nil
+      end, node.nodes)
+    end
+
+    local has_nodes = node.nodes and #node.nodes > 0
+    if has_nodes or matches(node, M.filter) then
+      return node
+    end
+
+    return nil
+  end
+
+  return iterate(vim.deepcopy(TreeExplorer)) or { cwd = TreeExplorer.cwd, nodes = {} }
+end
+
+return M

lua/nvim-tree/renderer/init.lua

@@ -3,6 +3,7 @@ local view = require "nvim-tree.view"
 local _padding = require "nvim-tree.renderer.padding"
 local _help = require "nvim-tree.renderer.help"
 local _icons = require "nvim-tree.renderer.icons"
+local live_filter = require "nvim-tree.live-filter"
 
 local api = vim.api
 
@@ -306,6 +307,10 @@ local function update_draw_data(tree, depth, markers)
     table.insert(hl, { "NvimTreeRootFolder", index, 0, string.len(root_name) })
     index = 1
   end
+  if tree.cwd and live_filter.filter then
+    table.insert(lines, live_filter.prefix .. live_filter.filter)
+    index = index + 1
+  end
 
   for idx, node in ipairs(tree.nodes) do
     local padding = _padding.get_padding(depth, idx, tree, node, markers)
@@ -419,7 +424,8 @@ function M.draw()
     and icon_state.show_folder_icon
     and icon_state.show_folder_arrows
   _padding.reload_padding_function()
-  update_draw_data(TreeExplorer, show_arrows and 2 or 0, {})
+  local nodes = require("nvim-tree.live-filter").filter_nodes()
+  update_draw_data(nodes, show_arrows and 2 or 0, {})
 
   if view.is_help_ui() then
     lines, hl = _help.compute_lines()