chore: fzf previewer types

chore: base64 compat

chore: dedup codes

Author: phanen

lua/fzf-lua/previewer/fzf.lua

@@ -7,6 +7,7 @@ local Object = require "fzf-lua.class"
 
 local Previewer = {}
 
+---@class fzf-lua.previewer.Fzf: fzf-lua.Object,{}
 Previewer.base = Object:extend()
 
 -- Previewer base object
@@ -64,6 +65,8 @@ function Previewer.base:fzf_delimiter()
 end
 
 -- Generic shell command previewer
+---@class fzf-lua.previewer.Cmd : fzf-lua.previewer.Fzf,{}
+---@field super fzf-lua.previewer.Fzf,{}
 Previewer.cmd = Previewer.base:extend()
 
 function Previewer.cmd:new(o, opts)
@@ -92,6 +95,8 @@ function Previewer.cmd:action(o)
 end
 
 -- Specialized bat previewer
+---@class fzf-lua.previewer.Bat : fzf-lua.previewer.Cmd,{}
+---@field super fzf-lua.previewer.Cmd,{}
 Previewer.bat = Previewer.cmd:extend()
 
 function Previewer.bat:new(o, opts)
@@ -114,6 +119,8 @@ function Previewer.bat:cmdline(o)
 end
 
 -- Specialized head previewer
+---@class fzf-lua.previewer.Head : fzf-lua.previewer.Cmd,{}
+---@field super fzf-lua.previewer.Cmd,{}
 Previewer.head = Previewer.cmd:extend()
 
 function Previewer.head:new(o, opts)
@@ -133,6 +140,8 @@ function Previewer.head:cmdline(o)
 end
 
 -- new async_action from nvim-fzf
+---@class fzf-lua.previewer.CmdAsync : fzf-lua.previewer.Cmd,{}
+---@field super fzf-lua.previewer.Cmd,{}
 Previewer.cmd_async = Previewer.base:extend()
 
 function Previewer.cmd_async:new(o, opts)
@@ -218,6 +227,8 @@ function Previewer.cmd_async:cmdline(o)
   return act
 end
 
+---@class fzf-lua.previewer.BatAsync : fzf-lua.previewer.CmdAsync,{}
+---@field super fzf-lua.previewer.CmdAsync,{}
 Previewer.bat_async = Previewer.cmd_async:extend()
 
 ---@param lnum string?
@@ -283,6 +294,8 @@ function Previewer.bat_async:cmdline(o)
   return act
 end
 
+---@class fzf-lua.previewer.GitDiff : fzf-lua.previewer.Fzf,{}
+---@field super fzf-lua.previewer.Fzf,{}
 Previewer.git_diff = Previewer.base:extend()
 
 function Previewer.git_diff:new(o, opts)
@@ -384,6 +397,8 @@ function Previewer.git_diff:cmdline(o)
   return act
 end
 
+---@class fzf-lua.previewer.fzf.ManPages : fzf-lua.previewer.Fzf,{}
+---@field super fzf-lua.previewer.Fzf,{}
 Previewer.man_pages = Previewer.base:extend()
 
 function Previewer.man_pages:new(o, opts)
@@ -403,6 +418,8 @@ function Previewer.man_pages:cmdline(o)
   return act
 end
 
+---@class fzf-lua.previewer.fzf.HelpTags : fzf-lua.previewer.Fzf,{}
+---@field super fzf-lua.previewer.fzf.HelpTags,{}
 Previewer.help_tags = Previewer.base:extend()
 
 function Previewer.help_tags:fzf_delimiter()

lua/fzf-lua/previewer/init.lua

@@ -31,7 +31,7 @@ Previewer.builtin.codeaction = function() return require "fzf-lua.previewer.code
 ---Instantiate previewer from spec
 ---@param spec table
 ---@param opts table
----@return fzf-lua.previewer?
+---@return fzf-lua.previewer.Fzf|fzf-lua.previewer.Builtin?
 Previewer.new = function(spec, opts)
   if not spec then return end
   local previewer, preview_opts = nil, nil

lua/fzf-lua/providers/nvim.lua

@@ -63,26 +63,25 @@ M.commands = function(opts)
     end
   end
 
-  opts.flatten = opts.flatten or {}
-  for k, _ in pairs(global_commands) do
-    table.insert(entries, utils.ansi_codes.blue(k))
+  local add_subcommand = function(k, ansi_color)
     local flattened = vim.is_callable(opts.flatten[k]) and opts.flatten[k](opts)
         or opts.flatten[k] and vim.fn.getcompletion(k .. " ", "cmdline")
         or {}
     vim.list_extend(entries,
-      vim.tbl_map(function(cmd) return utils.ansi_codes.blue(k .. " " .. cmd) end,
+      vim.tbl_map(function(cmd) return ansi_color(k .. " " .. cmd) end,
         flattened))
   end
 
+  opts.flatten = opts.flatten or {}
+  for k, _ in pairs(global_commands) do
+    table.insert(entries, utils.ansi_codes.blue(k))
+    add_subcommand(k, utils.ansi_codes.blue)
+  end
+
   for k, v in pairs(buf_commands) do
     if type(v) == "table" then
       table.insert(entries, utils.ansi_codes.green(k))
-      local flattened = vim.is_callable(opts.flatten[k]) and opts.flatten[k](opts)
-          or opts.flatten[k] and vim.fn.getcompletion(k .. " ", "cmdline")
-          or {}
-      vim.list_extend(entries,
-        vim.tbl_map(function(cmd) return utils.ansi_codes.green(k .. " " .. cmd) end,
-          flattened))
+      add_subcommand(k, utils.ansi_codes.green)
     end
   end
 

lua/fzf-lua/shell.lua

@@ -239,12 +239,12 @@ M.stringify_mt = function(cmd, opts)
   else -- if opts.multiprocess then
     for _, k in ipairs({ "fn_transform", "fn_preprocess", "fn_postprocess" }) do
       local v = opts[k]
-      if type(v) == "function" and utils.__HAS_NVIM_010 then
+      if type(v) == "function" then
         -- Attempt to convert function to its bytecode representation
-        -- NOTE: limited to neovim >= 0.10 due to vim.base64
+        -- TODO: can be replaced with vim.base64 after neovim >= 0.10
         v = string.format(
-          [[return loadstring(vim.base64.decode("%s"))]],
-          vim.base64.encode(string.dump(v, true)))
+          [[return loadstring(require("fzf-lua.lib.base64").decode("%s"))]],
+          require("fzf-lua.lib.base64").encode(string.dump(v, true)))
         -- Test the function once with nil value (imprefect?)
         -- to see if there's an issue with upvalue refs
         local f = loadstring(v)()

lua/fzf-lua/types.lua

@@ -3,7 +3,7 @@ error("Cannot require a meta file")
 
 _G.FzfLua = require("fzf-lua")
 
----@class fzf-lua.previewer
+---@class fzf-lua.previewer.Fzf
 ---@field new function
 ---@field zero function?
 ---@field cmdline function?
@@ -37,13 +37,13 @@ _G.FzfLua = require("fzf-lua")
 ---@field cached_bufnrs { [string]: fzf-lua.previewer.CursorPos? }
 ---@field cached_buffers { [string]: fzf-lua.buffer_or_file.Bcache? }
 ---@field listed_buffers { [string]: boolean? }
+---@field clear_on_redraw boolean?
 ---
 ---@field orig_pos fzf-lua.previewer.CursorPos
 ---@alias fzf-lua.previewer.CursorPos (true|[integer, integer])
 
 ---@class fzf-lua.previewer.BufferOrFile
 ---@field match_id integer?
----@field clear_on_redraw boolean?
 
 ---@class fzf-lua.path.Entry
 ---@field stripped string
@@ -84,9 +84,10 @@ _G.FzfLua = require("fzf-lua")
 ---@alias fzf-lua.config.Actions { [string]: fzf-lua.config.Action }
 
 ---@class fzf-lua.ActionSpec
----@field fn function
+---@field [1] function?
+---@field fn function?
 ---@field exec_silent boolean?
----@field reload boolean|fun(opts: fzf-lua.Config):content
+---@field reload boolean|fun(opts: fzf-lua.Config):content?
 ---@field field_index string?
 ---@field desc string?
 ---@field prefix string?

lua/fzf-lua/win.lua

@@ -96,11 +96,15 @@ function TSInjector._attach_lang(buf, lang, regions)
 end
 
 ---@class fzf-lua.Win
----@field _previewer fzf-lua.previewer.Builtin|fzf-lua.previewer.BufferOrFile?
+---@field _previewer fzf-lua.previewer.Builtin|fzf-lua.previewer.Fzf?
 ---@field _preview_pos_force "up"|"down"
+---@field km_winid integer?
+---@field km_bufnr integer?
+---@field _hidden_save_size [integer, integer, integer]?
 local FzfWin = {}
 
 -- singleton instance used in win_leave
+---@type fzf-lua.Win?
 local _self = nil
 
 function FzfWin.__SELF()
@@ -1629,20 +1633,28 @@ function FzfWin.toggle_help()
     end
   end
 
+  ---TODO: we can always parse the action into table to avoid this duplicated logic
+  ---(e.g. profile/hide.lua, config.lua)
+  ---@param v fzf-lua.ActionSpec
+  ---@return string?
+  local get_desc = function(v)
+    if type(v) == "table" then
+      return v.desc or config.get_action_helpstr(v[1]) or config.get_action_helpstr(v.fn) or
+          tostring(v)
+    elseif v then
+      return config.get_action_helpstr(v) or tostring(v)
+    end
+  end
+
   -- action keymaps
   if self.actions then
     for k, v in pairs(self.actions) do
-      if k == "default" then k = "enter" end
-      if type(v) == "table" then
-        v = v.desc or config.get_action_helpstr(v[1]) or config.get_action_helpstr(v.fn) or v
-      elseif v then
-        v = config.get_action_helpstr(v) or v
-      end
-      if v then
-        -- skips 'v == false'
+      if v then -- skips 'v == false'
+        if k == "default" then k = "enter" end
+        local desc = get_desc(v)
         table.insert(keymaps,
           format_bind("action", k,
-            ("%s"):format(tostring(v)):gsub(" ", ""),
+            ("%s"):format(desc):gsub(" ", ""),
             opts.mode_width, opts.keybind_width, opts.name_width))
       end
     end