Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Downgrade intepreter path error to console log #566

Merged
merged 2 commits into from
Nov 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report--non-formatter-.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion ahk2
Submodule ahk2 updated from cec559 to 560aad
6 changes: 5 additions & 1 deletion changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 🗳️

Expand Down
16 changes: 15 additions & 1 deletion docs/Troubleshooting.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Binary file added image/ahkV2InterpreterAndPath.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added image/selectAHKV2Interpreter.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.