Skip to content

donebd/vscode-keypromoter

Repository files navigation

Key Promoter

Extension that helps you to learn shortcuts while you are working.

Note: The current VScode API does not allow the plugin to be implemented in full. Therefore, the plugin was implemented in a workaround, and partially tracks user actions by indirect signs.

If you have any problems or you want to participate in the development, welcome to the project repository on GitHub

Features

example

  • When you use the mouse on a button inside the editor, the extension will shows you the keyboard shortcut that you should have used instead.

  • For buttons that don't have a shortcut, the extension prompts you with the possibility to directly create one by opening the menu.

Extension Settings

Name Description Default
Key Promoter.loyaltyLevel Number of command executions using mouse before notification 5
Key Promoter.ignoredCommands List of commands that will not be processed by the extension []
Key Promoter.suggestKeybindingCreation Specifies whether to suggest creation of keybindings for commands without them true
Key Promoter.logger.loggingLevel Control logging level "Info"

Notes

MacOs permission

Limitations

  • Some of the default editor actions are not supported
  • Other extensions commands are not supported
  • Can be problem on Linux Wayland
  • There may be incorrect behavior when working via wsl

Manual installation

  1. Clone repo:
git clone [email protected]:donebd/vscode-keypromoter.git
  1. Write in terminal:
npm run build
  1. Install builded .vsix file

Manual .vsix installation

Troubleshooting

Use Key Promoter output panel to see logs. You can change log level in settings.

Troubleshooting