Merge thqby 2.5.4

.gitattributes

@@ -0,0 +1,2 @@
+# Prettier defaults to LF and most files are already saved that way
+* text=auto eol=lf

.github/FUNDING.yml

@@ -4,4 +4,4 @@ github: thqby
 custom:
   - https://qr.alipay.com/fkx19566u7ctegoppmu5i13
   - https://github.com/thqby/vscode-autohotkey2-lsp/raw/main/pic/alipay.jpg
-  - https://www.paypal.me/thqby
+  - https://www.paypal.me/thqby

.github/workflows/node.js.yml → .github/workflows/build.yml

@@ -5,9 +5,9 @@ name: Build
 
 on:
   push:
-    branches: ["main"]
+    branches: ['main']
   pull_request:
-    branches: ["main"]
+    branches: ['main', 'upstream-main']
   workflow_dispatch:
   merge_group:
 
@@ -27,6 +27,6 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
-          cache: "npm"
+          cache: 'npm'
       - run: npm install
-      - run: npm run vscode:prepublish
+      - run: npm run validate:ci

.github/workflows/prettier.yml

@@ -0,0 +1,41 @@
+# Adapted from GitHub issue comment code by george-gca on 2024-01-16
+# https://github.com/prettier/prettier/issues/6885#issuecomment-1894252136
+
+name: Prettier diff
+
+on:
+  #   push:
+  #     branches: ['main']
+  #   pull_request:
+  #     branches: ['main']
+  workflow_dispatch:
+  # merge_group:
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        # AHK is built for Windows only, so we only build on Windows
+        # As always, if community asks, community shall receive ;)
+        os: [windows-latest]
+        node-version: [20.x]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Install Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'npm'
+      - run: npm install
+      - name: Run Prettier
+        id: runPrettier
+        # format is just `prettier --check .`
+        run: npm run format
+      - name:
+        if: ${{ failure() }}
+        # format:fix is just `prettier --write .`
+        run: |
+          npm run format:fix
+          git diff

.gitignore

@@ -1,9 +1,10 @@
-out
-dist
 node_modules
 .test-data
 .vscode-test
 .vscode-test-web
 *.vsix
 scripts/*
-server/expr_parser/*
+*.js
+*.js.map
+*.tsbuildinfo
+**/out/**/*.d.ts

.prettierignore

@@ -0,0 +1,34 @@
+out
+dist
+node_modules
+.test-data
+.vscode-test
+.vscode-test-web
+*.vsix
+scripts/*
+server/expr_parser/*
+
+client/src/browserClientMain.ts
+client/src/extension.ts
+client/src/test/utils.ts
+server/src/ahkProvider.ts
+server/src/browserServerMain.ts
+server/src/codeActionProvider.ts
+server/src/colorProvider.ts
+server/src/commandProvider.ts
+server/src/common.ts
+server/src/completionProvider.ts
+server/src/constants.ts
+server/src/definitionProvider.ts
+server/src/formattingProvider.ts
+server/src/hoverProvider.ts
+server/src/lexer.ts
+server/src/localize.ts
+server/src/PEFile.ts
+server/src/referencesProvider.ts
+server/src/renameProvider.ts
+server/src/scriptrunner.ts
+server/src/semanticTokensProvider.ts
+server/src/server.ts
+server/src/signatureProvider.ts
+server/src/symbolProvider.ts

.vscode-test.mjs

@@ -3,23 +3,25 @@ import { defineConfig } from '@vscode/test-cli';
 import { execSync } from 'child_process';
 
 let timeout, vscode_path;
-if (process.execPath.toLowerCase().endsWith('code.exe'))
-	timeout = 0;
+if (process.execPath.toLowerCase().endsWith('code.exe')) timeout = 0;
 else {
 	try {
-		const m = execSync('chcp 65001 && reg query HKCR\\vscode\\shell\\open\\command', { encoding: 'utf8' })
-			.match(/REG_SZ\s+("([^"]+)"|\S+)/);
+		const m = execSync(
+			'chcp 65001 && reg query HKCR\\vscode\\shell\\open\\command',
+			{ encoding: 'utf8' },
+		).match(/REG_SZ\s+("([^"]+)"|\S+)/);
 		vscode_path = m[2] || m[1];
-	} catch { }
+	} catch {}
 }
 
 export default defineConfig({
 	files: 'client/dist/test/**/*.test.js',
+	workspaceFolder: 'e2e',
 	mocha: {
 		failZero: true,
-		timeout
+		timeout: 60_000,
 	},
 	useInstallation: vscode_path && {
-		fromPath: vscode_path
-	}
-});
+		fromPath: vscode_path,
+	},
+});

.vscode/dev.code-snippets

@@ -0,0 +1,38 @@
+{
+	// Place ahk2-lsp workspace snippets here.
+	// Each snippet is defined under a snippet name and has a scope, prefix, body and description.
+	// Add comma-separated IDs of the languages where the snippet is applicable in the scope field.
+	// If scope is left empty or omitted, the snippet gets applied to all languages.
+	// The prefix is what is used to trigger the snippet and the body will be expanded and inserted.
+	// Possible variables are: $1, $2 for tab stops, $0 for the final cursor position,
+	// and ${1:label}, ${2:another} for placeholders.
+	// Placeholders with the same IDs are connected.
+	// Example:
+	// "Print to console": {
+	// 	"scope": "javascript,typescript",
+	// 	"prefix": "log",
+	// 	"body": [
+	// 		"console.log('$1');",
+	// 		"$2"
+	// 	],
+	// 	"description": "Log output to console"
+	// }
+	"Mocha tuple tests": {
+		"scope": "javascript,typescript",
+		"prefix": "suite",
+		"body": [
+			"suite('$1', () => {",
+			"    const tests: [",
+			"        name: string,",
+			"        args: Parameters<typeof $1>,",
+			"        expected: ReturnType<typeof $1>,",
+			"    ][] = [$0];",
+
+			"    tests.forEach(([name, args, expected]) =>",
+			"        test(name, () => assert.strictEqual($1(...args), expected)),",
+			"    );",
+			"});",
+		],
+		"description": "Generate tests for Mocha.",
+	},
+}

.vscode/extensions.json

@@ -3,4 +3,4 @@
 		"connor4312.esbuild-problem-matchers",
 		"dbaeumer.vscode-eslint"
 	]
-}
+}

.vscode/launch.json

@@ -8,12 +8,26 @@
 			"name": "Launch Client",
 			"runtimeExecutable": "${execPath}",
 			"preLaunchTask": "npm: watch",
-			"args": [
-				"--extensionDevelopmentPath=${workspaceFolder}"
-			],
-			"outFiles": [
-				"${workspaceFolder}/client/dist/**/*.js"
-			]
+			"args": ["--extensionDevelopmentPath=${workspaceFolder}"],
+			"outFiles": ["${workspaceFolder}/client/dist/**/*.js"]
+		},
+		{
+			"type": "extensionHost",
+			"request": "launch",
+			"name": "Launch Client (e2e)",
+			"runtimeExecutable": "${execPath}",
+			"preLaunchTask": "npm: build:e2e",
+			"args": ["--extensionDevelopmentPath=${workspaceFolder}"],
+			"outFiles": ["${workspaceFolder}/client/dist/**/*.js"]
+		},
+		{
+			"type": "extensionHost",
+			"request": "launch",
+			"name": "Launch Client (prod)",
+			"runtimeExecutable": "${execPath}",
+			"preLaunchTask": "npm: build",
+			"args": ["--extensionDevelopmentPath=${workspaceFolder}"],
+			"outFiles": ["${workspaceFolder}/client/dist/**/*.js"]
 		},
 		{
 			"type": "node",
@@ -27,18 +41,17 @@
 			]
 		},
 		{
+			// Results go to Debug Console (Ctrl+Shift+Y)
 			"name": "Extension Tests",
 			"type": "extensionHost",
 			"request": "launch",
 			"runtimeExecutable": "${execPath}",
-			"preLaunchTask": "npm: watch",
+			"preLaunchTask": "npm: build:e2e",
 			"args": [
 				"--disable-extensions",
 				"--extensionDevelopmentPath=${workspaceFolder}"
 			],
-			"outFiles": [
-				"${workspaceFolder}/client/dist/test/**/*.js"
-			],
+			"outFiles": ["${workspaceFolder}/client/dist/test/**/*.js"],
 			"testConfiguration": "${workspaceFolder}/.vscode-test.mjs"
 		},
 		{
@@ -61,10 +74,7 @@
 	"compounds": [
 		{
 			"name": "Client + Server",
-			"configurations": [
-				"Launch Client",
-				"Attach to Server"
-			]
+			"configurations": ["Launch Client", "Attach to Server"]
 		}
 	]
-}
+}

.vscode/settings.json

@@ -3,5 +3,7 @@
 	"typescript.tsc.autoDetect": "off",
 	"typescript.preferences.quoteStyle": "single",
 	"git.ignoreLimitWarning": true,
-	"AutoHotkey2.InterpreterPath": "c:\\Program Files\\AutoHotkey\\v2\\AutoHotkey64.exe"
-}
+	"AutoHotkey2.InterpreterPath": "c:\\Program Files\\AutoHotkey\\v2\\AutoHotkey64.exe",
+	"typescript.tsdk": "node_modules\\typescript\\lib",
+	"editor.formatOnSave": true
+}

.vscode/tasks.json

@@ -6,14 +6,16 @@
 			"script": "watch",
 			"group": "build",
 			"isBackground": true,
+			// Requires connor4312.esbuild-problem-matchers extension
 			"problemMatcher": "$esbuild-watch"
 		},
 		{
 			"type": "npm",
 			"script": "watch-web",
 			"group": "build",
 			"isBackground": true,
+			// Requires connor4312.esbuild-problem-matchers extension
 			"problemMatcher": "$esbuild-watch"
 		}
 	]
-}
+}