fix: make leader key descriptions in the keymap itself

[LemonBreezes]

This commit moves leader key descriptions from which-key-replacement-alist to the keymap itself. This helps with performance because that way, which-key does not have to calculate every single leader key description for each keypress. Furthermore, this fixes issues like #1413 where relocating leader keymaps resulted in which-key not showing the correct leader key descriptions.

I also made the leader prefix maps have their own prefix commands by populating the function slot of the keymap variables. This is an Emacs convention. I made doom-leader-map follow this convention as well, though I kept the doom/leader so as to not break existing configs.

[LemonBreezes]

So I removed the doom/leader line because ot broke my config somehow. Dunno why. Also, this doesn't make the localleader map relocatable but I'll look into that eventually.

[LemonBreezes]

Now you can define any key to doom-localleader-map symbol and it will work as expected. The which-key descriptions will work as expected too. The only caveat is that the localleader map is now updated using hooks so there the potential for bugs where the incorrect map is selected.

Basically, now doing

(map! :desc "<leader>" :nmv "DEL" #'doom-leader-map
      :desc "<leader>" :nmv "<backspace>" #'doom-leader-map)

works as expected with respect to the which-key descriptions and the local leader map.

[LemonBreezes]

I just pushed an update to exclude some minibuffer modes from doom-init-localleader-key-h and to also keep track of which major mode is being used by doom-localleader-key with doom-localleader-current-major-mode.

[LemonBreezes]

Okay. I am currently testing using doom-unreal-buffer-p instead of pattern-matching on modes for doom-init-localleader-key-h.

[LemonBreezes]

Hi. I have updated this to use post-command-hook and made a backwards compatibility fix. This PR is ready for review now.

[TheJJ]

why does this need to run after each and every command?

[LemonBreezes]

Originally I had it hooked to doom-switch-buffer-hook, doom-switch-frame-hook, doom-switch-window-hook, and after-change-major-mode-hook but then it kept running in unexpected scenarios that happened inter-command like when the Corfu popup would show up so I had to set a bunch of predicates for that hook to run and I was not able to find a working set of predicates. After switching it to a post-command-hook, I was able to remove all those predicates and just run the set-keymap-parent action itself. It runs fast enough to not cause any noticeable latency:

[emenel]

Just want to say that I've been testing this pr with my meow config, and it fixes the issues with using meow and doom's leader/localleader instead of meow's keypad mode. localleader now appears where it should and works perfectly along with meow's modes and doom's standard leader key (spc). Before, with meow, the localleader would not work via the doom leader (it had to be bound to a different top level key combination).

[LemonBreezes]

I just discovered issues with edge cases where the localleader map is used for a minor mode or for a derived mode, so for org-journal-map, the org-mode localleader bindings will not show up. I'm gonna be working on this. This is a pretty tough code to write.

[TheJJ]

could we merge or consider #7189 as a previous step please?

for me the ability to activate the leader key or alt-key combos in more evil states already solves my use-case. and it extends the more general approach from this patch to specify which evil states the leader and localleader map is for.

[LemonBreezes]

could we merge or consider #7189 as a previous step please?

for me the ability to activate the leader key or alt-key combos in more evil states already solves my use-case already. and it extends the more general approach from this patch to specify which evil states the leader and localleader map is for.

I am going to try to fix this this weekend. I really want to get this PR merged too because it's critical for my config.

[LemonBreezes]

Ok. I am going to stop working on this for some time since Hlissner said he was going to make major changes to the core keybindings code.

[emenel]

I realize this is on hold pending bigger changes ... but at the moment it's holding me back from updating with more recent doom commits. When I update to the current main branch with this PR I get errors from modules about bindings:

Error in a Doom module: modules/emacs/dired/config.el, (error Eager macro-expansion failure: (wrong-type-argument symbolp (dired-mode-map)))

I've looked around to see if I can figure out how to adapt the changes, but it's beyond my knowledge of Doom's inner workings and the time i have at the moment.

For now I'm just not updating, but I'd love to be able to keep my bindings working and update to get the latest changes occasionally.