Downgrade intepreter path error to console log (#566)

mark-wiemer-org · Nov 9, 2024 · a4eae7e · a4eae7e
1 parent c0c0d9a
commit a4eae7e
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 3 deletions.
diff --git 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
diff --git 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
@@ -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
diff --git a/image/selectAHKV2Interpreter.png b/image/selectAHKV2Interpreter.png