feat(rewrite)!: v3 is a full rewrite of which-key.nvim

[folke]

What's New?

• full rewrite that works a little different than before
• hooking into visual and operator pending mode is now done using ModeChanged, so no remapping needed anymore for operators.
• the weird secret mappings, are gone for good
• auto triggers are now never created for single keys apart from g and z. All other letters are unsafe.
• customizable delay independent of timeoutlen. Can be 0.
• more configuration options for the which-key window + presets for classic, modern and helix mode.
• enable/disable which-key for certain mapping modes
• configurable sorting, based on the concept of sorters. Builtin sorters include: local, order, group, alphanum, mod, lower, icase, desc, manual
• new option to expand groups with less than x keymaps
• configurable string replacement for key and desc. The default key formatter shows actual unicode keyboard keys.
• icons! Needs mini.icons for the best support:
  • if you use lazy.nvim, then some icons will be autodetected for keymaps belonging to certain plugins.
  • custom rules to decide what icon to use
  • in your mapping spec, you can specify what icon to use at any level, so at the node for <leader>g for example, to apply to all git keymaps.

• prevent which-key overlapping with the cursor position
• improved API. One of my favorite new keymaps is <leader>? that shows which-key for the current buffer, but only with buffer-local mappings. So basically the help for all keymaps defined by a plugin :)
  
• new and better mappings spec, more in line with vim.keymap.set and how you define keymaps with lazy.nvim

Todo

• create keymaps in register()
• distinction between actual keymap and just a desc
• virtual mappings wihtout real children?
• registers / counts?
• presets / plugins
• config?
• auto blacklist single keys for default keymaps (for mappings like aa, a hook would be created for a and a would be ignored)
• custom sorting
• gr doesn't work because of grn and friends
• same for gc opmode and gc normal mode
• yank and shift-paste hangs
• macro recording / macro execution
• spell
• spell with count, like 1z=
• which-key-ignore
• empty groups?
• timeoutlen and nowait
• ui presets
• ui opts & columns etc
• scroll window
• help text?
• plugin layout?
• ✅ 🔥🔥🚀
• minimize attach
• sometimes incorrectly attached gcc not working
• error handling for view
• spelling layout
• better mappings parser? Especially needs typings
• Mappings with mode v
• allow register from opts
• auto gen docs
• health
• <leader>gh_
• devicons support
• nowait, timeoutlen and delay
• more tests
• News
• Update Readme
• hint characters in desc
• new mappings DSL

Related Issue(s)

• fix Feature request: custom sort order #362
• fix How to change the order #131
• fix Preserve order of the mappings defined in wk.register() #264
• fix localleader which-key menu not showing up in some buffers #172
• close Show multicharacter mapping if only one element in group #90
• close feature to "flatten" a prefix group with only one binding #374
• fix bug: which-key menu not showing up for <localleader> mappings #476
• fix feature: Register group names without bindings #514
• fix WhichKey <buffer> #191
• fix Fully disable which-key for filetype #357
• fix [Help] Key mapping - same key, different mode = different command #153
• close skip grouping level and show full shortcut #208
• fix bug: which-key does not show up in visual mode and prevents key mappings from working #458
• fix feature: Manual trigger of which-key #575
• fix feature: Use ModeChanged autocmd to show the hints for operator-pending and visual mode #469
• fix [Feature Request] Support Insert Mode Completion sources #197
• fix bug: visual mode keymap <CR> not shown in which-key #540
• fix [Help] which-key doesn't show up when triggering commands starting with ',' (comma) character #257

Screenshots

Classic Mode

Modern Mode

Helix Mode