How to use the Snacks.picker.smart() and its flags?

[DominikMendel]

Please correct me if I'm wrong, but this is the only documentation I see on functions like this :

SMART                                            *snacks-picker-sources-smart*

>vim
    :lua Snacks.picker.smart(opts?)
<

>lua
    ---@class snacks.picker.smart.Config: snacks.picker.Config
    ---@field finders? string[] list of finders to use
    ---@field filter? snacks.picker.filter.Config
    {
      multi = { "buffers", "recent", "files" },
      format = "file", -- use `file` format for all sources
      matcher = {
        cwd_bonus = true, -- boost cwd matches
        frecency = true, -- use frecency boosting
        sort_empty = true, -- sort even when the filter is empty
      },
      transform = "unique_file",
    }

1. If so... what do these fields even mean? How do I use them?

2. What is finders? string[] doign? "list of finders to use", use for what? I'm just a little lost in this area.

3. What is the multi table for?

4. I want to replace my use case for Snacks.picker.files() but I need to add the args for searching :

      local opts = {
        args = { "--hidden", "--no-ignore", "--type", "file", "--type", "symlink" },
      }

But I don't see any args parameter for Snacks.picker.smart().

5. Lastly, somewhat related. What id the frecency flag used in snacks.picker.matcher.Config's matcher = { frecency...? Is there a way to use frecency stuff outside of just Snacks.picker.smart(). Ideally I'd like to use frecency on everything possible.

Any help here would be greatly appreciated!

[drowning-cat]

1. About source, finder, format, transform, preview

Note

• source: Defines the picker configuration to use. It’s invoked with Snacks.picker.<source> and determines the associated finder, format, and preview logic.

• finder: A function responsible for returning the list of items. These items will later be:

  • transformed (via transform) to filter/modify entries based on certain rules.
  • formatted (via format) to include highlights, line numbers, and styling for display in the list, and

• preview: A function/box that provides a preview of the currently selected item.

2. This field is not used anywhere.

3. multi combines sources into a single results list.

4. Have you tried this?

smart = {
  multi = {
    { source = 'files', args = { '--exact-depth=100' } },
    { source = 'colorschemes' },
  },
  format = false,
  confirm = false,
}

5. frecency is just a field in the matcher config. You can use it anywhere the matcher is present.

opts.picker.matcher.frecency=true

[DominikMendel]

This is very helpful thank!

For your suggestion in 4, I will have to try this on another date with my work computer where I was seeing the issue.

A followup question for 3:
So I have been using various Snacks.picker.FOO() functions. To name a few lsp_symbols, todo_comments, help, keymaps, etc etc.
Does the smart picker support every picker? Like can I create symmetrical "single" pickers that use the "smart" logic, like so: Snacks.picker.smart({multi = { "just one finder, like lsp_symbols"}})

[DominikMendel]

I guess to partially answer my question. I used smart with multi = buffers and it worked well, but multi = { lsp_symbols } did not. So there is some limitations?

[DominikMendel]

Oh I guess, is Snacks.picker.smart() only used for finding files?

[drowning-cat]

Warning

I've updated the previous comment.

It should be possible to use sources with different formats. The only thing I haven’t figured out yet is why confirm doesn’t work as expected.

[drowning-cat]

Okay, this seems like a bug.

Repro

multi = {
  {
    source = 'colorschemes',
    confirm = function()
      vim.print "Doesn't work"
    end,
  },
},

The confirm function is not used as expected—instead, it falls back to the files confirm handler.

Fix

Relevant code:

snacks.nvim/lua/snacks/picker/config/init.lua

Lines 177 to 180 in bc0630e

	opts.confirm = opts.confirm
	or function(picker, item, action)
	return confirms[item.source_id](picker, item, action)
	end

Maybe it should be:

opts.actions.confirm = opts.confirm
  or function(picker, item, action)
    return confirms[item.source_id](picker, item, action)
  end