feat: add fuzzy_finder command which improves filter_as_you_type, closes #129

Author: cseickel

README.md

@@ -80,7 +80,8 @@ use {
               ["H"] = "toggle_hidden",
               ["I"] = "toggle_gitignore",
               ["R"] = "refresh",
-              ["/"] = "filter_as_you_type",
+              ["/"] = "fuzzy_finder",
+              --["/"] = "filter_as_you_type", -- this was the default until v1.28
               --["/"] = "none" -- Assigning a key to "none" will remove the default mapping
               ["f"] = "filter_on_submit",
               ["<c-x>"] = "clear_filter",

doc/neo-tree.txt

@@ -143,28 +143,40 @@ Note: The "selected" item is the line the cursor is currently on.
 
 <2-LeftMouse> = open:        Expand or collapse a folder. If a file is selected,
                              open it in the window closest to the tree.
+
 <cr>          = open:        Same as above.
+
 S             = open_split:  Same as open, but opens in a new horizontal split.
+
 s             = open_vsplit: Same as open, but opens in a vertical split
+
 <bs>          = navigate_up: Moves the root directory up one level.
+
 .             = set_root:    Changes the root directory to the currently 
                              selected folder.
 
 
 FILE ACTIONS                                            *neo-tree-file-actions*
 a    = add:                  Create a new file or directory.
+
 d    = delete:               Delete the selected file or directory.
+
 r    = rename:               Rename the selected file or directory.
+
 c    = copy_to_clipboard:    Mark file to be copied.
+
 x    = cut_to_clipboard:     Mark file to be cut (moved).
+
 p    = paste_from_clipboard: Copy/move each marked file in the to the
                              selected folder.
 
 
 VIEW CHANGES                                            *neo-tree-view-changes*
 H = toggle_hidden:    Toggle whether hidden files (.*) are shown or not.
+
 I = toggle_gitignore: Toggle whether the gitignore file is
                       respected.
+
 R = refresh:          Rescan the filesystem and redraw the tree. Changes
                       made within nvim should be detected automatically, but
                       this is useful for changes made elsewhere.
@@ -175,15 +187,27 @@ FILTER                                                        *neo-tree-filter*
                             files and folders that contain the specified term as
                             you type. This will use fd if it is installed, or 
                             find, or which if you are on Windows.
+
+                            As of v1.28, this acts like a fuzzy finder,
+                            meaning that pressing up/down while the filter
+                            window is open will move the cursor up and down in
+                            the tree, and pressing `<enter>` will open that
+                            item and clear the filter. Any other method of
+                            closing the filter window will also clear the
+                            filter.
+
 f     = filter_on_submit:   Same as above, but does not search until you hit
                             enter. Useful if filter_as_you_type is too slow.
+                            Also useful if you want to leave the tree
+                            filtered.
+
 <C-x> = clear_filter:       Removes the filter.
 
 
 CUSTOM COMMANDS                                       *neo-tree-custom-commands*
 
 If you want to define your own command, you have two options:
-  1. You can define (or override) a command in the `commands` section of the
+  1. You can define (or oVErride) a command in the `commands` section of the
   config for each source, then reference that by name in a mapping.
   2. You can map directly to a function and skip defining a command.
 

lua/neo-tree.lua

@@ -191,6 +191,7 @@ M.reveal_in_split = function(source_name, toggle_if_open)
       return
     end
   end
+  --TODO: if we are currently in a sidebar, don't replace it with a split style
   manager.reveal_in_split(source_name)
 end
 
@@ -203,6 +204,7 @@ M.show_in_split = function(source_name, toggle_if_open)
       return
     end
   end
+  --TODO: if we are currently in a sidebar, don't replace it with a split style
   manager.show_in_split(source_name)
 end
 

lua/neo-tree/defaults.lua

@@ -49,16 +49,16 @@ local config = {
   --},
   filesystem = {
     follow_current_file = false, -- This will find and focus the file in the active buffer
-                                 -- every time the current file is changed while the tree
-                                 -- is open.
+    -- every time the current file is changed while the tree
+    -- is open.
     use_libuv_file_watcher = false, -- This will use the OS level file watchers to detect
-                                    -- changes instead of relying on nvim autocmd events.
-    window = {  -- see https://github.com/MunifTanjim/nui.nvim/tree/main/lua/nui/popup
-                -- for possible options. These can also be functions that return these
-                -- options.
+    -- changes instead of relying on nvim autocmd events.
+    window = { -- see https://github.com/MunifTanjim/nui.nvim/tree/main/lua/nui/popup
+      -- for possible options. These can also be functions that return these
+      -- options.
       position = "left", -- left, right, float, split
       width = 40, -- applies to left and right positions
-      popup = {   -- settings that apply to float position only
+      popup = { -- settings that apply to float position only
         size = {
           height = "80%",
           width = "50%",
@@ -81,7 +81,8 @@ local config = {
         ["H"] = "toggle_hidden",
         ["I"] = "toggle_gitignore",
         ["R"] = "refresh",
-        ["/"] = "filter_as_you_type",
+        ["/"] = "fuzzy_finder",
+        --["/"] = "filter_as_you_type", -- this was the default until v1.28
         ["f"] = "filter_on_submit",
         ["<C-x>"] = "clear_filter",
         ["a"] = "add",

lua/neo-tree/sources/example/init.lua

@@ -4,6 +4,7 @@
 local vim = vim
 local renderer = require("neo-tree.ui.renderer")
 local manager = require("neo-tree.sources.manager")
+local events = require("neo-tree.events")
 
 local M = { name = "example" }
 

lua/neo-tree/sources/filesystem/commands.lua

@@ -53,6 +53,11 @@ M.filter_on_submit = function(state)
   filter.show_filter(state, false)
 end
 
+---Shows the filter input in fuzzy finder mode.
+M.fuzzy_finder = function(state)
+  filter.show_filter(state, true, true)
+end
+
 ---Navigate up one level.
 M.navigate_up = function(state)
   local parent_path, _ = utils.split_path(state.path)

lua/neo-tree/sources/filesystem/init.lua

@@ -170,22 +170,56 @@ M.navigate = function(state, path, path_to_reveal, callback)
   end, utils.debounce_strategy.CALL_FIRST_AND_LAST, 500)
 end
 
-M.reset_search = function(state, refresh)
+M.reset_search = function(state, refresh, open_current_node)
   log.trace("reset_search")
   if refresh == nil then
     refresh = true
   end
   if state.open_folders_before_search then
-    log.trace("reset_search: open_folders_before_search")
     state.force_open_folders = utils.table_copy(state.open_folders_before_search)
   else
-    log.trace("reset_search: why are there no open_folders_before_search?")
     state.force_open_folders = nil
   end
   state.search_pattern = nil
   state.open_folders_before_search = nil
   if refresh then
-    M.navigate(state)
+    if open_current_node then
+      local node = state.tree:get_node()
+      if node then
+        local path = node:get_id()
+        state.position.set(path)
+        if node.type == "directory" then
+          log.trace("opening directory from search: ", path)
+          M.navigate(state, nil, path, function()
+            -- this callback is to focus the selected node
+            local event = {
+              event = events.AFTER_RENDER,
+              id = "neo-tree-open-from-search:" .. tostring(state),
+            }
+            events.unsubscribe(event) -- if there is a prior event waiting, replace it
+
+            event.handler = function(arg)
+              if arg ~= state then
+                return -- this is not our event
+              end
+              pcall(renderer.focus_node, state, path, false)
+              event.cancelled = true
+            end
+
+            events.subscribe(event)
+          end)
+        else
+          if state.current_position == "split" then
+            utils.open_file(state, node:get_id())
+          else
+            utils.open_file(state, path)
+            M.navigate(state, nil, path)
+          end
+        end
+      end
+    else
+      M.navigate(state)
+    end
   end
 end
 

lua/neo-tree/sources/filesystem/lib/filter.lua

@@ -13,7 +13,7 @@ local manager = require("neo-tree.sources.manager")
 
 local M = {}
 
-M.show_filter = function(state, search_as_you_type)
+M.show_filter = function(state, search_as_you_type, fuzzy_finder_mode)
   local width = vim.fn.winwidth(0) - 2
   local row = vim.api.nvim_win_get_height(0) - 3
   local popup_options = popups.popup_options("Enter Filter Pattern:", width, {
@@ -39,6 +39,12 @@ M.show_filter = function(state, search_as_you_type)
       if value == "" then
         fs.reset_search(state)
       else
+        if search_as_you_type and fuzzy_finder_mode then
+          state.search_pattern = nil
+          fs.reset_search(state, true, true)
+          require("neo-tree.sources.filesystem.commands").open(state)
+          return
+        end
         state.search_pattern = value
         manager.refresh("filesystem", function()
           -- focus first file
@@ -107,11 +113,31 @@ M.show_filter = function(state, search_as_you_type)
 
   input:map("i", "<esc>", function(bufnr)
     input:unmount()
+    if fuzzy_finder_mode and utils.truthy(state.search_pattern) then
+      fs.reset_search(state, true)
+    end
   end, { noremap = true })
 
   input:on({ event.BufLeave, event.BufDelete }, function()
     input:unmount()
+    if fuzzy_finder_mode and utils.truthy(state.search_pattern) then
+      fs.reset_search(state, true)
+    end
   end, { once = true })
+
+  if fuzzy_finder_mode then
+    local move_cursor_down = function()
+      renderer.focus_node(state, nil, true, 1, 3)
+    end
+    local move_cursor_up = function()
+      renderer.focus_node(state, nil, true, -1, 3)
+      vim.cmd("redraw!")
+    end
+    input:map("i", "<down>", move_cursor_down, { noremap = true })
+    input:map("i", "<C-n>", move_cursor_down, { noremap = true })
+    input:map("i", "<up>", move_cursor_up, { noremap = true })
+    input:map("i", "<C-p>", move_cursor_up, { noremap = true })
+  end
 end
 
 return M

lua/neo-tree/ui/renderer.lua

@@ -173,10 +173,13 @@ end
 ---@param id string The id of the node to set the cursor at.
 ---@return boolean boolean True if the node was found and focused, false
 ---otherwise.
-M.focus_node = function(state, id, do_not_focus_window)
-  if not id then
+M.focus_node = function(state, id, do_not_focus_window, relative_movement, bottom_scroll_padding)
+  if not id and not relative_movement then
     return nil
   end
+  relative_movement = relative_movement or 0
+  bottom_scroll_padding = bottom_scroll_padding or 0
+
   local tree = state.tree
   if not tree then
     return false
@@ -185,8 +188,7 @@ M.focus_node = function(state, id, do_not_focus_window)
   if not node then
     return false
   end
-  --expand_to_root(tree, node)
-  --tree:render()
+  id = node:get_id() -- in case nil was passed in for id, meaning current node
 
   local bufnr = utils.get_value(state, "bufnr", 0, true)
   if bufnr == 0 then
@@ -202,33 +204,49 @@ M.focus_node = function(state, id, do_not_focus_window)
     node = tree:get_node(linenr)
     if node then
       if node:get_id() == id then
+        if relative_movement ~= 0 then
+          local success, relative_node = pcall(tree.get_node, tree, linenr)
+          -- this may fail if the node is at the first or last line
+          if success and relative_node then
+            node = relative_node
+            linenr = linenr + relative_movement
+          end
+        end
         local col = 0
         if node.indent then
           col = string.len(node.indent)
         end
         local focus_window = not do_not_focus_window
-        if focus_window then
-          if M.window_exists(state) then
+        if M.window_exists(state) then
+          if focus_window then
             vim.api.nvim_set_current_win(state.winid)
-          else
-            return false
           end
-        end
-        local success, err = pcall(vim.api.nvim_win_set_cursor, state.winid, { linenr, col })
-        if success then
-          -- make sure we are not scrolled down if it can all fit on the screen
-          local win_height = vim.api.nvim_win_get_height(state.winid)
-          if vim.api.nvim_get_current_win() == state.winid then
-            if win_height > linenr then
-              vim.cmd("normal! zb")
+          local success, err = pcall(vim.api.nvim_win_set_cursor, state.winid, { linenr, col })
+          if success then
+            local execute_win_command = function(cmd)
+              if vim.api.nvim_get_current_win() == state.winid then
+                vim.cmd(cmd)
+              else
+                vim.cmd("call win_execute(" .. state.winid .. [[, "]] .. cmd .. [[")]])
+              end
+            end
+
+            -- make sure we are not scrolled down if it can all fit on the screen
+            local win_height = vim.api.nvim_win_get_height(state.winid)
+            if linenr > (win_height - bottom_scroll_padding) then
+              execute_win_command("normal! zz")
+            elseif win_height > linenr then
+              execute_win_command("normal! zb")
             elseif linenr < (win_height / 2) then
-              vim.cmd("normal! zz")
+              execute_win_command("normal! zz")
             end
+          else
+            log.warn("Failed to set cursor: " .. err)
           end
+          return success
         else
-          log.warn("Failed to set cursor: " .. err)
+          return false
         end
-        return success
       end
     else
       --must be out of nodes