Skip to content

Latest commit

 

History

History
161 lines (107 loc) · 7.06 KB

readme.md

File metadata and controls

161 lines (107 loc) · 7.06 KB

AHK++

Full language support for AHK v1 and AHK v2

IntelliSense
Syntax highlighting
Debug support
Formatting (customizable!)
Quick help
...and more

Install

AHK++ is available for: VS Code | Theia IDE | VSCodium | any other IDE that supports *.vsix extensions

Download from a trusted source: Visual Studio Marketplace | Open VSX Registry | GitHub releases

AHK v2 full support is here! 🥂

AHK++ 6 incorporates AutoHotkey v2 Language Support by thqby, providing full support for AHK v2, including:

  • Running, debugging, and stopping v1 and v2 scripts without changing settings
  • Full syntax highlighting for v2 scripts
  • "Open help" (Ctrl + F1) opens language-specific help (and includes your text selection)
  • Unique icons for AHK v1 (blue) and v2 (green)
  • Rich IntelliSense support with snippets, hover text, and suggestions
  • Formatting files with many customized options

For all changes, including breaking changes, see the changelog

As always, please 🐛 report any issues

💚 Special thanks again to thqby, as this would not have been possible without thqby's open-source AutoHotkey v2 Language Support!


Commands

With AHK++, you can compile, debug, and run your scripts with keyboard shortcuts. You can also run a selection as a standalone script.

  • Compile: Ctrl + Shift + F9
  • Debug: Ctrl + Alt + F9
  • Open help: Ctrl + F1
  • Run: Ctrl + F9
  • Run selection: Ctrl + F8
  • Stop: Ctrl + F6

Debug

There are some known issues with the debugger. If you need an advanced setup, we recommend zero-plusplus.vscode-autohotkey-debug for now. Please open an issue if the built-in debugger does not support your needs. As zero-plusplus.vscode-autohotkey-debug is closed-source, we will be working to introduce advanced debugger features to ensure an open-source, collaborative, complete extension is available to the AHK community 🙂

  1. Click the debug button in the editor title menu (at the top right of the editor) or press Ctrl + Alt + F9.

  2. The debugger supports breakpoints, stack tracing, and variable watching

    Debug

Debug features

  1. Output message: You can use OutputDebug command instead of MsgBox to log values.

    Output

  2. Evaluate: Set and get variable values through the debug console.

    Evaluate

This extension provides basic debugging functions. If you need more debugging functions (such as conditional breakpoints), you can add an additional extension: Install vscode-autohotkey-debug.

Language features

Go to definition

  1. Supports navigation to symbol definition.
  2. Usage: Ctrl-click on the symbol to navigate to its definition.

Goto Definition

Find symbol references

Select a symbol, then:

  • Right-click and select Find All References.
  • Or press Shift + F12.

Hover tip

Usage: Hover over symbol to see IntelliSense documentation.

Hover

Outline

Assign name to block of code via double semicolon comment ;;Name and go to it from outline.

Block Name

Folding

Custom folding regions:

;region
MsgBox % "Collapse me!"
;endregion

; Block comments with regions
/* ;region
Collapse me!
*/ ;endregion

Code format

Supports standard VS Code formatting with a few options.

Code Format

Formatter directives

Formatter directives instruct the formatter to behave a certain way on sections of code.

  1. FormatBlockComment:

    ;@AHK++FormatBlockCommentOn
    /*
    ;All text inside block comment will be formatted like regular code.
    */
    ;@AHK++FormatBlockCommentOff
  2. AlignAssignment:

    ;@AHK++AlignAssignmentOn
    a          = 5 ; number five
    str        = legacy text = with equal symbol
    inputFile := "movie.mkv"
    abc       := "abc" ; string
    abc       := a + b
    ;@AHK++AlignAssignmentOff

💚 Acknowledgements

This extension relies heavily on open-source code. A huge thank you to all these open-source contributors who made the extension what it is today!

Links