Dinamically show key bindings: which-key implementation

[MarcoIeni]

Introduction

I don't have experience with IntelliJ plugin development, so I would like to discuss with you if it is possible to implement something like which-key:

That is, when you press a key, all the possible key bindings are showed.

In order to implement this, a which-key IntelliJ plugin should be developed.

Which-key plugin requirements

This plugin should be able to do the following things:

Know <key bindings, action> pairs

The plugin shall be able to read all the key bindings and the associated actions defined by intellimacs.

I think that it can do it in two ways:

• by calling some IdeaVim API (I don't know if there are some).
  • [ ] Does IdeaVim exposes some APIs in order to know the key bindings defined by the user?
• by analyzing the *.vim files.
  • [ ] Is there a *.vim kotlin/java parser library?

Read the keys pressed by the user

The plugin shall be able to read the keyboard input in order to dinamically show available key bindings.

• [ ] if the which-key reads the keys pressed by the user, will ideavim execute the action when the action is completed? I.e. the keyboard is sent in broadcast to all plugins and each plugin manage it independently or only one plugin can read user input?

If which-key plugin doesn't interfere with IdeaVim, it only has to show the action names.

[dogma0]

This is amazing, keep at it please.

[MarcoIeni]

Yes, it would be a very useful feature :) I am waiting that someone with some knowledge of the intellij plugin ecosystem replies.

[MarcoIeni]

I found out that IdeaVim supports plugins extensions.

See:

• https://github.com/AlexPl292/IdeaVim-EasyMotion
• https://github.com/JetBrains/ideavim/tree/master/src/com/maddyhome/idea/vim/extension

Maybe this could be the right way to do this.

[smogstate]

cool

[MarcoIeni]

Just to be extremely clear: I am sorry, but I don't plan to work on this because currently I am not using intellij IDEs or programming in kotlin/java. :cry:

Anyway, if someone wants to develop this we can talk about it here.

If you want to see a proof of concept, VSpaceCode uses vscode-which-key to implement this feature.

[eltone]

It looks like some enterprising soul has made a start on an idea-vim plugin for this: https://github.com/TheBlob42/idea-which-key

[MarcoIeni]

OMG, this is so awesome..On my way to integrate it!

[MarcoIeni]

Alright. Can some of you test the content of #15 ? You have to:

cd .intellimacs
git pull
git checkout which-key

and then follow the new instructions in the readme.

I added support for the top commands and the ones under spc-w. If it works for you I will open an issue where I explain how to contribute in order to do the same for all the other keys :)

Also, let me know if the docs are sufficient.

When you are done, if you want to go back to the original version do:

git checkout main

[materemias]

I have tried that and it works great! are the differences only to install which-key plugin and enable via source ~/.intellimacs/which-key.vim ?

[MarcoIeni]

Yes! It works well also for me. Thanks for trying it out. I will continue to work on it, then.

[MarcoIeni]

Closing this in favor of #17 where I added instructions on how to solve this issue :) If you think something is not clear or you want some help to start contributing, please let me know.