integrate with telescope.builtin.keymaps?

[JulianNymark]

(warning: newbie alert, I'm still figuring things out, and this idea might fall between the two plugins which-key and telescope... which is fully understandable 😅 )

But my idea was that since I use these two (amazing!) plugins together, I think it would be nice to have the "full docs" of all the intermediate keymap keys joined together in the final description of what's listed in telescope.builtin.keymaps.

(hopefully minimal) Example:

I register a "keymap grouping" in which-key like this:

require("which-key").register({
    ["<leader>t"] = { name = "[t]oggle", _ = "which_key_ignore" },
})

I then set a keymap that doesn't fully describe the keymap (only the last "fragment"). A good description of this keymap would be "[t]oggle [t]wilight (focus scope hl)".

vim.keymap.set("n", "<leader>tt", "<cmd>Twilight<CR>", { desc = "[t]wilight (focus scope hl)" })

This works great within which-key, since I step through the kemaps one by one, and I get to "piece together the full description" this way. But then in other tooling such as telescope.builtin.keymaps. If I search up this keymap, all i get is the following:

Here I don't get to see what the earlier keys "mean" (how I decided to group them).

It's not a huge deal, since I tend to learn my prefixes / groupings faster than the leaf-node keymaps themselves, but it would be amazing if there was a way for me to do some kind of concatenation of the which-key register names / descriptions.

---

This might be a silly question, and maybe there's a way to do this already (with some choice lua), so if anyone has any ideas (I don't even need fully working lua snippets to start my investigation either) please add them here! 🙌

[JulianNymark]

I see that there's another discussion about how register() is deprecated 😨, maybe I'm not using the right feature (group sounds way more appropriate 👀 )

[folke]

which key uses NEovim's keymap desriptions and so does telescope, so that's all already the same

[JulianNymark]

Then I'm probably setting things up wrongly on my end 😅, thanks for such a quick response! 😳

[JulianNymark]

I now have an actual idea, if there's a function that I can call to construct my own description when it's printed, then I could concatenate together my own 'full' description string from the groups of all the prior keys 🤔. If I figure something out I'll post it here. I think this would fall under the domain of telescope though... so maybe not too related here anymore.

[JulianNymark]

I feel like i'm onto something here, at least it seems to be all good from the Telescope side. I've copy-pasted the original impl for the keymaps picker and found the spot where I would need to iterate over the groups I have set in which-key that might exist for all substrings of a keymap.

(currently there's a TODO to locate where I think the new lookup will end up, but I just need to scour the which-key docs a bit to find a way to obtain the groups 🙌 )

current code : https://github.com/JulianNymark/configs/blob/master/nvim/lua/telescope_grouped_keymaps.lua

[JulianNymark]

I hacked together something that works! (at least it's a PoC) 🎉

My own picker for telescope (based on the original builtin keymaps picker) now looks up the keymap substrings to the left and concatenating the groups description if it matches a group. Below you can see the output of the picker.

I have groups set to the following:

	wk.add({
		{ "<leader>b", group = "[b]rowse" },
		{ "<leader>c", group = "[c]ode" },
		{ "<leader>d", group = "[d]ocument" },
		{ "<leader>f", group = "[f]ile" },
		{ "<leader>g", group = "[g]it" },
		{ "<leader>gl", group = "[l]ist" },
		{ "<leader>h", group = "Git [h]unk" },
		{ "<leader>n", group = "[n]oice" },
		{ "<leader>r", group = "[r]efactor" },
		{ "<leader>s", group = "[s]earch" },
		{ "<leader>t", group = "[t]oggle" },
		{ "<leader>w", group = "[w]orkspace" },
		{ "<leader><leader>", group = "utility" },
	})

I never wrote those full descriptions myself, as the keymap + desc for eg. twilight here is the following:

vim.keymap.set("n", "<leader>tt", "<cmd>Twilight<CR>", { desc = "[t]wilight (focus scope hl)" })

It doesn't say anything about [t]oggle, yet it's there in the keymap list 🎉.

how it currently works

I found the values of keymaps / groups via require("which-key.config").mappings.

The full source code for this picker is in the same link as above https://github.com/JulianNymark/configs/blob/master/nvim/lua/telescope_grouped_keymaps.lua

To test it out you can source the file and it registers a hotkey at the bottom to trigger it with <leader>sK. Now I haven't figured out how to get this to load after the plugins for both which-key and telescope have loaded yet 😳, this might be the harder part of all this, since I'm also new to lazy. I might have to make this into a "real plugin" for lazy and then I can specify dependencies that way? 🤔 ...