invalid mode shortname

[klooj]

Is this on me?

To give this plugin a quick test run, I tried setting it up for descriptions only. So

1. in packer: use {'folke/which-key.nvim', config = [[require('wk')]]}
2. wk.lua just has the copy pasta default opts inside the wk.setup function, and then require('maps')
3. maps.lua is a longer version of:

local wk = require('which-key') 
local opts = {mode = 'n', prefix = '<leader>', buffer = nil, silent = true}
local maps = {
  [','] = 'comment',
  ['.'] = 'vimrc',
  [';'] = 'substitute',
  ['\\'] = 'nv tree',
  ['<Left>'] = 'mv buffer next',
  ['<Right>'] = 'mv buffer previous',
  ['='] = 'balance windows',
  ['h'] = 'split below',
  ['H'] = 'treesitter highlight',
  ['j'] = 'any jump',
  ['k'] = 'pick buffer',
}
wk.register(maps, opts)

[folke]

Thank you for reporting. When exactly does this error appear?

Just tried your config and it works. Is there a certain prefix that triggers this error?

[klooj]

hmmm. it happens immediately upon pushing the leader key. maybe there's a leftover parameter or clash somewhere from another which-key plugin. i'll debug some more to isolate it.

[folke]

Just to be sure you don't call :WhichKey on <leader> right? No need to do that as with vim-which-key.

[klooj]

It also seems to effect the d and g keys in normal mode. So neither d$ nor gg do anything. I'm kinda stumped.

[klooj]

ok ya that definitely is it.

[folke]

@klooj great. Can you show the exact keympaping you had in place that caused this?

I'll see if I can show a warning when someone else has leftovers from vim-which-key and handle it properly

[PSeitz]

I had this nnoremap <silent> <Leader> :WhichKey '<Space>'<CR>

[klooj]

fershur. so there were two parts:

first, this is how i set my leader keys. i had to comment out those 4 lines in order for the popup to work. i think it's just a timing thing that could be fixed on my end.

second, these are the keymaps i had (they're wrapped in a custom function )

[folke]

That definitely caused it. You don't need to set any special keymaps for WhichKey to work.
Just pushed a change that shows an error when such a invalid keymap is called, so other users with the same issue will know what to do. Also updated the README.

[folke]

Your first 4 lines in the first screenshot are <nop> operations, so if those were loaded AFTER WhichKey, it wouldn't work. But why would you want to add these in, in the first place? :)

[klooj]

You are correct. When using certain gui's for nvim, they mess with the mapping of leader keys. So I put that in there to take control of the situation. I thought I called that function before loading any plugins but apparently my timing is off. Not a big deal at all though, rarely use a gui anymore.

Getting the perfect portable vimrc is comically similar to whack-a-mole.

[klooj]

this plugin is great. everything is working and I was able to jettison two plugins (vim-peekabo and vim-signature). three plugins for the price one.

fwiw, you may want to use wk.register({["j"] = "which_key_ignore", ["k"] = "which_key_ignore"}) for the example in the readme, so that people who have jk jj kj etc mapped to esc in insert mode can copy paste or at the very least be gently reminded they'll need to do it.