Composition Over Inheritence Refactor

.github/workflows/node.js.yml

@@ -29,7 +29,11 @@ jobs:
     - run: npm ci
     # For some reason, antlr4ng writes to a different location on the VM
     # than it does locally, preventing compile. Command added to move the generated files.
+    - run: npm run textMate
     - name: npm run antlr4ng
-      run: npm run antlr4ng && mv ./server/src/antlr/out/server/src/antlr/* ./server/src/antlr/out
+      run: npm run antlr4ng && npm run antlr4ngPre && mv ./server/src/antlr/out/server/src/antlr/* ./server/src/antlr/out
     - run: npm run compile
-    # - run: npm test
+    - run: xvfb-run -a npm test
+      if: runner.os == 'Linux'
+    - run: npm test
+      if: runner.os != 'Linux'

.gitignore

@@ -9,4 +9,5 @@ node_modules
 client/server
 .vscode-test
 sample*/**
-*.vsix
+*.vsix
+*.tsbuildinfo

.vscode-test.mjs

@@ -0,0 +1,10 @@
+// .vscode-test.mjs
+import { defineConfig } from '@vscode/test-cli';
+
+export default defineConfig({
+	files: 'client/out/test/**/*.test.js',
+	mocha: {
+		ui: 'tdd',
+		timeout: 4000
+	}
+});

.vscode/launch.json

@@ -46,6 +46,27 @@
 			"startRule": "startRule",
 			"printParseTree": true,
 			"visualParseTree": true
+		},
+		{
+			"name": "Debug ANTLR4 Pre grammar",
+			"type": "antlr-debug",
+			"request": "launch",
+			"input": "${file}",
+			"grammar": "server/src/antlr/vbapre.g4",
+			"startRule": "startRule",
+			"printParseTree": true,
+			"visualParseTree": true
+		},
+		{
+			"name": "Extension Tests",
+			"type": "extensionHost",
+			"request": "launch",
+			"runtimeExecutable": "${execPath}",
+			"args": [
+			  "--extensionDevelopmentPath=${workspaceFolder}",
+			  "--extensionTestsPath=${workspaceFolder}/client/out/test/index"
+			],
+			"outFiles": ["${workspaceFolder}/client/out/test/**/*.test.js"]
 		}
 	],
 	"compounds": [

.vscodeignore

@@ -23,6 +23,7 @@ contributing.md
 *.interp
 *.tokens
 *.vsix
+*.tsbuildinfo
 
 # Samples and testing
 sample*/**

client/package.json

@@ -16,7 +16,7 @@
 		"vscode-languageclient": "^9.0.1"
 	},
 	"devDependencies": {
-		"@types/vscode": "^1.94.0",
+		"@types/vscode": "^1.96.0",
 		"@vscode/test-electron": "^2.4.1"
 	}
 }

client/src/syntaxes/vba.tmLanguage.yaml

@@ -377,7 +377,7 @@ repository:
     repository:
       argsVariable:
         name: meta.arguments.argsVariable.vba
-        match: (?i),?\s*((?:Optional\s+)?(?:(?:ByVal|ByRef)\s+)?)?([a-z][a-z0-9_]*)(?:\s+(as\s+[a-z][a-z0-9_]*))?(\s*=\s*[^,)]+)?
+        match: (?i),?\s*((?:Optional\s+)?(?:(?:ByVal|ByRef)\s+)?)?([a-z][a-z0-9_]*)(\(\))?(?:\s+(as\s+[a-z][a-z0-9_]*))?(\s*=\s*[^,)]+)?
         # Attempted replacing \s with (?:\s+|\s*_\s*\n) to consume a space or a line ending but it refuses to play the game.
         # match: ~~ doesn't work (?i),?(?:\s+|\s*_\s*\n)*((?:Optional(?:\s+|\s*_\s*\n)+)?(?:(?:ByVal|ByRef)(?:\s+|\s*_\s*\n)+)?)?([a-z][a-z0-9_]*)(?:(?:\s+|\s*_\s*\n)+(as(?:\s+|\s*_\s*\n)+[a-z][a-z0-9_]*))?((?:\s+|\s*_\s*\n)*=(?:\s+|\s*_\s*\n)*[^,\n)]+)?
         # match: ~~ all broken (?i),?(?:\s*_\s*\n)*((?:Optional(?:\s+(?:\s*_\s*\n)*))?(?:(?:ByVal|ByRef)(?:\s+(?:\s*_\s*\n)*))?)?([a-z][a-z0-9_]*)(?:(?:\s+(?:\s*_\s*\n)*)(as\(?:\s+(?:\s*_\s*\n)*)[a-z][a-z0-9_]*))?((?:\s*_\s*\n)*=(?:\s*_\s*\n)*[^,)]+)?
@@ -428,7 +428,7 @@ repository:
         patterns:
           - include: "#lineContinuation"
       apostropheComments:
-        name: comment.line.apostropheXX.vba
+        name: comment.line.apostrophe.vba
         match: (?i)\s*'.*
       remarkComments:
         name: comment.line.remark.vba
@@ -460,6 +460,7 @@ repository:
         patterns:
           - include: "#comments"
           - include: "#literals"
+          - include: "#operators"
 
       moduleOption:
         name: keyword.control.vba
@@ -673,7 +674,7 @@ repository:
     repository:
       variableDeclaration:
         name: storage.var-declaration.vba
-        match: (?i)^\s*(Dim|Public|Private)\s+([a-z][a-z0-9_]*)(\(.*\))?(\s+As(?:\s+New)?\s+[A-Z][A-Z0-9_]*)?
+        match: (?i)^\s*(Dim|Public|Private|Global)\s+([a-z][a-z0-9_]*)([&%#!@$^])?(\(.*\))?(\s+As(?:\s+New)?\s+[A-Z][A-Z0-9_]*)?
         captures:
           1:
             # Dim|Private
@@ -682,28 +683,34 @@ repository:
             # varName
             name: variable.other.readwrite.vba
           3:
+            # Type hint?
+            name: support.type.primitive.vba
+          4:
             # Array bounds?
             patterns:
               - include: "#language"
-          4:
+          5:
             # As Type
             patterns:
               - include: "#types"
       constDeclaration:
         name: storage.const-declaration.vba
-        match: "^\\s*((?i)(?:(?:Public|Private)\\s+)?Const)\\s+([A-Z][A-Z0-9_]*)((?i)\\s+As\\s+[A-Z][A-Z0-9_]*)?(.*)"
+        match: ^\s*((?i)(?:(?:Public|Private)\s+)?Const)\s+([A-Z][A-Z0-9_]*)([&%#!@$^])?((?i)\s+As\s+[A-Z][A-Z0-9_]*)?(.*)
         captures:
           1:
             # Public|Private Const
-            name: constant.language.vba
+            name: storage.type.vba
           2:
             # CONSTNAME
-            name: variable.other.constant.property
+            name: variable.other.constant.vba
           3:
+            # Type hint?
+            name: support.type.primitive.vba
+          4:
             # As Type
             patterns:
               - include: "#types"
-          4:
+          5:
             # = "some value"
             patterns:
               - include: "#language"

client/src/test/completion.test.ts

@@ -1,43 +1,43 @@
-/* --------------------------------------------------------------------------------------------
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License. See License.txt in the project root for license information.
- * ------------------------------------------------------------------------------------------ */
+// /* --------------------------------------------------------------------------------------------
+//  * Copyright (c) Microsoft Corporation. All rights reserved.
+//  * Licensed under the MIT License. See License.txt in the project root for license information.
+//  * ------------------------------------------------------------------------------------------ */
 
-import * as vscode from 'vscode';
-import * as assert from 'assert';
-import { getDocUri, activate } from './helper';
+// import * as vscode from 'vscode';
+// import * as assert from 'assert';
+// import { getDocUri, activate } from './helper';
 
-suite('Should do completion', () => {
-	const docUri = getDocUri('completion.txt');
+// suite('Should do completion', () => {
+// 	const docUri = getDocUri('completion.txt');
 
-	test('Completes JS/TS in txt file', async () => {
-		await testCompletion(docUri, new vscode.Position(0, 0), {
-			items: [
-				{ label: 'JavaScript', kind: vscode.CompletionItemKind.Text },
-				{ label: 'TypeScript', kind: vscode.CompletionItemKind.Text }
-			]
-		});
-	});
-});
+// 	test('Completes JS/TS in txt file', async () => {
+// 		await testCompletion(docUri, new vscode.Position(0, 0), {
+// 			items: [
+// 				{ label: 'JavaScript', kind: vscode.CompletionItemKind.Text },
+// 				{ label: 'TypeScript', kind: vscode.CompletionItemKind.Text }
+// 			]
+// 		});
+// 	});
+// });
 
-async function testCompletion(
-	docUri: vscode.Uri,
-	position: vscode.Position,
-	expectedCompletionList: vscode.CompletionList
-) {
-	await activate(docUri);
+// async function testCompletion(
+// 	docUri: vscode.Uri,
+// 	position: vscode.Position,
+// 	expectedCompletionList: vscode.CompletionList
+// ) {
+// 	await activate(docUri);
 
-	// Executing the command `vscode.executeCompletionItemProvider` to simulate triggering completion
-	const actualCompletionList = (await vscode.commands.executeCommand(
-		'vscode.executeCompletionItemProvider',
-		docUri,
-		position
-	)) as vscode.CompletionList;
+// 	// Executing the command `vscode.executeCompletionItemProvider` to simulate triggering completion
+// 	const actualCompletionList = (await vscode.commands.executeCommand(
+// 		'vscode.executeCompletionItemProvider',
+// 		docUri,
+// 		position
+// 	)) as vscode.CompletionList;
 
-	assert.ok(actualCompletionList.items.length >= 2);
-	expectedCompletionList.items.forEach((expectedItem, i) => {
-		const actualItem = actualCompletionList.items[i];
-		assert.equal(actualItem.label, expectedItem.label);
-		assert.equal(actualItem.kind, expectedItem.kind);
-	});
-}
+// 	assert.ok(actualCompletionList.items.length >= 2);
+// 	expectedCompletionList.items.forEach((expectedItem, i) => {
+// 		const actualItem = actualCompletionList.items[i];
+// 		assert.equal(actualItem.label, expectedItem.label);
+// 		assert.equal(actualItem.kind, expectedItem.kind);
+// 	});
+// }