Greatly cleanup and works towards ESM (#32)

* Revert "Add Vitest for unit tests (#30)"

This reverts commit 52aa813.

* Revert "Remove dupe config file (#31)"

This reverts commit aae4f9e.

* Remove rootDirs from client

* Remove rootDirs from server

* Add compile-ts to client

* Resolve modules via NodeNext

* Make client an ESM module

* Add compile-ts to server

* Update module resolution of server

* Make server an ESM module

* Use bundler resolution in client

* Remove unused tsconfig.json

* Use NodeNext for compatibility with AHK++

* Add logs

* Progress

* ESM but still not quite working

* More CJS building

* Fix clean

* Use server.cjs

* Further cleanup

* Ignore extension.cts when prettifying

.gitignore

@@ -5,9 +5,7 @@ node_modules
 *.vsix
 scripts/*
 *.js
+*.cjs
 *.js.map
 *.tsbuildinfo
-**/dist/**/*.d.ts
-
-# Vitest
-coverage
+**/dist/**/*.d.ts

.prettierignore

@@ -9,7 +9,7 @@ scripts/*
 server/expr_parser/*
 
 client/src/browserClientMain.ts
-client/src/extension.ts
+client/src/extension.cts
 client/src/test/utils.ts
 server/src/ahkProvider.ts
 server/src/browserServerMain.ts

.vscode/extensions.json

@@ -2,7 +2,6 @@
 	"recommendations": [
 		"aaron-bond.better-comments",
 		"dbaeumer.vscode-eslint",
-		"esbenp.prettier-vscode",
-		"vitest.explorer"
+		"esbenp.prettier-vscode"
 	]
 }

.vscode/launch.json

@@ -34,7 +34,7 @@
 			"runtimeExecutable": "${execPath}",
 			"args": ["--extensionDevelopmentPath=${workspaceFolder}"],
 			"env": {
-				"VSCODE_AHK_SERVER_PATH": "server/dist/server.js",
+				"VSCODE_AHK_SERVER_PATH": "server/dist/server.cjs",
 				"SYNTAXES_PATH": "syntaxes"
 			},
 			"outFiles": ["${workspaceFolder}/client/dist/**/*.js"],

build.mjs

@@ -14,7 +14,7 @@ console.log(
 build({
 	entryPoints: [path.join('./server/src/server.ts')],
 	bundle: true,
-	outfile: path.join('./server/dist/server.js'),
+	outfile: path.join('./server/dist/server.cjs'),
 	external: ['vscode'],
 	format: 'cjs',
 	platform: 'node',
@@ -25,9 +25,9 @@ build({
 // Node client (not necessary for AHK++, but super fast)
 // https://esbuild.github.io/api
 build({
-	entryPoints: [path.join('./client/src/extension.ts')],
+	entryPoints: [path.join('./client/src/extension.cts')],
 	bundle: true,
-	outfile: path.join('./client/dist/extension.js'),
+	outfile: path.join('./client/dist/extension.cjs'),
 	external: ['vscode'],
 	format: 'cjs',
 	platform: 'node',

client/package.json

@@ -3,6 +3,10 @@
 	"description": "VSCode part of a language server",
 	"license": "MIT",
 	"version": "0.0.1",
+	"type": "module",
+	"scripts": {
+		"compile-ts": "tsc"
+	},
 	"engines": {
 		"vscode": "^1.43.0"
 	}

client/src/extension.ts → client/src/extension.cts

@@ -29,17 +29,17 @@ import {
 	LanguageClientOptions,
 	ServerOptions,
 	TransportKind
-} from 'vscode-languageclient/node';
+} from 'vscode-languageclient/node.js';
 import { resolve } from 'path';
 import { ChildProcess, execSync, spawn } from 'child_process';
 import { readdirSync, readFileSync, lstatSync, readlinkSync, unlinkSync, writeFileSync } from 'fs';
-import { CfgKey, getAhkppConfig, getCfg, ShowOutput } from './config';
-import { resolvePath } from './utils';
+import { CfgKey, getAhkppConfig, getCfg, ShowOutput } from './config.cjs';
 
 let client: LanguageClient, outputchannel: OutputChannel, ahkStatusBarItem: StatusBarItem;
 const ahkprocesses = new Map<number, ChildProcess & { path?: string }>();
 let v2Interpreter = getCfg<string>(CfgKey.InterpreterPathV2), server_is_ready = false
 const textdecoders: TextDecoder[] = [new TextDecoder('utf8', { fatal: true }), new TextDecoder('utf-16le', { fatal: true })];
+const isWindows = process.platform === 'win32';
 let extlist: string[] = [], debugexts: Record<string, string> = {}, langs: string[] = [];
 const loadedCollection = {
 	'ahk2.browse': 'Browse your file system to find AutoHotkey2 interpreter',
@@ -61,8 +61,11 @@ const loadedCollection = {
 };
 
 export function activate(context: ExtensionContext): Promise<LanguageClient> {
+	// when debugging, this goes into the Debug Console (Ctrl + Shift + Y)
+	console.log('Activating AHK v2 language server');
+
 	/** Absolute path to `server.js` */
-	const defaultServerModule = context.asAbsolutePath(`ahk2/server/dist/server.js`);
+	const defaultServerModule = context.asAbsolutePath(`ahk2/server/dist/server.cjs`);
 	const serverModule = process.env.VSCODE_AHK_SERVER_PATH ? context.asAbsolutePath(process.env.VSCODE_AHK_SERVER_PATH) : defaultServerModule;
 
 	// If the extension is launched in debug mode then the debug server options are used
@@ -623,6 +626,34 @@ async function onDidChangegetInterpreter() {
 	}
 }
 
+/**
+ * Returns the provided path as an absolute path.
+ * Resolves the provided path against the provided workspace.
+ * Resolves symbolic links by default.
+ * Returns empty string if resolution fails.
+ */
+export function resolvePath(path: string | undefined, workspace?: string, resolveSymbolicLink = true): string {
+	if (!path)
+		return '';
+	const paths: string[] = [];
+	// If the path does not contain a colon, resolve it relative to the workspace
+	if (!path.includes(':'))
+		paths.push(resolve(workspace ?? '', path));
+	// If there are no slashes or backslashes in the path and the platform is Windows
+	if (!/[\\/]/.test(path) && isWindows)
+		paths.push(execSync(`where ${path}`, { encoding: 'utf-8' }).trim());
+	paths.push(path);
+	for (let path of paths) {
+		if (!path) continue;
+		try {
+			if (lstatSync(path).isSymbolicLink() && resolveSymbolicLink)
+				path = resolve(path, '..', readlinkSync(path));
+			return path;
+		} catch { }
+	}
+	return '';
+}
+
 /**
  * Returns whether the given path exists.
  * Only returns false if lstatSync give an ENOENT error.