Which-key shows wrong labels from inactive keymaps

[ay4]

Hi,

I was looking at other issues and on Reddit, and saw that which-key doesn't always play well with general. That said, I'm not certain that this particular issue has been reported.

My goal in this minimal example is to construct a nested menu that works as follows:

1. Outside of org-mode: press s-o, see 's→+system', press s, see 'c→open config'
2. Inside org-mode: press press s-o, see 's→+system i→+insert', press i, see 's→source code', press s, see 's→shell'

What actually happens:

1. Outside of org-mode: press s-o, see 's→shell', press s, see 'c→open config'. In other words, what the menu does is correct, but the label is incorrect: it shows shell instead of system.
2. Inside org-mode: press press s-o, see 's→+shell i→+insert', press i, see 's→shell', press s, see 's→shell'. So, each time we see an s, the logic is correct but the label always chooses a certain keymap that, as I understand, shouldn't be even active (admittedly I don't exactly understand how keymaps work down to the last detail).

Here's the code that produces the above:

  (defconst ayleader "s-o")

  (general-define-key
  :prefix ayleader
  "s" '(:prefix-command aysystem-map :which-key "system")
)

(general-define-key
:keymaps 'aysystem-map
:wk-full-keys nil
"c" '((lambda()(interactive)(find-file "~/.emacs.d/README.org")) :which-key "open config")
)

(general-define-key
:prefix ayleader
:wk-full-keys nil
:keymaps 'org-mode-map
"i" '(:prefix-command ayorg-insert-map :which-key "insert")
)

(general-define-key
:keymaps 'ayorg-insert-map
:wk-full-keys nil
"s" '(:prefix-command ayorg-insert-source-map :which-key "source code")
)


(general-define-key
:keymaps 'ayorg-insert-source-map
:wk-full-keys nil
"s" '((lambda()(interactive)(insert "#+begin_src sh")) :which-key "shell")
) 

[noctuid]

There isn't anything special about general where would not play well with which-key, it's just :which-key uses which-key's older method of detecting what to show. I really need to update the documentation (see #505), but basically it is recommended to never use :which-key unless you need it for more advanced matching capabilities (here you don't). Instead you should use keymap-based replacement and bind to cons cells like (cons "description" <binding>).

[ay4]

Thanks a lot for a very swift response (and a fantastic package!). Unfortunately, being somewhat an amateur, I don't really grasp the internals of what :prefix-command does. I read the #505 and tried:

(defvar ayorg-insert-map (make-sparse-keymap))

(general-define-key
:prefix ayleader
:keymaps 'org-mode-map
"i" (cons "insert" ayorg-insert-map))
)

However now all of my ayorg-insert-map doesn't seem to get defined at all.

[ay4]

Okay, it's actually my bad, I added the extra parenthesis. i tried this three times and each time I added an extra one.

[noctuid]

It's working then, correct? I updated the documentation.

[JJdasWIESEL]

I can confirm that it is working correctly and that prefix and command labels are correctly displayed if using separate keymaps for the prefix mappings. Here is a minimal example with org and latex prefix maps, I use "," as a major-leader-key:

(general-create-definer wiesel/major-leader-keys
                        :states 'motion
                        :keymaps 'override
                        :prefix ",")

(defvar latex-toggle-map (make-sparse-keymap))

(define-key latex-toggle-map (kbd "m") #'latex-toggle-math-mode)

(wiesel/major-leader-keys
                       :keymaps 'LaTeX-mode-map
    		       "t" (cons "toggle" latex-toggle-map))

(defvar org-table-map (make-sparse-keymap))

(define-key org-table-map (kbd "r") #'org-table-recalc)

(wiesel/major-leader-keys
               :keymaps 'org-mode-map
    	    "t" (cons "table" org-table-map))

However, as far as I understood, I would need to create new maps for every prefix in every major mode keybinding set in order to have which-key displaying correct labels for prefix commands. I hoped for a simpler solution.