refactor(headers): consolidate set_header calls

Author: ibhagwan

lua/fzf-lua/core.lua

@@ -228,7 +228,6 @@ M.fzf_resume = function(opts)
   end
   opts = utils.tbl_deep_extend("force", config.__resume_data.opts, opts or {})
   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
   M.fzf_wrap(config.__resume_data.contents, config.__resume_data.opts)
 end
@@ -239,6 +238,7 @@ end
 ---@return thread, string, table
 M.fzf_wrap = function(cmd, opts, convert_actions)
   opts = opts or {}
+  M.set_header(opts)
   if convert_actions and type(opts.actions) == "table" then
     opts = M.convert_reload_actions(cmd, opts)
     opts = M.convert_exec_silent_actions(opts)
@@ -774,7 +774,15 @@ M.set_title_flags = function(opts, titles)
   return opts
 end
 
-M.set_header = function(opts, hdr_tbl)
+M.set_header = function(opts)
+  opts = opts or {}
+  if opts.header ~= nil
+      or opts.headers == false
+      or type(opts._headers) ~= "table"
+      or vim.tbl_isempty(opts._headers) then
+    return opts
+  end
+
   ---@param cwd string
   ---@return string
   local function normalize_cwd(cwd)
@@ -787,7 +795,6 @@ M.set_header = function(opts, hdr_tbl)
     return path.HOME_to_tilde(cwd)
   end
 
-  if not opts then opts = {} end
   if opts.cwd_prompt then
     opts.prompt = normalize_cwd(opts.cwd or uv.cwd())
     if tonumber(opts.cwd_prompt_shorten_len) and
@@ -796,9 +803,6 @@ M.set_header = function(opts, hdr_tbl)
     end
     opts.prompt = path.add_trailing(opts.prompt)
   end
-  if opts.no_header or opts.headers == false then
-    return opts
-  end
   local definitions = {
     -- key: opt name
     -- val.hdr_txt_opt: opt header string name
@@ -893,13 +897,8 @@ M.set_header = function(opts, hdr_tbl)
       end,
     },
   }
-  -- by default we only display cwd headers
-  -- header string constructed in array order
-  if not opts.headers then
-    opts.headers = hdr_tbl or { "cwd" }
-  end
   -- override header text with the user's settings
-  for _, h in ipairs(opts.headers) do
+  for _, h in ipairs(opts._headers) do
     assert(definitions[h])
     local hdr_text = opts[definitions[h].hdr_txt_opt]
     if hdr_text then
@@ -908,7 +907,7 @@ M.set_header = function(opts, hdr_tbl)
   end
   -- build the header string
   local hdr_str
-  for _, h in ipairs(opts.headers) do
+  for _, h in ipairs(opts._headers) do
     assert(definitions[h])
     local def = definitions[h]
     local txt = def.val(opts)

lua/fzf-lua/defaults.lua

@@ -360,6 +360,7 @@ M.defaults.files                = {
   toggle_hidden_flag     = "--hidden",
   toggle_follow_flag     = "-L",
   _actions               = function() return M.globals.actions.files end,
+  _headers               = { "actions", "cwd" },
   winopts                = { preview = { winopts = { cursorline = false } } },
 }
 
@@ -425,6 +426,7 @@ M.defaults.git                  = {
     fzf_opts          = { ["--multi"] = true, ["--scheme"] = "path" },
     _fzf_nth_devicons = true,
     _actions          = function() return M.globals.actions.files end,
+    _headers          = { "cwd" },
     winopts           = { preview = { winopts = { cursorline = false } } },
   },
   status = {
@@ -440,6 +442,7 @@ M.defaults.git                  = {
     fzf_opts          = { ["--multi"] = true },
     _fzf_nth_devicons = true,
     _actions          = function() return M.globals.actions.files end,
+    _headers          = { "actions", "cwd" },
     actions           = {
       ["right"]  = { fn = actions.git_unstage, reload = true },
       ["left"]   = { fn = actions.git_stage, reload = true },
@@ -461,6 +464,7 @@ M.defaults.git                  = {
     fzf_opts          = { ["--multi"] = true },
     _fzf_nth_devicons = true,
     _actions          = function() return M.globals.actions.files end,
+    _headers          = { "cwd" },
   },
   hunks = {
     previewer         = M._default_previewer_fn,
@@ -478,6 +482,7 @@ M.defaults.git                  = {
     },
     _fzf_nth_devicons = true,
     _actions          = function() return M.globals.actions.files end,
+    _headers          = { "cwd" },
   },
   commits = {
     cmd           = [[git log --color --pretty=format:"%C(yellow)%h%Creset ]]
@@ -489,6 +494,7 @@ M.defaults.git                  = {
       ["ctrl-y"] = { fn = actions.git_yank_commit, exec_silent = true },
     },
     fzf_opts      = { ["--no-multi"] = true },
+    _headers      = { "actions", "cwd" },
     _multiline    = false,
   },
   bcommits = {
@@ -504,6 +510,7 @@ M.defaults.git                  = {
       ["ctrl-y"] = { fn = actions.git_yank_commit, exec_silent = true },
     },
     fzf_opts      = { ["--no-multi"] = true },
+    _headers      = { "actions", "cwd" },
     _multiline    = false,
   },
   blame = {
@@ -534,6 +541,7 @@ M.defaults.git                  = {
     cmd_add    = { "git", "branch" },
     cmd_del    = { "git", "branch", "--delete" },
     fzf_opts   = { ["--no-multi"] = true },
+    _headers   = { "actions", "cwd" },
     _multiline = false,
   },
   tags = {
@@ -545,6 +553,7 @@ M.defaults.git                  = {
         .. [[%Cgreen(%><(12)%cr%><|(12))%Creset %s %C(blue)<%an>%Creset" {1}]],
     actions    = { ["enter"] = actions.git_checkout },
     fzf_opts   = { ["--no-multi"] = true },
+    _headers   = { "cwd" },
     _multiline = false,
   },
   stash = {
@@ -562,6 +571,7 @@ M.defaults.git                  = {
       ["--no-multi"]  = true,
       ["--delimiter"] = "[:]",
     },
+    _headers      = { "actions", "cwd", "search" },
   },
   icons = {
     ["M"] = { icon = "M", color = "yellow" },
@@ -598,6 +608,7 @@ M.defaults.grep                 = {
   glob_flag      = "--iglob", -- for case sensitive globs use '--glob'
   glob_separator = "%s%-%-",  -- query separator pattern (lua): ' --'
   _treesitter    = true,
+  _headers       = { "actions", "cwd" },
 }
 
 ---@diagnostic disable-next-line: assign-type-mismatch
@@ -621,6 +632,7 @@ M.defaults.args                 = {
   _fzf_nth_devicons = true,
   _actions          = function() return M.globals.actions.files end,
   actions           = { ["ctrl-x"] = { fn = actions.arg_del, reload = true } },
+  _headers          = { "actions", "cwd" },
 }
 
 M.defaults.oldfiles             = {
@@ -632,6 +644,7 @@ M.defaults.oldfiles             = {
   fzf_opts          = { ["--tiebreak"] = "index", ["--multi"] = true },
   _fzf_nth_devicons = true,
   _actions          = function() return M.globals.actions.files end,
+  _headers          = { "cwd" },
 }
 
 M.defaults.quickfix             = {
@@ -650,6 +663,7 @@ M.defaults.quickfix             = {
   _actions    = function() return M.globals.actions.files end,
   _treesitter = true,
   _cached_hls = { "path_colnr", "path_linenr" },
+  _headers    = { "actions", "cwd" },
 }
 
 M.defaults.quickfix_stack       = {
@@ -675,6 +689,7 @@ M.defaults.loclist              = {
   _actions    = function() return M.globals.actions.files end,
   _treesitter = true,
   _cached_hls = { "path_colnr", "path_linenr" },
+  _headers    = { "actions", "cwd" },
 }
 
 M.defaults.loclist_stack        = {
@@ -701,6 +716,7 @@ M.defaults.buffers              = {
   end,
   actions               = { ["ctrl-x"] = { fn = actions.buf_del, reload = true } },
   _cached_hls           = { "buf_nr", "buf_flag_cur", "buf_flag_alt", "path_linenr" },
+  _headers              = { "actions", "cwd" },
   _ctx                  = { includeBuflist = true },
   _resume_reload        = true,
 }
@@ -725,6 +741,7 @@ M.defaults.tabs                 = {
     ["--with-nth"]  = "5..",
   },
   _cached_hls    = { "buf_nr", "buf_flag_cur", "buf_flag_alt", "tab_title", "tab_marker", "path_linenr" },
+  _headers       = { "actions", "cwd" },
   _ctx           = { includeBuflist = true },
   _resume_reload = true,
 }
@@ -824,6 +841,7 @@ M.defaults.spellcheck           = {
     ["ctrl-s"] = { fn = actions.spell_suggest, header = "spell suggest" }
   },
   _cached_hls      = { "buf_name", "buf_nr", "buf_linenr", "path_colnr" },
+  _headers         = { "actions" },
   _fmt             = {
     to   = false,
     from = function(s, _)
@@ -882,6 +900,7 @@ M.defaults.colorschemes         = {
   winopts      = { height = 0.55, width = 0.50, backdrop = false },
   fzf_opts     = { ["--no-multi"] = true },
   actions      = { ["enter"] = actions.colorscheme },
+  _headers     = { "actions" },
 }
 
 M.defaults.highlights           = {
@@ -958,6 +977,7 @@ M.defaults.lsp                  = {
   _treesitter      = true,
   -- Signals actions to use uri triggering the use of `lsp.util.show_document`
   _uri             = true,
+  _headers         = { "actions", "regex_filter" },
 }
 
 M.defaults.lsp.symbols          = {
@@ -1029,6 +1049,7 @@ M.defaults.lsp.symbols          = {
   _actions         = function() return M.globals.actions.files end,
   actions          = { ["ctrl-g"] = { actions.sym_lsym } },
   _cached_hls      = { "live_sym", "path_colnr", "path_linenr" },
+  _headers         = { "actions", "cwd", "regex_filter" },
   _uri             = true,
 }
 
@@ -1064,6 +1085,7 @@ M.defaults.lsp.finder           = {
   fzf_opts    = { ["--multi"] = true },
   _treesitter = true,
   _cached_hls = { "path_colnr", "path_linenr" },
+  _headers    = { "actions", "regex_filter" },
   _uri        = true,
 }
 
@@ -1094,6 +1116,7 @@ M.defaults.diagnostics          = {
   },
   _actions       = function() return M.globals.actions.files end,
   _cached_hls    = { "path_colnr", "path_linenr" },
+  _headers       = { "actions", "cwd" },
   -- signs = {
   --   ["Error"] = { text = "e", texthl = "DiagnosticError" },
   --   ["Warn"]  = { text = "w", texthl = "DiagnosticWarn" },
@@ -1179,6 +1202,7 @@ M.defaults.command_history      = {
     ["enter"]  = actions.ex_run_cr,
     ["ctrl-e"] = actions.ex_run,
   },
+  _headers    = { "actions" },
 }
 
 M.defaults.search_history       = {
@@ -1189,6 +1213,7 @@ M.defaults.search_history       = {
     ["enter"]  = actions.search_cr,
     ["ctrl-e"] = actions.search,
   },
+  _headers    = { "actions" },
 }
 
 M.defaults.registers            = {
@@ -1284,6 +1309,7 @@ M.defaults.dap                  = {
       ["--with-nth"]  = "2..",
     },
     _cached_hls = { "path_colnr", "path_linenr" },
+    _headers    = { "actions", "cwd" },
   },
 }
 

lua/fzf-lua/providers/buffers.lua

@@ -205,7 +205,6 @@ M.buffers = function(opts)
   opts.fzf_opts["--header-lines"] = opts.fzf_opts["--header-lines"] == nil
       and (not opts.ignore_current_buffer and opts.sort_lastused) and "1" or nil
 
-  opts = core.set_header(opts, opts.headers or { "actions", "cwd" })
   opts = opts.filename_only and opts or core.set_fzf_field_index(opts)
 
   return core.fzf_exec(contents, opts)
@@ -450,7 +449,6 @@ M.tabs = function(opts)
     cb(nil)
   end
 
-  opts = core.set_header(opts, opts.headers or { "actions", "cwd" })
   opts = opts.filename_only and opts or core.set_fzf_field_index(opts, "{4}", "{}")
 
   return core.fzf_exec(contents, opts)
@@ -585,8 +583,6 @@ M.treesitter = function(opts)
     end)()
   end
 
-  opts = core.set_header(opts, opts.headers or { "actions" })
-
   return core.fzf_exec(contents, opts)
 end
 
@@ -690,8 +686,6 @@ M.spellcheck = function(opts)
     end)()
   end
 
-  opts = core.set_header(opts, opts.headers or { "actions" })
-
   return core.fzf_exec(contents, opts)
 end
 

lua/fzf-lua/providers/colorschemes.lua

@@ -510,7 +510,6 @@ M.awesome_colorschemes = function(opts)
     utils.setup_highlights()
   end
 
-  opts = core.set_header(opts, opts.headers or { "actions" })
   return core.fzf_exec(contents, opts)
 end
 

lua/fzf-lua/providers/dap.lua

@@ -117,9 +117,7 @@ M.breakpoints = function(opts)
     end)()
   end
 
-  opts = core.set_header(opts, opts.headers or { "actions", "cwd" })
   opts = core.set_fzf_field_index(opts, "{3}", opts._is_skim and "{}" or "{..-2}")
-
   return core.fzf_exec(contents, opts)
 end
 

lua/fzf-lua/providers/diagnostic.lua

@@ -258,7 +258,6 @@ M.diagnostics = function(opts)
     end)()
   end
 
-  opts = core.set_header(opts, opts.headers or { "actions", "cwd" })
   opts = core.set_fzf_field_index(opts)
   return core.fzf_exec(contents, opts)
 end

lua/fzf-lua/providers/files.lua

@@ -91,7 +91,6 @@ M.files = function(opts)
     opts.cwd = uv.cwd()
   end
   opts = core.set_title_flags(opts, { "cmd" })
-  opts = core.set_header(opts, opts.headers or { "actions", "cwd" })
   return core.fzf_exec(opts.cmd, opts)
 end
 
@@ -136,7 +135,6 @@ M.args = function(opts)
     end)()
   end
 
-  opts = core.set_header(opts, opts.headers or { "actions", "cwd" })
   return core.fzf_exec(contents, opts)
 end