Add description to keymaps that are set

[akinsho]

Hi @johmsalas,

Great work on this plugin, really enjoying using it so far 👍🏿

One very small thing I noticed was that the plugin sets a bunch of keymaps but doesn't set a desc on them, this is becoming increasingly useful as plugins like telescope and whichkey use this value to show readable descriptions for mappings. For any user of those or other plugins using this key, it would be really useful to get a description when setting the keymap so that it's clearer what can be done

Whichkey

Telescope

[johmsalas]

Good suggestion. I had not considered adding an integration with Which key but already have a working PoC. Should be solved soon

[akinsho]

@johmsalas just to be clear, you don't need to integrate with the plugin directly both telescope and which key will read the value of the desc key when set in a keymap so all you would need to do is just add a desc key when calling set keymap

[akinsho]

e.g.

vim.keymap.set('n', '<key>', lua_func, {desc = 'this is what I do'})

Both plugins will automatically show this is what I do for that key when searched

[johmsalas]

Wow so easy. Thanks @akinsho

Created a DRAFT PR. #8
I'm also adding integration with whichkey to show descriptions for partial keybindings, like ga or gao

[johmsalas]

Had to revert the PR. Will publish it soon, will need a test environment without which key. will setup a docker for this

[akinsho]

I left a comment in the old pull request about why you were seeing the issue. It was an issue with how pcall was being used with whichkey