chore: improve dev debugging experience

Author: heyzec

Diff for: .vscode/launch.json

@@ -3,15 +3,23 @@
 // Hover to view descriptions of existing attributes.
 // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
 {
-	"version": "0.2.0",
-	"configurations": [
-		{
-			"name": "Extension",
-			"type": "extensionHost",
-			"request": "launch",
-			"args": [
-				"--extensionDevelopmentPath=${workspaceFolder}"
-			]
-		}
-	]
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Run extension",
+      "type": "extensionHost",
+      "request": "launch",
+      "args": ["--extensionDevelopmentPath=${workspaceFolder}"],
+      "preLaunchTask": "Build"
+    },
+    {
+      "type": "node",
+      "request": "attach",
+      "name": "Attach to Server",
+      "address": "localhost",
+      "port": 6009,
+      "sourceMaps": true,
+      "outFiles": ["${workspaceRoot}/dist/*.js"]
+    }
+  ]
 }

Diff for: .vscode/tasks.json

@@ -0,0 +1,21 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "Build",
+      "type": "shell",
+      "command": "npm run build",
+      "options": {
+        "cwd": "${workspaceFolder}"
+      },
+      "group": {
+        "kind": "build",
+        "isDefault": true
+      },
+      "presentation": {
+        "reveal": "never",
+        "panel": "shared"
+      }
+    }
+  ]
+}

Diff for: README.md

@@ -20,7 +20,7 @@ If you want to test out the lsp, you can clone the repo and open up VSCode
 
 ```console
 git clone https://github.com/mug1wara26/source-lsp && cd source-lsp
-npm i 
+npm i
 code .
 ```
 
@@ -45,4 +45,20 @@ Documentation for diagnostics can be found [here](server/src/rules)
 ## Autocomplete
 
 Documentation for built in names or modules are generated by the script `server/src/docs/build_docs.mjs`. This script is not automatically run during the build process, as it is rarely updated.
-If an update to the autocomplete is required, run `npm run docs`.
+If an update to the autocomplete is required, run `npm run docs`.
+
+## Notes to developers
+
+### Debugging in VS Code
+Follow these steps to use the VS Code debugger to step through function calls in the server and client:
+
+1. Ensure VS Code is running on the root directory of this project. Open the _Run and Debug_ side panel by clicking or using the Ctrl+Shift+D shortcut.
+Observe that there is a dropdown to select launch configurations at the top, and a Call Stack panel at the middle.
+
+2. Run the _Run Extension_ debug launch config. This will automatically build the necessary files.
+A new VS Code window in debug mode should appear with expected LSP features working.
+You should now be able to set breakpoints in TS files within the client/ folder.
+
+3. Run the _Attach to Server_ debug launch config.
+If needed, ensure that a new debug session named `Remote Process [0] << Attach to Server 6009` appears in the Call Stack panel and does not die.
+You should now be able to set breakpoints in TS files within the server/ folder.

Diff for: client/src/extension.ts

@@ -1,8 +1,3 @@
-/* --------------------------------------------------------------------------------------------
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License. See License.txt in the project root for license information.
- * ------------------------------------------------------------------------------------------ */
-
 import * as path from 'path';
 import { workspace, ExtensionContext } from 'vscode';
 
@@ -27,13 +22,16 @@ export function activate(context: ExtensionContext) {
 		path.join("dist", 'source-lsp.js')
 	);
 
+    let debugOptions = { execArgv: ["--nolazy", "--inspect=6009"] };
+
 	// If the extension is launched in debug mode then the debug server options are used
 	// Otherwise the run options are used
 	const serverOptions: ServerOptions = {
 		run: { module: serverModule, transport: TransportKind.ipc },
 		debug: {
 			module: serverModule,
 			transport: TransportKind.ipc,
+			options: debugOptions
 		}
 	};
 
@@ -65,7 +63,7 @@ export function activate(context: ExtensionContext) {
 			const selectedVersion = await window.showQuickPick(versions, {
 				placeHolder: "Select the language version",
 			});
-		
+
 			if (selectedVersion) {
 				await setLanguageVersion(selectedVersion);
 			}
@@ -93,4 +91,4 @@ export function deactivate(): Thenable<void> | undefined {
 		return undefined;
 	}
 	return client.stop();
-}
+}

Diff for: package.json

@@ -5,7 +5,7 @@
   "version": "0.1.0",
   "main": "./client/out/extension",
   "engines": {
-    "vscode": "^1.96.0"
+    "vscode": "^1.93.0"
   },
   "categories": [
     "Programming Languages"