fix(fuzzy): add close command to all fuzzy finders (#1747)

Author: pynappo

lua/neo-tree/sources/common/filters/init.lua

@@ -13,18 +13,6 @@ local fzy = require("neo-tree.sources.common.filters.filter_fzy")
 
 local M = {}
 
----@enum (key) neotree.FuzzyFinder.Commands
-local cmds = {
-  move_cursor_down = function(state, scroll_padding)
-    renderer.focus_node(state, nil, true, 1, scroll_padding)
-  end,
-
-  move_cursor_up = function(state, scroll_padding)
-    renderer.focus_node(state, nil, true, -1, scroll_padding)
-    vim.cmd("redraw!")
-  end,
-}
-
 ---Reset the current filter to the empty string.
 ---@param state any
 ---@param refresh boolean? whether to refresh the source tree
@@ -204,16 +192,30 @@ M.show_filter = function(state, search_as_you_type, keep_filter_on_submit)
     end
   end)
 
+  ---@enum (key) neotree.FuzzyFinder.Commands
+  local cmds = {
+    move_cursor_down = function(state_, scroll_padding_)
+      renderer.focus_node(state_, nil, true, 1, scroll_padding_)
+    end,
+
+    move_cursor_up = function(state_, scroll_padding_)
+      renderer.focus_node(state_, nil, true, -1, scroll_padding_)
+      vim.cmd("redraw!")
+    end,
+
+    close = function()
+      vim.cmd("stopinsert")
+      input:unmount()
+      if utils.truthy(state.search_pattern) then
+        reset_filter(state, true)
+      end
+      restore_height()
+    end,
+  }
+
   -- create mappings and autocmd
   input:map("i", "<C-w>", "<C-S-w>", { noremap = true })
-  input:map("i", "<esc>", function()
-    vim.cmd("stopinsert")
-    input:unmount()
-    if utils.truthy(state.search_pattern) then
-      reset_filter(state, true)
-    end
-    restore_height()
-  end, { noremap = true })
+  input:map("i", "<esc>", cmds.close, { noremap = true })
 
   local config = require("neo-tree").config
   for lhs, cmd_name in pairs(config.filesystem.window.fuzzy_finder_mappings) do

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

@@ -190,63 +190,60 @@ M.show_filter = function(state, search_as_you_type, fuzzy_finder_mode, use_fzy)
       vim.api.nvim_win_set_height(winid, height)
     end
   end)
-  local close_input = function()
-    vim.cmd("stopinsert")
-    input:unmount()
-    -- If this was closed due to submit, that function will handle the reset_search
-    vim.defer_fn(function()
-      if fuzzy_finder_mode and utils.truthy(state.search_pattern) then
-        fs.reset_search(state, true)
-      end
-    end, 100)
-    restore_height()
-  end
+  local cmds = {
+    move_cursor_down = function(_state, _scroll_padding)
+      renderer.focus_node(_state, nil, true, 1, _scroll_padding)
+    end,
+
+    move_cursor_up = function(_state, _scroll_padding)
+      renderer.focus_node(_state, nil, true, -1, _scroll_padding)
+      vim.cmd("redraw!")
+    end,
+
+    close = function()
+      vim.cmd("stopinsert")
+      input:unmount()
+      -- If this was closed due to submit, that function will handle the reset_search
+      vim.defer_fn(function()
+        if fuzzy_finder_mode and utils.truthy(state.search_pattern) then
+          fs.reset_search(state, true)
+        end
+      end, 100)
+      restore_height()
+    end,
+  }
 
-  input:on({ event.BufLeave, event.BufDelete }, close_input, { once = true })
+  input:on({ event.BufLeave, event.BufDelete }, cmds.close, { once = true })
 
   input:map("i", "<C-w>", "<C-S-w>", { noremap = true })
 
-  if fuzzy_finder_mode then
-    local cmds = {
-      move_cursor_down = function(_state, _scroll_padding)
-        renderer.focus_node(_state, nil, true, 1, _scroll_padding)
-      end,
-
-      move_cursor_up = function(_state, _scroll_padding)
-        renderer.focus_node(_state, nil, true, -1, _scroll_padding)
-        vim.cmd("redraw!")
-      end,
-
-      close = function()
-        close_input()
-      end,
-    }
-    for lhs, cmd_name in pairs(require("neo-tree").config.filesystem.window.fuzzy_finder_mappings) do
-      local t = type(cmd_name)
-      if t == "string" then
-        local cmd = cmds[cmd_name]
-        if cmd then
-          input:map(
-            "i",
-            lhs,
-            create_input_mapping_handle(cmd, state, scroll_padding),
-            { noremap = true }
-          )
-        else
-          log.warn(
-            string.format("Invalid command in fuzzy_finder_mappings: %s = %s", lhs, cmd_name)
-          )
-        end
-      elseif t == "function" then
+  if not fuzzy_finder_mode then
+    return
+  end
+
+  for lhs, cmd_name in pairs(require("neo-tree").config.filesystem.window.fuzzy_finder_mappings) do
+    local t = type(cmd_name)
+    if t == "string" then
+      local cmd = cmds[cmd_name]
+      if cmd then
         input:map(
           "i",
           lhs,
-          create_input_mapping_handle(cmd_name, state, scroll_padding),
+          create_input_mapping_handle(cmd, state, scroll_padding),
           { noremap = true }
         )
       else
         log.warn(string.format("Invalid command in fuzzy_finder_mappings: %s = %s", lhs, cmd_name))
       end
+    elseif t == "function" then
+      input:map(
+        "i",
+        lhs,
+        create_input_mapping_handle(cmd_name, state, scroll_padding),
+        { noremap = true }
+      )
+    else
+      log.warn(string.format("Invalid command in fuzzy_finder_mappings: %s = %s", lhs, cmd_name))
     end
   end
 end

lua/neo-tree/types/config/filesystem.lua

@@ -34,7 +34,7 @@
 ---@class neotree.Config.Filesystem.Renderers : neotree.Config.Renderers
 
 ---@class neotree.Config.Filesystem.Window : neotree.Config.Source.Window
----@field fuzzy_finder_mappings table<string, neotree.FuzzyFinder.Commands|"close">?
+---@field fuzzy_finder_mappings table<string, neotree.FuzzyFinder.Commands>?
 
 ---@class (exact) neotree.Config.Filesystem : neotree.Config.Source
 ---@field async_directory_scan "auto"|"always"|"never"|nil