Integrating with legendary.nvim so keys are registered with it?

[technicalpickles]

I'm trying to setup legendary.nvim to have a command-palette like thing. Currently, I'm using plugin specs to define my keys which will lazy load plugins when the keys are used, for example:

	{
		"folke/trouble.nvim",
		dependencies = "nvim-tree/nvim-web-devicons",
		cmd = { "TroubleToggle", "Trouble" },
		opts = {
			mode = "document_diagnostics",
		},
		keys = {
			{"<leader>xx", "<CMD>TroubleToggle<CR>", silent_noremap},
			{"<leader>xw", "<CMD>Trouble workspace_diagnostics<CR>", silent_noremap},
			{"<leader>xd", "<CMD>Trouble document_diagnostics<CR>", silent_noremap},
			{"<leader>xl", "<CMD>Trouble loclist<CR>", silent_noremap},
			{"<leader>xq", "<CMD>Trouble quickfix<CR>", silent_noremap},
			{"gR", "<CMD>Trouble lsp_references<CR>", silent_noremap},

			-- ⌘-shift-m - toggle quickfix (aka problems)
			{"<S-D-M>", "<cmd>TroubleToggle<CR>", silent_noremap},
			{"<leader>M", "<cmd>TroubleToggle<CR>", silent_noremap},
		}
	}

It also supports taking keys from which-key.

I could imagine a few ways to do this:

• move keys definitions to legendary's keys. the downside is that keys are all in one place if I want them to show up
• add a config which does the normal setup and then setup with legendary (can its setup be called multiple times?) or require('which-key).register
• something else?

The first is likely the easiest and most direct, but I'm hoping to have keys defined with their plugin.

[folke]

First of all, your keymaps are wrong. You do something like:
{"<leader>xx", "<CMD>TroubleToggle<CR>", {silent = true, remap = false}},

But it should be: {"<leader>xx", "<CMD>TroubleToggle<CR>", silent = true, remap = false},

In your keymaps, you can add descriptions, like so:

{"<leader>xx", "<CMD>TroubleToggle<CR>", silent = true, remap = false, desc = "Toggle Trouble"}

Whichkey automatically gets the description from the Neovim keymaps, so that's all you need.

I don't use legendary, but it seems it integrates with WhichKey? If so, then adding the descriptions like above is all you need.

If that's not how it works, then you should post a question there instead.

[technicalpickles]

Thanks, I've fixed those keybindings, and added desc. Confirmed that working 🎉

You are correct, there is integration for WhichKey, documented here. It seems that is only doing commands that are explicitly registered with WhichKey, rather than any that have been defined though.

I've started some discussions there, and can post back if there's anything to share. And there is already an issue about loading existing keymappings: mrjones2014/legendary.nvim#258