Skip to content

Commit

Permalink
Add startup logs, full uninstall guide (#609)
Browse files Browse the repository at this point in the history
  • Loading branch information
mark-wiemer authored Feb 22, 2025
1 parent 838d258 commit b2570e7
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 2 deletions.
2 changes: 1 addition & 1 deletion ahk2
Submodule ahk2 updated 1 files
+18 −13 client/src/extension.ts
9 changes: 9 additions & 0 deletions cspell.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"version": "0.2",
"ignorePaths": [],
"dictionaryDefinitions": [],
"dictionaries": [],
"words": [],
"ignoreWords": [],
"import": []
}
10 changes: 9 additions & 1 deletion docs/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,12 @@ These steps shouldn't be necessary for most issues, and may be difficult to exec

### Debug logs

Using `Ctrl+Shift+U` to open the output view, you can select either of the AHK++ channels to see all debug logs. You're welcome to map these logs to `Output.debug` and `console.log` calls in the source code. Please include your findings if you [open a bug](https://github.com/mark-wiemer/ahkpp/issues/new/choose).
Using `Ctrl+Shift+U` to open the output view, you can select either of the AHK++ channels to see all debug logs. You're welcome to map these logs to `Out.debug` and `console.log` calls in the source code. Please include your findings if you [open a bug](https://github.com/mark-wiemer/ahkpp/issues/new/choose).

### Full uninstall and reinstall

VS Code automatically caches your extensions, even when uninstalled. You can use an app called [Everything](https://www.voidtools.com/downloads/) to quickly find and delete any cached versions, or navigate to them however you like. The default cache location is `~\AppData\Roaming\Code\CachedExtensionVSIXs\mark-wiemer.vscode-autohotkey-plus-plus`, where `~` is the path to your home folder, like `C:\Users\mark`, so the absolute path would start with `C:\Users\mark\AppData\...`.

After deleting these cache locations and restarting VS Code, you should be able to get a fully fresh installation from the registry. This should resolve any issues if you believe your installed extension files got corrupted.

![Everything search results showing two cached versions of AHK++](../image/cached-extensions-everything.png)
Binary file added image/cached-extensions-everything.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions src/common/out.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
import * as vscode from 'vscode';

/** Logs messages to IDE output channel */
// Name of this class is referenced in docs, update if changed
export class Out {
private static outputChannel: vscode.OutputChannel;

/**
* Logs the given value without focusing the output view.
* Prepends all logs with `new Date().toISOString()`.
*/
// Name of this func is referenced in docs, update if changed
public static debug(value: Error | string) {
Out.log(value, false);
}
Expand Down

0 comments on commit b2570e7

Please sign in to comment.