search

echasnovski / mini.nvim

Library of 40+ independent Lua modules improving overall Neovim (version 0.8 and higher) experience with minimal effort
MIT License
4.54k stars 175 forks source link

mini.clue: add option to hide keymaps #864

Closed rafamadriz closed 2 months ago

rafamadriz commented 2 months ago

Contributing guidelines

Module(s)

clue

Description

Hello, I would like to know if the option to hide keymaps is something you would be open to add. Similar to #863, this is a another feature from which-key.nvim that can be useful for certain keys you really don't want to show up in the popup window for whatever reason. I know this is very specific and most people won't need it so it kinda goes against the mini part.

Here's an example, I know they don't have a description so it looks empty, but I simply don't want those to show up even if I added a description to them.

edit

If you're open to this let me know, I would be happy to implemented it.

ref: https://github.com/folke/which-key.nvim/pull/391

echasnovski commented 2 months ago

Thanks for the suggestion!

This has already come up in #490 with resolution that I don't think it is a good long term idea both for 'mini.clue' and users who manage their own config.

My suggestion would be to add description to those mappings: either by using desc option if those are created manually or with set_mapping_desc() function otherwise (exported specifically for this purpose).

Closing as not planned.