diff --git a/.github/ISSUE_TEMPLATE/bug-report--non-formatter-.md b/.github/ISSUE_TEMPLATE/bug-report--non-formatter-.md index f43d5aec..fab15693 100644 --- a/.github/ISSUE_TEMPLATE/bug-report--non-formatter-.md +++ b/.github/ISSUE_TEMPLATE/bug-report--non-formatter-.md @@ -8,6 +8,8 @@ labels: bug assignees: mark-wiemer --- +For troubleshooting assistance, refer to the [troubleshooting guide](../../docs/Troubleshooting.md) + ## Description A clear and concise description of what the bug is. diff --git a/ahk2 b/ahk2 index cec559a9..560aade8 160000 --- a/ahk2 +++ b/ahk2 @@ -1 +1 @@ -Subproject commit cec559a9d0b6698c3b33f3ac88701e1d375a096f +Subproject commit 560aade8550e7dd17d6f78b3ac8360b4facf6ff1 diff --git a/changelog.md b/changelog.md index 2d16e2b7..7a939c30 100644 --- a/changelog.md +++ b/changelog.md @@ -2,8 +2,12 @@ ## 6.4.1 - unreleased 🛠️ -- Fix go to definition in AHK v1 files ([#559](https://github.com/mark-wiemer-org/ahkpp/issues/559)) - Add [troubleshooting guide](docs/Troubleshooting.md) +- Fix go to definition in AHK v1 files ([#559](https://github.com/mark-wiemer-org/ahkpp/issues/559)) +- Remove unnecessary error message "Couldn't resolve AHK v2 interpreter" ([#493](https://github.com/mark-wiemer-org/ahkpp/issues/493)) + - This has been moved to a console log visible in the AHK++ (v2) output channel + - A similar error message will still appear when attempting to debug with an unrecognized interpreter path + - See the new [troubleshooting guide](docs/Troubleshooting.md) for details ## 6.4.0 - 2024-11-02 🗳️ diff --git a/docs/Troubleshooting.md b/docs/Troubleshooting.md index fce053d2..9200f9dd 100644 --- a/docs/Troubleshooting.md +++ b/docs/Troubleshooting.md @@ -1,7 +1,21 @@ -# Troubleshooting +# Troubleshooting guide If AHK++ isn't behaving as you expect, here are some things you can try. +## AHK v2: Validate your interpreter + +For AHK v2, the language server may not behave correctly if it fails to identify a valid path to an interpreter like `AutoHotkey.exe`. The status bar at the bottom left of your IDE should show the current interpreter or an option to "Select AHK v2 Interpreter". + +Currently, AHK++ does not support the Windows Store edition of AHK v2, but there are plans to support it by the end of 2024, ref [#496](https://github.com/mark-wiemer-org/ahkpp/issues/496). + +Interpreter found: + +![AHK v2 interpreter version and path](../image/ahkV2InterpreterAndPath.png) + +Interpreter not found: + +![Select AHK v2 Interpreter in status bar](../image/selectAHKV2Interpreter.png) + ## Restart extensions Some settings changes only take effect after restart. Other issues may arise that are mitigated with a restart. diff --git a/image/ahkV2InterpreterAndPath.png b/image/ahkV2InterpreterAndPath.png new file mode 100644 index 00000000..561cb983 Binary files /dev/null and b/image/ahkV2InterpreterAndPath.png differ diff --git a/image/selectAHKV2Interpreter.png b/image/selectAHKV2Interpreter.png new file mode 100644 index 00000000..1e3f3bf6 Binary files /dev/null and b/image/selectAHKV2Interpreter.png differ