Default selected status

[notfound4]

I'am writting a plugin and I am having a problem related to fzf-lua.

At some point, a command of my plugin open fzf-lua to allow the user to selected one or more entry. What I'd like to do is having all the entry selected by default.

I'd also like that when enter is pressed with no entry selected, an empty array is returned.

I tried to find a solution but I'am still clueless on how to do it. Do you have any solution ?

Here is a simplified version of my code:

local fzf_lua = require("fzf-lua")
local builtin = require("fzf-lua.previewer.builtin")
spec = spec or {}

local display_items = {}
local display_to_processed_item = {}

if spec.items then
	local entry_maker_to_use = spec.entry_maker
		or function(item)
			local value, display, filename, lnum, col
			if type(item) == "table" then
				value = item.value or item
				display = item.display or item.label or item.name or tostring(value)
				filename = item.filename or item.file_path

				lnum = item.lnum or item.line or item.row
				col = item.col
			else
				value = item
				display = tostring(item)
				filename = tostring(item)
			end
			if type(value) == "table" and string.match(display, "^table: 0x") then
				display = value.display or value.label or value.name or display
			end

			if lnum then
				lnum = tonumber(lnum)
			end
			if col then
				col = tonumber(col)
			end

			return { value = value, display = display, filename = filename, lnum = lnum, col = col }
		end

	for _, item in ipairs(spec.items) do
		local processed = entry_maker_to_use(item)
		local display_key = processed.display or ""
		table.insert(display_items, display_key)
		display_to_processed_item[display_key] = processed
	end
end

local fzf_opts = {
	prompt = spec.title or "Select Item> ",
	cwd = spec.cwd or vim.loop.cwd(),
	fzf_opts = { ["--multi"] = true },
	actions = {
		["default"] = function(selected_list)
			if not selected_list then
				selected_list = {}
			end

			local results = {}
			for _, display_key in ipairs(selected_list) do
				local item = display_to_processed_item[display_key]
				if item then
					table.insert(results, item.value)
				end
			end

			if spec.on_submit then
				vim.schedule(function()
					spec.on_submit(results)
				end)
			end
		end,
		["ctrl-c"] = function()
			if spec.on_cancel then
				vim.schedule(spec.on_cancel)
			end
		end,
	},
}

if spec.preview_enabled ~= false then
	local GenericFzfPreviewer = builtin.buffer_or_file:extend()

	function GenericFzfPreviewer:new(o, opts, fzf_win)
		GenericFzfPreviewer.super.new(self, o, opts, fzf_win)
		setmetatable(self, GenericFzfPreviewer)
		return self
	end

	function GenericFzfPreviewer:parse_entry(entry_str)
		local item = display_to_processed_item[entry_str]
		if item and item.filename and type(item.filename) == "string" then
			return {
				path = item.filename,
				line = item.lnum,
				col = item.col,
			}
		end
		return {}
	end

	fzf_opts.previewer = GenericFzfPreviewer
end

if #display_items > 0 then
	fzf_lua.fzf_exec(display_items, fzf_opts)
elseif spec.exec_cmd then
	fzf_lua.fzf_exec(spec.exec_cmd, fzf_opts)
end

[ibhagwan]

On mobile so haven’t seen all the code yet but for pre select you can use keymap.fzf.start = "select-all"

[ibhagwan]

I'd also like that when enter is pressed with no entry selected, an empty array is returned.

Doesn’t this happen by default?

[notfound4]

By default, if multi is enabled and no entries are selected, pressing enter return the current line. If any entries are selected, they are returned instead.

[notfound4]

I have tried adding this in the options

		keymap = {
			fzf = {
				["start"] = "select-all",
			},
		},

but it didn't work. No entries are selected by default. I probably don't understand something.

[ibhagwan]

By default, if multi is enabled and no entries are selected, pressing enter return the current line. If any entries are selected, they are returned instead.

This is how the fzf field index {+} works, might be solveable using field_index with {n} as well, I’ll test this when I get a chance.

but it didn't work. No entries are selected by default. I probably don't understand something.

you did good, maybe use load event instead of start? I’ll have to test this when not AFK as well.

[notfound4]

load works perfectly ! Thank you.

For field index, I don't really understand how to use it and what it represent so i'll probably wait.

[ibhagwan]

load works perfectly ! Thank you.

For field index, I don't really understand how to use it and what it represent so i'll probably wait.

You can search the issues / discussions for field_index in actions, also read man fzf for {n}, I’m suspecting we can use both {+} {n} (as we already do internally) to detect if multi select was used or not.

When not AFK I’ll reply with a solution (if you don’t have it by then).

[ibhagwan]

This is what I meant to use {n}, unfortunately I don’t see any difference in either field index expressions when using multi select and not selecting anything, it basically falls back to current line with no distinction, you might have to request a feature upstream to solve this:

require("fzf-lua").fzf_exec({ "a", "b", "c", "d" }, {
  fzf_bin = "fzf",
  fzf_opts = { ["--multi"] = true },
  keymap = { fzf = { load = "select-all" } },
  actions = {
    enter = {
      fn = function(args)
        _G.dump("enter", args)
      end,
      field_index = "{n} {+}",
      exec_silent = true,
    }
  }
})

[ibhagwan]

Maybe @phanen has a creative idea?