fix(live): use fzf start event

chore: deprecate fzf < 0.36, it's been out since Jan 2023

Author: ibhagwan

README.md

@@ -56,7 +56,7 @@ Using [lazy.nvim](https://github.com/folke/lazy.nvim)
 ### Dependencies
 
 - [`neovim`](https://github.com/neovim/neovim/releases) version >= `0.9`
-- [`fzf`](https://github.com/junegunn/fzf) version > `0.25`
+- [`fzf`](https://github.com/junegunn/fzf) version > `0.36`
   or [`skim`](https://github.com/skim-rs/skim) binary installed
 - [nvim-web-devicons](https://github.com/nvim-tree/nvim-web-devicons)
   or [mini.icons](https://github.com/echasnovski/mini.icons)

doc/fzf-lua.txt

@@ -1,4 +1,4 @@
-*fzf-lua.txt*           For Neovim >= 0.9.0          Last change: 2025 June 28
+*fzf-lua.txt*           For Neovim >= 0.9.0          Last change: 2025 July 12
 
 ==============================================================================
 Table of Contents                                  *fzf-lua-table-of-contents*
@@ -100,7 +100,7 @@ Using lazy.nvim <https://github.com/folke/lazy.nvim>
 DEPENDENCIES                                            *fzf-lua-dependencies*
 
 - `neovim` <https://github.com/neovim/neovim/releases> version >= `0.9`
-- `fzf` <https://github.com/junegunn/fzf> version > `0.25` or `skim`
+- `fzf` <https://github.com/junegunn/fzf> version > `0.35` or `skim`
   <https://github.com/skim-rs/skim> binary installed
 - nvim-web-devicons <https://github.com/nvim-tree/nvim-web-devicons> or
   mini.icons <https://github.com/echasnovski/mini.icons> (optional)
@@ -1146,7 +1146,7 @@ CUSTOMIZATION                                          *fzf-lua-customization*
       },
       quickfix = {
         file_icons        = true,
-        only_valid        = false, -- select among only the valid quickfix entries
+        valid_only        = false, -- select among only the valid quickfix entries
       },
       quickfix_stack = {
         prompt = "Quickfix Stack> ",
@@ -1624,4 +1624,4 @@ I missed your name feel free to contact me and I'll add it below:
   previewer code while using nvim-bqf
   <https://github.com/kevinhwang91/nvim-bqf>
 
-vim:tw=78:ts=8:ft=help:norl:
+vim:tw=78:ts=8:ft=help:norl:

lua/fzf-lua/config.lua

@@ -671,8 +671,8 @@ function M.normalize_opts(opts, globals, __resume_key)
     if not opts.__FZF_VERSION then
       utils.err(string.format("'fzf --version' failed with error %s: %s", rc, err))
       return nil
-    elseif not utils.has(opts, "fzf", { 0, 25 }) then
-      utils.err(string.format("fzf version %s is lower than minimum (0.25), aborting.",
+    elseif not utils.has(opts, "fzf", { 0, 36 }) then
+      utils.err(string.format("fzf version %s is lower than minimum (0.36), aborting.",
         utils.ver2str(opts.__FZF_VERSION)))
       return nil
     end

lua/fzf-lua/core.lua

@@ -155,9 +155,10 @@ M.fzf_exec = function(contents, opts)
   -- the API accepts both tables and functions which we "stringify"
   -- We also send string commands as stringify is also responsible
   -- for multiprocess wrapping of shell commands with processing
-  contents = contents and shell.stringify(contents, opts) or nil
+  shell.clear_protected()
+  contents = contents and shell.stringify(contents, opts, nil, true) or nil
   assert(contents == nil or type(contents) == "string", "contents must be of type string")
-  return M.fzf_wrap(contents, opts)
+  return M.fzf_wrap(contents, opts, true)
 end
 
 ---@param contents string|fun(query: string): string|string[]|function
@@ -172,12 +173,14 @@ M.fzf_live = function(contents, opts)
   -- AKA "live": fzf acts as a selector only (fuzzy matching is disabled)
   -- each keypress reloads fzf's input usually based on the typed query
   -- utilizes fzf's 'change:reload' event or skim's "interactive" mode
-  opts.fn_reload = shell.stringify(contents, opts)
+  -- convert "reload" actions to fzf's `reload` binds
+  -- convert "exec_silent" actions to fzf's `execute-silent` binds
+  shell.clear_protected()
+  opts.fn_reload = shell.stringify(contents, opts, nil, true)
   local fzf_field_index = M.fzf_field_index(opts)
   local cmd = M.expand_query(opts.fn_reload, fzf_field_index)
-  opts = M.setup_fzf_interactive_flags(cmd, fzf_field_index, opts)
-  contents = opts.__fzf_init_cmd
-  return M.fzf_wrap(contents, opts)
+  contents, opts = M.setup_fzf_interactive_flags(cmd, fzf_field_index, opts)
+  return M.fzf_wrap(contents, opts, true)
 end
 
 M.fzf_resume = function(opts)
@@ -191,15 +194,19 @@ M.fzf_resume = function(opts)
   assert(opts == config.__resume_data.opts)
   opts = M.set_header(opts, opts.headers or {})
   opts.cwd = opts.cwd and libuv.expand(opts.cwd) or nil
-  opts.__resuming = true
-  M.fzf_exec(config.__resume_data.contents, config.__resume_data.opts)
+  M.fzf_wrap(config.__resume_data.contents, config.__resume_data.opts)
 end
 
 ---@param contents string?
 ---@param opts table
+---@param convert_actions boolean?
 ---@return thread, string, table
-M.fzf_wrap = function(contents, opts)
+M.fzf_wrap = function(contents, opts, convert_actions)
   opts = opts or {}
+  if convert_actions then
+    opts = M.convert_reload_actions(contents, opts)
+    opts = M.convert_exec_silent_actions(opts)
+  end
   local _co
   local wrapped = coroutine.wrap(function()
     _co = coroutine.running()
@@ -316,11 +323,6 @@ M.fzf = function(contents, opts)
       opts.actions[k] = actions.dummy_abort
     end
   end
-  if not opts.__resuming then
-    -- `opts.__resuming` is only set from `fzf_resume`, since we
-    -- not resuming clear the shell protected functions registry
-    shell.clear_protected()
-  end
   -- store last call opts for resume
   config.resume_set(nil, opts.__call_opts, opts)
   -- caller specified not to resume this call (used by "builtin" provider)
@@ -393,10 +395,6 @@ M.fzf = function(contents, opts)
 
   fzf_win:attach_previewer(previewer)
   local fzf_bufnr = fzf_win:create()
-  -- convert "reload" actions to fzf's `reload` binds
-  -- convert "exec_silent" actions to fzf's `execute-silent` binds
-  opts = M.convert_reload_actions(contents, opts)
-  opts = M.convert_exec_silent_actions(opts)
   local selected, exit_code = fzf.raw_fzf(contents, M.build_fzf_cli(opts, fzf_win),
     {
       fzf_bin = opts.fzf_bin,
@@ -998,7 +996,7 @@ local patch_shell_action = function(v, opts)
       items = (zero_matched and zero_selected) and {} or items
     end
     v.fn(items, opts)
-  end, opts, field_index)
+  end, opts, field_index, true)
 end
 
 -- converts actions defined with "reload=true" to use fzf's `reload` bind
@@ -1084,7 +1082,8 @@ M.convert_reload_actions = function(reload_cmd, opts)
     -- NOTE: this fixes existence of both load as function and rebind, e.g. git_status with:
     -- setup({ keymap = { fzf = { true, load = function() _G._fzf_load_called = true end } } }
     if type(opts.keymap.fzf.load) == "function" then
-      opts.keymap.fzf.load = "execute-silent:" .. shell.stringify_data(opts.keymap.fzf.load, opts)
+      opts.keymap.fzf.load = "execute-silent:"
+          .. shell.stringify_data(opts.keymap.fzf.load, opts, nil, true)
     end
     if rebind and type(opts.keymap.fzf.load) == "string" then
       return string.format("%s+%s", rebind, opts.keymap.fzf.load)
@@ -1148,7 +1147,7 @@ end
 ---@param command string
 ---@param fzf_field_index string
 ---@param opts table
----@return table
+---@return string?, table
 M.setup_fzf_interactive_flags = function(command, fzf_field_index, opts)
   -- query cannot be 'nil'
   opts.query = opts.query or ""
@@ -1190,8 +1189,6 @@ M.setup_fzf_interactive_flags = function(command, fzf_field_index, opts)
       )
 
   if opts._is_skim then
-    -- skim interactive mode does not need a piped command
-    opts.__fzf_init_cmd = nil
     opts.prompt = opts.__prompt or opts.prompt or opts.fzf_opts["--prompt"]
     if opts.prompt then
       opts.fzf_opts["--prompt"] = opts.prompt:match("[^%*]+")
@@ -1215,10 +1212,6 @@ M.setup_fzf_interactive_flags = function(command, fzf_field_index, opts)
     opts._fzf_cli_args = string.format("--interactive --cmd %s",
       libuv.shellescape(no_query_condi .. reload_command))
   else
-    -- **send an empty table to avoid running $FZF_DEFAULT_COMMAND
-    -- The above seems to create a hang in some systems
-    -- use `true` as $FZF_DEFAULT_COMMAND instead (#510)
-    opts.__fzf_init_cmd = utils.shell_nop()
     if opts.exec_empty_query or (opts.query and #opts.query > 0) then
       local q = not utils.__IS_WINDOWS and opts.query
           or libuv.escape_fzf(opts.query, utils.has(opts, "fzf", { 0, 52 }) and 0.52 or 0)
@@ -1234,9 +1227,13 @@ M.setup_fzf_interactive_flags = function(command, fzf_field_index, opts)
     end
     opts._fzf_cli_args = string.format("--bind=%s", libuv.shellescape(
       string.format("change:reload:%s%s", no_query_condi, reload_command)))
+    if utils.has(opts, "fzf", { 0, 35 }) then
+      opts._fzf_cli_args = opts._fzf_cli_args .. string.format(" --bind=%s",
+        libuv.shellescape(string.format("start:reload:%s%s", no_query_condi, reload_command)))
+    end
   end
 
-  return opts
+  return utils.shell_nop(), opts
 end
 
 -- query placeholder for "live" queries

lua/fzf-lua/previewer/builtin.lua

@@ -454,7 +454,7 @@ function Previewer.base:cmdline(_)
     -- save last entry even if we don't display
     self.last_entry = entry
     return ""
-  end, self.opts, "{} {q} {n}")
+  end, self.opts, "{} {q} {n}", false)
   return act
 end
 
@@ -481,7 +481,7 @@ function Previewer.base:zero(_)
         self.last_entry = nil
         vim.fn.delete(self._zero_lock, "d")
       end, self.delay)
-    end, self.opts, ""))
+    end, self.opts, "", false))
   return act
 end
 

lua/fzf-lua/previewer/fzf.lua

@@ -87,7 +87,7 @@ function Previewer.cmd:action(o)
   local act = shell.stringify_data(function(items, _, _)
     local entry = path.entry_to_file(items[1], self.opts)
     return entry.bufname or entry.path
-  end, self.opts, self.opts.field_index_expr or "{}")
+  end, self.opts, self.opts.field_index_expr or "{}", false)
   return act
 end
 
@@ -214,7 +214,7 @@ function Previewer.cmd_async:cmdline(o)
     local cmd = errcmd or ("%s %s %s"):format(
       self.cmd, self.args, libuv.shellescape(filepath))
     return cmd
-  end, self.opts, "{} {q}")
+  end, self.opts, "{} {q}", false)
   return act
 end
 
@@ -278,7 +278,7 @@ function Previewer.bat_async:cmdline(o)
       line_range,
       libuv.shellescape(filepath))
     return cmd
-  end, self.opts, "{} {q}")
+  end, self.opts, "{} {q}", false)
   return act
 end
 
@@ -379,7 +379,7 @@ function Previewer.git_diff:cmdline(o)
     -- cmd = string.format("%s %s %s", table.concat(setenv, " "), cmd, pager)
     cmd = string.format("%s %s", cmd, pager)
     return { cmd = cmd, env = env }
-  end, self.opts, "{}")
+  end, self.opts, "{}", false)
   return act
 end
 
@@ -398,7 +398,7 @@ function Previewer.man_pages:cmdline(o)
     local manpage = require("fzf-lua.providers.manpages").manpage_sh_arg(items[1])
     local cmd = self.cmd:format(manpage)
     return cmd
-  end, self.opts, "{}")
+  end, self.opts, "{}", false)
   return act
 end
 
@@ -435,7 +435,7 @@ function Previewer.help_tags:cmdline(o)
       end
     end
     return cmd
-  end, self.opts, "{}")
+  end, self.opts, "{}", false)
   return act
 end
 

lua/fzf-lua/profiles/telescope.lua

@@ -8,7 +8,7 @@ end
 return {
   { "default-title" }, -- base profile
   desc       = "match telescope default highlights|keybinds",
-  fzf_opts   = { ["--layout"] = "default", ["--marker"] = "+" , ["--cycle"] = true},
+  fzf_opts   = { ["--layout"] = "default", ["--marker"] = "+", ["--cycle"] = true },
   winopts    = {
     width   = 0.8,
     height  = 0.9,

lua/fzf-lua/rpc.lua

@@ -82,7 +82,7 @@ local rpc_nvim_exec_lua = function(opts)
     vim.fn.chanclose(chan_id)
   end)
 
-  if not success or opts.debug then
+  if not success or opts.debug == "v" or opts.debug == 2 then
     io.stderr:write(("[DEBUG] debug = %s\n"):format(opts.debug))
     io.stderr:write(("[DEBUG] function ID = %d\n"):format(opts.fnc_id))
     io.stderr:write(("[DEBUG] fzf_lua_server = %s\n"):format(opts.fzf_lua_server))
@@ -107,7 +107,18 @@ local args = vim.deepcopy(_G.arg)
 args[0] = nil -- remove filename
 local opts = {
   fnc_id = tonumber(table.remove(args, 1)),
-  debug = table.remove(args, 1) == "true",
+  debug = (function()
+    local ret = table.remove(args, 1)
+    if ret == "nil" then
+      return nil
+    elseif ret == "true" then
+      return true
+    elseif ret == "false" then
+      return false
+    else
+      return tonumber(ret) or tostring(ret)
+    end
+  end)(),
   fzf_selection = args,
   fzf_lua_server = vim.env.FZF_LUA_SERVER or vim.env.SKIM_FZF_LUA_SERVER or vim.env.NVIM,
 }

lua/fzf-lua/shell.lua

@@ -235,7 +235,7 @@ end
 ---Fzf field index expression, e.g. "{+}" (selected), "{q}" (query)
 ---@param fzf_field_index string?
 ---@return string, integer?
-M.stringify = function(contents, opts, fzf_field_index)
+M.stringify = function(contents, opts, fzf_field_index, protect)
   assert(contents, "must supply contents")
 
   -- TODO: should we let this assert?
@@ -411,20 +411,27 @@ M.stringify = function(contents, opts, fzf_field_index)
     end
   end, fzf_field_index or "", opts.debug)
 
-  M.set_protected(id)
+  -- "protect" a function ptr, cleared when opening a new picker in `core.fzf()`
+  -- protected functions include init (content) commands and acrions (reload
+  -- and execute-silent), previewer trigger commands are excluded (zero event
+  -- and preview callback)
+  if protect then
+    M.set_protected(id)
+  end
+
   return cmd, id
 end
 
-M.stringify_cmd = function(fn, opts, fzf_field_index)
+M.stringify_cmd = function(fn, opts, fzf_field_index, protect)
   assert(type(fn) == "function", "fn must be of type function")
   return M.stringify(fn, {
     __stringify_cmd = true,
     PidObject = utils.pid_object("__stringify_cmd_pid", opts),
     debug = opts.debug,
-  }, fzf_field_index)
+  }, fzf_field_index, protect)
 end
 
-M.stringify_data = function(fn, opts, fzf_field_index)
+M.stringify_data = function(fn, opts, fzf_field_index, protect)
   assert(type(fn) == "function", "fn must be of type function")
   return M.stringify(function(cb, _, ...)
     local ret = fn(...)
@@ -436,7 +443,7 @@ M.stringify_data = function(fn, opts, fzf_field_index)
       cb(tostring(ret))
     end
     cb(nil)
-  end, { debug = opts.debug }, fzf_field_index)
+  end, { debug = opts.debug }, fzf_field_index, protect)
 end
 
 return M