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

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

Related Issue(s)

• [ ] fix #362
• [ ] fix #131
• [ ] fix #264
• [ ] fix #172
• [ ] close #90
• [ ] close #374
• [ ] fix #476
• [ ] fix #514
• [ ] fix #191
• [ ] fix #357
• [ ] fix #153
• [ ] close #208
• [ ] fix #458
• [ ] fix #575
• [ ] fix #469
• [ ] fix #197
• [ ] fix #540
• [ ] fix #257

Screenshots

Classic Mode

Modern Mode

Helix Mode