denist3r / intellij-autohotkey

AutoHotkey plugin for the Jetbrain's IntelliJ platform

AutoHotkey Plugin for the IntelliJ Platform

A simple plugin to bring support for AutoHotkey into IntelliJ-based IDEs!
Explore the docs »

Get Plugin · Report Bug · Request Feature

Table of Contents

• About the Project
• Getting Started
  • Prerequisites
  • Setting up a Development Environment
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

A simple plugin for developing AutoHotkey scripts. The following features are available:

• Syntax highlighting (under construction; v1 only; no error checking available currently)
• Run configurations (v1 and v2)
• Quick documentation
• Compile to exe (file right-click option)
• More to come in the future...

Check out the README on the plugin's GitHub page for more information on using this plugin.

Note: This plugin is under development and does not have a stable release yet. Please report any issues to the plugin's GitHub page.

---

Dependencies:

• Archive Browser plugin (for documentation assistance)

Usage

Install the plugin from the JetBrains Marketplace. The following features will become enabled:

• AutoHotkey File Recognition
  
• Syntax Highlighting (under construction; not complete yet)
  
• Run Configurations
  Allows you to run AutoHotkey scripts right in your IDE at the click of a button (or shortcut). Errors are logged straight to the console for easy debugging. Custom script arguments can be defined within the run configuration's settings.

  Note: Run configurations can be auto-generated and executed by clicking the green triangle in the gutter as seen next to Line 1 in the "Quick Documentation" screenshot.

• AutoHotkey Settings Page
  Custom page that allows you to manage AutoHotkey executables on your machine and swap between them easily in run configurations.
• Quick Documentation
  

  Note: The hyperlink shown at the bottom of the documentation popup will link to either the v1 or v2 documentation based on which executable you selected as the default in the AutoHotkey settings page.

• Line/Block Commenting
  Comments are toggled by selecting the comment action within the "Code" menu
• Compile to Executable
  Right-click an AutoHotkey file in the project tree and select the "Compile to exe" option to compile it to .exe

Getting Started

To get a local copy up and running, follow these simple steps:

Prerequisites

• IntelliJ IDEA 2020.* or newer (Community Edition is fine)
  Required plugins (for development only):
  • Grammar-Kit
  • PsiViewer
  • Kotest
  • Ktlint
• Java 11

Setting up a Development Environment

1. Clone the repo

git clone https://github.com/Nordgedanken/intellij-autohotkey.git

2. Open the cloned folder in IntelliJ
3. Run the "Run Plugin in test IDE" run configuration

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated, but please read CONTRIBUTING.md before starting any work.

License

Distributed under the GPL-3.0 License. See LICENSE for more information.

Contact

MTRNord - @mtrnord - https://matrix.to/#/@mtrnord:nordgedanken.dev

Project Link: https://github.com/Nordgedanken/intellij-autohotkey

Acknowledgements

• intellij-rust which provided a huge starting point to implement undocumented features
• intellij python plugin which also provided help with certain features
• idea-multimarkdown which also provided help with certain features