Improve Extension Authoring Experience with new Build Tasks and Launch Configs

.gitignore

@@ -7,8 +7,6 @@ obj/
 bin/
 out/
 sessions/
-test/.vscode/
-
 test-results.xml
 *.vsix
 *.DS_Store

examples/.vscode/settings.json

@@ -3,8 +3,4 @@
     // Relative paths for this setting are always relative to the workspace root dir.
     "powershell.scriptAnalysis.settingsPath": "./PSScriptAnalyzerSettings.psd1",
     "files.defaultLanguage": "powershell",
-    // Suppresses some first-run messages
-    "git.openRepositoryInParentFolders": "never",
-    "csharp.suppressDotnetRestoreNotification": true,
-    "extensions.ignoreRecommendations": true
 }

extension-dev.code-workspace

@@ -21,6 +21,8 @@
     ]
   },
   "settings": {
+    "window.title": "PowerShell VS Code Extension Development",
+    "debug.onTaskErrors": "prompt",
     "editor.tabSize": 4,
     "editor.insertSpaces": true,
     "files.trimTrailingWhitespace": true,
@@ -44,7 +46,17 @@
     "powershell.codeFormatting.whitespaceBetweenParameters": true,
     "powershell.codeFormatting.pipelineIndentationStyle": "IncreaseIndentationForFirstPipeline",
     // Lock the TypeScript SDK path to the version we use
-    "typescript.tsdk": "Client/node_modules/typescript/lib"
+    "typescript.tsdk": "Client/node_modules/typescript/lib",
+    // Code actions like "organize imports" ignore ESLint, so we need this here
+    "typescript.format.semicolons": "insert",
+    // Enable ESLint as defaut formatter so quick fixes can be applied directly
+    "eslint.format.enable": true,
+    "[typescript]": {
+      "editor.defaultFormatter": "dbaeumer.vscode-eslint",
+      "editor.formatOnPaste": true,
+      "editor.formatOnSave": true,
+      "editor.formatOnSaveMode": "modificationsIfAvailable"
+    }
   },
   "tasks": {
     "version": "2.0.0",
@@ -90,7 +102,7 @@
         "options": {
           "cwd": "${workspaceFolder:Client}"
         },
-        "command": "Invoke-Build Build",
+        "command": "./build.ps1",
         "problemMatcher": [
           "$msCompile",
           "$tsc"
@@ -106,7 +118,7 @@
         "options": {
           "cwd": "${workspaceFolder:Client}"
         },
-        "command": "Invoke-Build Test",
+        "command": "./build.ps1 -Test",
         "problemMatcher": [
           "$msCompile",
           "$tsc"
@@ -148,7 +160,39 @@
         },
         "command": "Invoke-Build ${input:serverBuildCommand}",
         "group": "build"
-      }
+      },
+      // HACK: Can't use task type npm in workspace config: https://github.com/microsoft/vscode/issues/96086
+      {
+        "label": "test-watch",
+        "icon": {
+          "color": "terminal.ansiCyan",
+          "id": "sync"
+        },
+        "type": "shell",
+        "options": {
+          "cwd": "${workspaceFolder:Client}"
+        },
+        "command": "npm run-script build-test-watch",
+        "group": "test",
+        "problemMatcher": "$tsc-watch",
+        "isBackground": true,
+        "dependsOn": "build-watch" // We need to also build main.js extension for testing or it leads to sourcemap errors
+      },
+      {
+        "label": "build-watch",
+        "icon": {
+          "color": "terminal.ansiCyan",
+          "id": "sync"
+        },
+        "type": "shell",
+        "options": {
+          "cwd": "${workspaceFolder:Client}"
+        },
+        "command": "npm run-script build-watch",
+        "group": "build",
+        "problemMatcher": "$esbuild-watch",
+        "isBackground": true,
+      },
     ],
     "inputs": [
       {
@@ -184,7 +228,52 @@
   },
   "launch": {
     "version": "0.2.0",
+    "compounds": [
+      {
+        "name": "Test Extension",
+        "configurations": [
+          "ExtensionTests",
+          "ExtensionTestRunner",
+        ],
+        "stopAll": true,
+        "presentation": {
+          "group": "test",
+          "order": 1
+        },
+        // This is here so instead of under TestRunner so that the attach doesn't start until the compile is complete
+        "preLaunchTask": "test-watch"
+      }
+    ],
     "configurations": [
+      {
+        "name": "Launch Extension",
+        "type": "extensionHost",
+        "request": "launch",
+        "runtimeExecutable": "${execPath}",
+        "args": [
+          "--extensionDevelopmentPath=${workspaceFolder:Client}"
+        ],
+        "env": {
+          "__TEST_WORKSPACE_PATH": "${workspaceFolder:Client}/examples",
+        },
+        "sourceMaps": true,
+        // This speeds up source map detection and makes smartStep work correctly
+        "outFiles": [
+          "${workspaceFolder:Client}/out/**/*.js",
+          "!**/node_modules/**",
+          "!**/.vscode-test/**"
+        ],
+        "skipFiles": [
+          "<node_internals>/**",
+          "**/node_modules/**",
+          "**/.vscode-test/**"
+        ],
+        "presentation": {
+          "hidden": false,
+          "group": "test",
+          "order": 2
+        }
+      },
       {
         // https://github.com/OmniSharp/omnisharp-vscode/blob/master/debugger-launchjson.md
         "name": "Attach to Editor Services",
@@ -197,42 +286,129 @@
           "searchPaths": [],
           "searchMicrosoftSymbolServer": true,
           "searchNuGetOrgSymbolServer": true
+        },
+        "presentation": {
+          "hidden": false,
+          "group": "test",
+          "order": 3
         }
       },
       {
-        "name": "Launch Extension",
+        // Runs the extension in an empty temp profile that is automatically cleaned up after use
+        // Undocumented: https://github.com/microsoft/vscode-docs/issues/6220
+        "name": "Launch Extension - Temp Profile",
         "type": "extensionHost",
         "request": "launch",
         "runtimeExecutable": "${execPath}",
         "args": [
-          "--disable-extensions",
-          "--extensionDevelopmentPath=${workspaceFolder:Client}"
+          "--profile-temp",
+          "--extensionDevelopmentPath=${workspaceFolder:Client}",
+          "${workspaceFolder:Client}/examples"
         ],
         "sourceMaps": true,
+        // This speeds up source map detection and makes smartStep work correctly
         "outFiles": [
-          "${workspaceFolder:Client}/out/main.js"
+          "${workspaceFolder:Client}/out/**/*.js",
+          "!**/node_modules/**",
+          "!**/.vscode-test/**"
+        ],
+        "skipFiles": [
+          "<node_internals>/**",
+          "**/node_modules/**",
+          "**/.vscode-test/**"
         ],
-        "preLaunchTask": "${defaultBuildTask}",
+        "presentation": {
+          "hidden": false,
+          "group": "test",
+          "order": 2
+        }
       },
       {
-        "name": "Launch Extension Tests",
+        // Runs the extension in an isolated but persistent profile separate from the user settings
+        // Undocumented: https://github.com/microsoft/vscode-docs/issues/6220
+        "name": "Launch Extension - Isolated Profile",
         "type": "extensionHost",
         "request": "launch",
         "runtimeExecutable": "${execPath}",
         "args": [
-          // The tests require Code be opened with a workspace, which exists in
-          // `test`, but this has to be passed as a CLI argument, not just `cwd`.
-          "${workspaceFolder:Client}/test",
-          "--disableExtensions",
+          "--profile=debug",
           "--extensionDevelopmentPath=${workspaceFolder:Client}",
-          "--extensionTestsPath=${workspaceFolder:Client}/out/test/index.js",
+          "${workspaceFolder:Client}/examples"
         ],
         "sourceMaps": true,
+        // This speeds up source map detection and makes smartStep work correctly
         "outFiles": [
-          "${workspaceFolder:Client}/out/test/**/*.js"
+          "${workspaceFolder:Client}/out/**/*.js",
+          "!**/node_modules/**",
+          "!**/.vscode-test/**"
+        ],
+        "skipFiles": [
+          "<node_internals>/**",
+          "**/node_modules/**",
+          "**/.vscode-test/**"
+        ],
+        "presentation": {
+          "hidden": false,
+          "group": "test",
+          "order": 2
+        }
+      },
+      {
+        "name": "ExtensionTestRunner",
+        "type": "node",
+        "request": "launch",
+        "program": "${workspaceFolder:Client}/out/test/runTests.js",
+        "cascadeTerminateToConfigurations": [
+          "ExtensionTests",
+        ],
+        // This speeds up source map detection and makes smartStep work correctly
+        "outFiles": [
+          "${workspaceFolder:Client}/out/**/*.js",
+          "!**/node_modules/**",
+          "!**/.vscode-test/**"
+        ],
+        "skipFiles": [
+          "<node_internals>/**",
+          "**/node_modules/**",
+          "**/.vscode-test/**"
+        ],
+        "args": [
+          "59229" // Wait on this port for the separate debugger task to attach
+        ],
+        "presentation": {
+          "hidden": true,
+        },
+        "internalConsoleOptions": "neverOpen",
+        "console": "integratedTerminal",
+        "autoAttachChildProcesses": false // Doesnt work with the extension host for whatever reason, hence the separate attach.
+      },
+      {
+        "name": "ExtensionTests",
+        "type": "node",
+        "request": "attach",
+        "port": 59229,
+        "autoAttachChildProcesses": true,
+        "outputCapture": "console",
+        "continueOnAttach": true,
+        // Sometimes we may need to install extensions or reload the window which requires reconnecting
+        "restart": {
+          "delay": 1000,
+          "maxAttempts": 3
+        },
+        "presentation": {
+          "hidden": true,
+        },
+        // This speeds up source map detection and makes smartStep work correctly
+        "outFiles": [
+          "${workspaceFolder:Client}/out/**/*.js",
+          "!**/node_modules/**",
+          "!**/.vscode-test/**"
+        ],
+        "skipFiles": [
+          "<node_internals>/**",
+          "**/node_modules/**",
+          "**/.vscode-test/**"
         ],
-        "preLaunchTask": "${defaultBuildTask}",
-        "internalConsoleOptions": "openOnSessionStart"
       }
     ]
   }

package.json

@@ -115,8 +115,11 @@
   "main": "./out/main.js",
   "scripts": {
     "lint": "eslint . --ext .ts",
-    "build": "tsc --project tsconfig.json && esbuild ./src/main.ts --outdir=out --bundle --external:vscode --platform=node",
-    "test": "node ./out/test/runTests.js",
+    "build": "esbuild ./src/main.ts --outdir=out --bundle --external:vscode --platform=node",
+    "build-watch": "npm run build -- --watch",
+    "build-test": "tsc --incremental",
+    "build-test-watch": "npm run build-test -- --watch",
+    "test": "npm run build-test && node ./out/test/runTests.js",
     "package": "vsce package --no-gitHubIssueLinking",
     "publish": "vsce publish"
   },

test/TestEnvironment.code-workspace

@@ -0,0 +1,13 @@
+{
+  // A simple test environment that suppresses some first start warnings we don't care about.
+  "folders": [
+    {
+      "path": "mocks"
+    }
+  ],
+  "settings": {
+    "git.openRepositoryInParentFolders": "never",
+    "csharp.suppressDotnetRestoreNotification": true,
+    "extensions.ignoreRecommendations": true
+  }
+}

test/core/settings.test.ts

@@ -3,34 +3,32 @@
 
 import * as assert from "assert";
 import * as vscode from "vscode";
-import * as settings from "../../src/settings";
+import { Settings, getSettings, getEffectiveConfigurationTarget, changeSetting, CommentType } from "../../src/settings";
 
-describe("Settings module", function () {
+describe("Settings E2E", function () {
+    this.slow(800);
     it("Loads without error", function () {
-        assert.doesNotThrow(settings.getSettings);
+        assert.doesNotThrow(getSettings);
     });
 
     it("Loads the correct defaults", function () {
-        const testSettings = new settings.Settings();
-        testSettings.enableProfileLoading = false;
-        testSettings.powerShellAdditionalExePaths = { "Some PowerShell": "somePath" };
-        const actualSettings = settings.getSettings();
+        const testSettings = new Settings();
+        const actualSettings = getSettings();
         assert.deepStrictEqual(actualSettings, testSettings);
     });
 
-
     it("Updates correctly", async function () {
-        await settings.changeSetting("helpCompletion", settings.CommentType.LineComment, false, undefined);
-        assert.strictEqual(settings.getSettings().helpCompletion, settings.CommentType.LineComment);
+        await changeSetting("helpCompletion", CommentType.LineComment, false, undefined);
+        assert.strictEqual(getSettings().helpCompletion, CommentType.LineComment);
     });
 
     it("Gets the effective configuration target", async function () {
-        await settings.changeSetting("helpCompletion", settings.CommentType.LineComment, false, undefined);
-        let target = settings.getEffectiveConfigurationTarget("helpCompletion");
+        await changeSetting("helpCompletion", CommentType.LineComment, false, undefined);
+        let target = getEffectiveConfigurationTarget("helpCompletion");
         assert.strictEqual(target, vscode.ConfigurationTarget.Workspace);
 
-        await settings.changeSetting("helpCompletion", undefined, false, undefined);
-        target = settings.getEffectiveConfigurationTarget("helpCompletion");
+        await changeSetting("helpCompletion", undefined, false, undefined);
+        target = getEffectiveConfigurationTarget("helpCompletion");
         assert.strictEqual(target, undefined);
     });
 });