README.md

Table Structures

The tables for keymaps, commands, and augroup/autocmds are all similar.

Descriptions can be specified either in the top-level description property on each table, or inside the opts table as opts.desc = 'Description goes here'.

For autocmds, you must include a description property for it to appear in the finder. This is a design decision because keymaps and commands are frequently executed manually, so they should appear in the finder by default, while executing autocmds manually with :doautocmd is a much less common use-case, so autocmds are hidden from the finder unless a description is provided.

You can also run :LegendaryApi, then search for /legendary.types to read the full API documentation on accepted types.

• Keymaps
• Commands
• Functions
• augroup/autocmds

In-Place Item Filters

All items also support a special in-place filtering syntax, so the item can define its own filter. The filters property should be a table defining one or more filters. The table supports special properties bt = value or buftype = value to automatically filter by buffer type, and ft = value or filetype = value to automatically filter by file type. You may also include custom filter functions in the filters table as a list. For example:

local keymaps = {
  { '<C-v>', description = 'Open in vertical split', filters = { ft = 'NvimTree' } },
  {
    '<leader>qt',
    description = 'Do something',
    filters = {
      ft = 'CustomType', -- can also be a list { 'Markdown', 'CustomType' }
      bt = 'nofile', -- can also be a list { 'nofile', 'acwrite' }
      function(item, context)
        -- here, item is the parsed item itself,
        -- context is a context object, see "Filter Context" below
        return myCustomLogic(context)
      end,
    },
  },
}

local commands = {
  { ':Glow', description = 'Preview Markdown with Glow', filters = { ft = 'markdown' } },
  {
    ':Something',
    description = 'Do something',
    filters = {
      function(item, context)
        -- same function signature as keymaps
      end,
    },
  },
}

Filter Context

The context table passed to filters contains the following properties:

{
  buf = number, -- buffer ID
  buftype = string,
  filetype = string,
  mode = string, -- the mode that the UI was triggered from
  cursor_pos = table, -- { row, col }
  marks = table, -- visual mode marks, if applicable; { line, col, line, col }
}