Picker for snippets

[rrunner]

Would like to see a picker for snippets. The problem I have is that the prefix is an abbreviation of some type and it is not always obvious how to trigger snippets based on the prefix only. Thus, it would be useful to fuzzy find the snippets based on the description text which typically describes the snippet in a more human readable format (and possibly also the snippet body itself).

I don't know how to get all VSCode snippets defined for a certain buffer using blink.cmp. Can anyone please share insights on how to accomplish this. Thanks!

[drowning-cat]

Luasnip picker

---@class snacks.Picker
---@field [string] unknown

opts = {
  picker = {
    sources = {
      snippets = {
        supports_live = false,
        preview = 'preview',
        format = function(item, picker)
          local name = Snacks.picker.util.align(item.name, picker.align_1 + 5)
          return {
            { name, item.ft == '' and 'Conceal' or 'DiagnosticWarn' },
            { item.description },
          }
        end,
        finder = function(_, ctx)
          local snippets = {}
          for _, snip in ipairs(require('luasnip').get_snippets().all) do
            snip.ft = ''
            table.insert(snippets, snip)
          end
          for _, snip in ipairs(require('luasnip').get_snippets(vim.bo.ft)) do
            snip.ft = vim.bo.ft
            table.insert(snippets, snip)
          end
          local align_1 = 0
          for _, snip in pairs(snippets) do
            align_1 = math.max(align_1, #snip.name)
          end
          ctx.picker.align_1 = align_1
          local items = {}
          for _, snip in pairs(snippets) do
            local docstring = snip:get_docstring()
            if type(docstring) == 'table' then
              docstring = table.concat(docstring)
            end
            local name = snip.name
            local description = table.concat(snip.description)
            description = name == description and '' or description
            table.insert(items, {
              text = name .. ' ' .. description, -- search string
              name = name,
              description = description,
              trigger = snip.trigger,
              ft = snip.ft,
              preview = {
                ft = snip.ft,
                text = docstring,
              },
            })
          end
          return items
        end,
        confirm = function(picker, item)
          picker:close()
          --
          local expand = {}
          require('luasnip').available(function(snippet)
            if snippet.trigger == item.trigger then
              table.insert(expand, snippet)
            end
            return snippet
          end)
          if #expand > 0 then
            vim.cmd ':startinsert!'
            vim.defer_fn(function()
              require('luasnip').snip_expand(expand[1])
            end, 50)
          else
            Snacks.notify.warn 'No snippet to expand'
          end
        end,
      },
    },
  },
},

[rrunner]

Thanks Maestro. Is it possible to accomplish this without using luasnip (e.g. using only blink.cmp for example)?

[drowning-cat]

I have no idea. You can ask for some direction in the blink.cmp discussions; maybe someone generous will give you enough information. For the picker, you need a list of snippets that contains:

• a snippet's name and description
• the snippet's initial code (docstring)
• a function to trigger or insert a snippet
• (optional) the snippet's filetype for displaying the docstring
  • a way to distinguish a global snippet from a filetype-specific snippet

[gbcreation]

Thanks for the solution @drowning-cat.

I get the following error when confirming the selected snippet:

E5108: Lua: .../.local/share/nvim/lazy/LuaSnip/lua/luasnip/init.lua:78: wrong number of arguments to 'insert'

It comes from the function passed to the require('luasnip').available() function used in confirm. The Luasnip documentation indicates that the function passed as argument to available() takes a snippet, can find the desired information on it, and must return it. Here, the function does not return the snippet, what is unexpected by Luasnip.

The simple solution is to add a return snippet statement at the end of this function:

require('luasnip').available(function(snippet)
    if snippet.trigger == item.trigger then
        vim.print('match')
        table.insert(expand, snippet)
    end
    return snippet -- <-- Here
end)

[drowning-cat]

@gbcreation Thank you, I've updated the code.