Introduction to IntelliJ Key Promoter X
Overview
IntelliJ Key Promoter X is a valuable tool for developers using IntelliJ-based Integrated Development Environments (IDEs) such as IDEA, Android Studio, or CLion. This plugin aids in the efficient use of keyboard shortcuts, thereby reducing the reliance on the mouse. By showcasing shortcuts corresponding to mouse actions, it encourages a more keyboard-centric approach to development, ultimately making coding faster and less cumbersome.
Features
One of the main features of Key Promoter X is its non-intrusive notifications that utilize IntelliJ's built-in message framework. This ensures that the notifications are both helpful and not distracting. The plugin also allows users to customize shortcuts easily and create new ones for actions that currently lack shortcuts. Additionally, it maintains a persistent hit-list of missed shortcuts within an IDEA tool-window, providing insights into which shortcuts are used less frequently. Users also have the option to suppress specific tips for shortcuts they choose not to adopt.
Installation and Usage
To install the Key Promoter X plugin, users can navigate to Settings | Plugins | Market Place in their IntelliJ IDE and search for "Key Promoter X." Once installed, whenever a button is clicked with the mouse, a notification will appear showing the corresponding keyboard shortcut. If a button lacks a shortcut, repeated clicks will prompt a notification allowing the user to create one.
The plugin works by detecting mouse-click actions within the IDE and tying them to potential shortcuts if available. It registers these actions and, if a shortcut exists, will notify the user of the action's name and its corresponding shortcut. If no shortcut exists, the plugin can suggest creating one based on user settings.
The Key Promoter X Tool-Window
Key Promoter X includes a tool-window that provides access to a hit-list of missed shortcuts and suppressed items. This window shows statistics about the shortcuts most frequently missed, allowing users to focus on learning these first. Suppressed shortcuts can be managed easily, and the tool-window allows clearing statistics or disabling notifications temporarily.
Settings and Customization
The plugin settings are accessible via Settings | Tools | Key Promoter X, offering customization of its behavior:
- General Settings: Users can choose to only display keyboard shortcuts and disable the plugin during presentations or distraction-free modes.
- Notification Settings: This section allows adjusting the frequency of notifications—setting how often notifications should appear.
- Enable For: Specifies which buttons will trigger notifications. A 'catch-all' feature captures a wide range of mouse-clicks, even those not directly on buttons, providing comprehensive coverage.
Development and Contributions
Key Promoter X is developed using Java and IntelIj's plugin framework. Its codebase is compact and well-documented, making it an excellent resource for anyone interested in learning how to develop IntelliJ plugins. The project is hosted on GitHub and features integrations for automatic builds.
Reporting Issues
Users encountering bugs or unusual behavior are encouraged to report these issues on the project's bug tracker.
Acknowledgements
The initial version of Key Promoter X was developed by Dmitry Kashin, with subsequent enhancements made by other contributors. The project has evolved over the years, providing developers with a powerful tool to enhance their productivity within IntelliJ IDEs.
By leveraging IntelliJ Key Promoter X, developers can streamline their workflow, minimize mouse usage, and become more proficient with keyboard shortcuts, ultimately enhancing their overall coding efficiency.