v.2.8.2 (#130)

-   No user-facing changes
-   Security fixes in dependencies
-   Update internal dependencies: Node v16, npm v8
-   Close #126

.gitignore

@@ -1,6 +1,6 @@
 # Folders
 .idea/
-.vscode-test/
+.@vscode/test-electron/
 node_modules
 out
 

.vscode/launch.json

@@ -7,7 +7,6 @@
             "request": "launch",
             "runtimeExecutable": "${execPath}",
             "args": ["--extensionDevelopmentPath=${workspaceRoot}"],
-            "stopOnEntry": false,
             "sourceMaps": true,
             "outFiles": ["${workspaceRoot}/out/src/**/*.js"],
             "preLaunchTask": "npm: watch"

.vscodeignore

@@ -1,5 +1,5 @@
 .vscode/**
-.vscode-test/**
+.@vscode/test-electron/**
 out/test/**
 out/**/*.map
 src/**

Changelog.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 2.8.2 - 2022-06-11
+
+-   No user-facing changes
+-   Security fixes in dependencies
+-   Update internal dependencies: Node v16, npm v8
+-   Close #126
+
 ## 2.8.1 - 2021-05-09
 
 -   Fix indentation with `(::` ([#72](https://github.com/mark-wiemer/vscode-autohotkey-plus-plus/issues/72))

README.md

@@ -1,6 +1,13 @@
 # AutoHotkey Plus Plus (AHK++)
 
-AutoHotkey Plus Plus (AHK++) provides actively maintained, comprehensive AutoHotkey language support for VS Code. This includes IntelliSense and debug support, along with the standard code highlighting. AHK++ is a fork of [AutoHotkey Plus by cweijan](https://github.com/AutoHotkey-Plus/vscode-autohotkey).
+AutoHotkey Plus Plus (AHK++) provides AutoHotkey language support for VS Code. This includes:
+- IntelliSense
+- code highlighting
+- basic debug support
+- code formatting
+- ...and more!
+
+ AHK++ is a fork of [AutoHotkey Plus by cweijan](https://github.com/AutoHotkey-Plus/vscode-autohotkey), with the primary goal of fixing bugs and adding user-requested features.
 
 > View this README on the [project site](https://github.com/mark-wiemer/vscode-autohotkey-plus-plus#readme)
 
@@ -44,6 +51,8 @@ With AHK++, you can compile, debug, and run your scripts with keyboard shortcuts
 
 ## Debug
 
+> There are some [known issues with the debugger](https://github.com/mark-wiemer/vscode-autohotkey-plus-plus/issues?q=is%3Aopen+is%3Aissue+label%3Adebugger). If you need an advanced setup, we recommend [zero-plusplus.vscode-autohotkey-debug](https://marketplace.visualstudio.com/items?itemName=zero-plusplus.vscode-autohotkey-debug).
+
 1. Click Run or press F9.
 2. Debugger supports breakpoints, stack tracing, and variable watching
 

docs/Development.md

@@ -4,107 +4,61 @@ This document covers the development process, from writing code to publishing a
 
 ## Writing
 
-1. Write your change on an offshoot of `dev` (these are feature branches).
-
-1. Merge each change to `dev` via a squash-commit PR.
-
-    > `master` is still the default branch, but all PRs (aside from releases) should be merged to `dev`.
-
-1. Each new feature or multi-commit bugfixes should be developed on its own feature branch, then merged into `dev`.
-
-Trusted collaborators only: Bugfixes, lint fixes, and refactors can be done on `dev` directly if they are only one commit.
+1. Write your change on any branch other than `main`
+1. Merge each change to `main` via a squash-commit PR
 
 ## Testing
 
 -   Test all added commands
 -   Perform the formatting tests
 -   If the README was modified, confirm README appears as intended
--   Confirm links in README work (even if it wasn't modified: some of its targets be invalidated at any time)
 
-### Automated Tests
+### Automated tests
 
 1. Open the Debug console panel (`Ctrl + Shift + Y`)
-
 1. Run the tests (`debug test`)
-
     1. Select `Test Extension` in the Debug side bar
-
     1. Begin Debugging (`F5` or press the play button)
 
 The tests should run automatically, and you should see passing output in the Debug console within a few seconds.
 
 > Learn more about debugging at the [VS Code Debugging Guide](https://code.visualstudio.com/Docs/editor/debugging).
 
-## Starting a Release
-
-1.  Once the `dev` branch has all the features for a new release, create a new release branch named `v<major>.<minor>.<patch>` (e.g. `v1.2.3`).
-
-1.  Update the changelog. Once updated, the changelog should not be changed. This is to prevent feature creep.
-
-1.  Open a draft PR to merge to `master`. The title of the PR should be the name of the release branch, lowercase 'v'. The PR description should contain the changelog entry.
+## Starting a release
 
+1.  Update the changelog.
+1.  Open a draft PR to merge to `main`. The title of the PR should be e.g. `v2.8.2`, lowercase 'v'. The PR description should contain the changelog entry.
 1.  Fix any remaining issues with the code (but only make changes already logged in the changelog). Use the draft PR to easily detect issues.
-
-1.  Bump the version. The message of the commit should be the name of the release branch.
-
+1.  Bump the version in `package.json`. The message of the commit should be e.g. `v2.8.2`.
 1.  Push the changes.
-
 1.  Merge the PR. The body of the commit message should be the changelog entry.
-
-1.  Pull `master`.
-
+1.  Checkout `main`
 1.  Package the new version using `vsce package`.
-
 1.  Install the new version:
-
     1. Select the newly-created `.vsix` file.
-
     1. Open the context menu (right-click).
-
     1. Select `Install Extension VSIX`.
-
     1. Reload the window.
-
 1.  Perform final pre-release tests.
-
     -   If tests fail, there are two choices:
-
         1. Delay the release until the tests pass (preferred choice)
-
             > Changes can be made on the same release branch, same package version
-
         1. Create issues for the newly-introduced failures before releasing, then publish the release anyway
 
 ### Publishing
 
-1. `git checkout dev`
-
-1. `git merge v<major>.<minor>.<patch>`
-
 1. Tag the release
-
     1. Delete the release branch in local
-
-    1. `git checkout master`
-
+    1. `git checkout main`
     1. `git tag v<major>.<minor>.<patch>`
-
     1. `git push origin v<major>.<minor>.<patch>`
-
     1. [Create a new release for this tag](https://github.com/mark-wiemer/vscode-autohotkey-plus-plus/tags)
-
         1. Release title: Same as in [Changelog.md](../Changelog.md)
-
         1. Description: Same as in changelog
-
         1. Attach binary
-
         1. Publish release
-
 1. Publish the release through [Visual Studio Marketplace](https://marketplace.visualstudio.com/manage/publishers/mark-wiemer)
-
     1. Select the ellipsis `Actions` icon and select `Update`.
-
     1. Upload the `.vsix` release file packaged in a previous step.
 
-    > The release is usually available within 5 minutes of uploading.
+The release is usually available within 5 minutes of uploading.

docs/Getting started.md

@@ -0,0 +1,12 @@
+# Getting started
+
+To contribute to this project, install the following dependencies:
+
+1. Install dependencies
+  1. Node 16 (automatically comes with npm 8)
+  1. VS Code (of course!)
+1. Clone the repo
+1. Setup the repo
+  1. `npm install`
+
+To verify everything is set up correctly, open the "Run and Debug" viewlet (`Ctrl+Shift+D`) and Start Debugging the "Launch Extension" configuration (`F5`). This should open a new VS Code window that has the extension activated :)