Merge pull request #3555 from PowerShell/andschwa/bundle

Bundle the extension

Author: andyleejordan

.vscode/launch.json

@@ -7,13 +7,11 @@
       "request": "launch",
       "runtimeExecutable": "${execPath}",
       "args": [
-        "--extensionDevelopmentPath=${workspaceRoot}"
+        "--disable-extensions",
+        "--extensionDevelopmentPath=${workspaceFolder}"
       ],
-      "stopOnEntry": false,
       "sourceMaps": true,
-      "outFiles": [
-        "${workspaceFolder}/out/src/**/*.js"
-      ],
+      "outFiles": [ "${workspaceFolder}/out/main.js" ],
       "preLaunchTask": "Build"
     },
     {
@@ -22,15 +20,15 @@
       "request": "launch",
       "runtimeExecutable": "${execPath}",
       "args": [
-        "--disable-extensions",
-        "ms-vscode.powershell-preview",
+        // 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}/test",
+        "--disableExtensions",
         "--extensionDevelopmentPath=${workspaceFolder}",
-        "--extensionTestsPath=${workspaceFolder}/out/test/testRunner.js",
-        "${workspaceFolder}/test"
-      ],
-      "outFiles": [
-        "${workspaceFolder}/out/**/*.js"
+        "--extensionTestsPath=${workspaceFolder}/out/test/index.js",
       ],
+      "sourceMaps": true,
+      "outFiles": [ "${workspaceFolder}/out/test/**/*.js" ],
       "preLaunchTask": "Build"
     },
     {

.vscodeignore

@@ -1,24 +1,27 @@
-.vscode/**
-.vscode-test/**
-vscode-powershell.build.ps1
-typings/**
-**/*.ts
+.github/
+.poshchan/
+.vscode/
+.vscode-test/
+.vsts-ci/
+logs/
+node_modules/
+out/
+scripts/
+sessions/
+src/
+test/
+tools/
+
+!out/main.js
+
+.editorconfig
+.gitattributes
 .gitignore
-tsconfig.json
-build/**
-bin/EditorServices.log
-bin/DebugAdapter.log
-bin/*.vshost.*
-bin/PowerShell/**
-logs/**
-out/test/**
-test/**
-sessions/**
-scripts/Install-VSCode.ps1
-tools/**
-.poshchan/**
-.github/**
-.vsts-ci/**
+.markdownlint.json
+.vscodeignore
 build.ps1
+extension-dev.code-workspace
+*.vsix
 tsconfig.json
 tslint.json
+vscode-powershell.build.ps1

extension-dev.code-workspace

@@ -7,18 +7,18 @@
             "path": "../PowerShellEditorServices"
         }
     ],
-  "settings": {
-    "files.associations": {
-      "**/snippets/*.json": "jsonc",
-      "**/.vsts-ci/**/*.yml": "azure-pipelines",
-    },
-    "typescript.tsdk": "./node_modules/typescript/lib",
-    "powershell.codeFormatting.autoCorrectAliases": true,
-    "powershell.codeFormatting.newLineAfterCloseBrace": false,
-    "powershell.codeFormatting.trimWhitespaceAroundPipe": true,
-    "powershell.codeFormatting.useCorrectCasing": true,
-    "powershell.codeFormatting.whitespaceBeforeOpenBrace": false,
-    "powershell.codeFormatting.whitespaceBetweenParameters": true,
-    "powershell.codeFormatting.pipelineIndentationStyle": "IncreaseIndentationForFirstPipeline"
-  }
+    "settings": {
+        "files.associations": {
+            "**/snippets/*.json": "jsonc",
+            "**/.vsts-ci/**/*.yml": "azure-pipelines",
+        },
+        "typescript.tsdk": "./node_modules/typescript/lib",
+        "powershell.codeFormatting.autoCorrectAliases": true,
+        "powershell.codeFormatting.newLineAfterCloseBrace": false,
+        "powershell.codeFormatting.trimWhitespaceAroundPipe": true,
+        "powershell.codeFormatting.useCorrectCasing": true,
+        "powershell.codeFormatting.whitespaceBeforeOpenBrace": false,
+        "powershell.codeFormatting.whitespaceBetweenParameters": true,
+        "powershell.codeFormatting.pipelineIndentationStyle": "IncreaseIndentationForFirstPipeline"
+    }
 }

package-lock.json

@@ -25,7 +25,6 @@
     "type": "git",
     "url": "https://github.com/PowerShell/vscode-powershell.git"
   },
-  "main": "./out/src/main",
   "activationEvents": [
     "onDebugInitialConfigurations",
     "onDebugResolve:PowerShell",
@@ -65,6 +64,7 @@
     "@types/uuid": "~8.3.1",
     "@types/vscode": "~1.56.0",
     "@vscode/test-electron": "~1.6.2",
+    "esbuild": "^0.12.25",
     "mocha": "~9.1.1",
     "mocha-junit-reporter": "~2.0.0",
     "mocha-multi-reporters": "~1.5.1",
@@ -78,9 +78,10 @@
   "extensionDependencies": [
     "vscode.powershell"
   ],
+  "main": "./out/main.js",
   "scripts": {
-    "compile": "tsc -v && tsc -p ./ && tslint -p ./",
-    "compile-watch": "tsc -watch -p ./",
+    "lint": "tslint --project tsconfig.json",
+    "build": "tsc --project tsconfig.json && esbuild ./src/main.ts --outdir=out --sourcemap --bundle --minify --external:vscode --platform=node",
     "test": "node ./out/test/runTests.js",
     "package": "vsce package --no-gitHubIssueLinking",
     "publish": "vsce publish"

package.json

@@ -9,7 +9,7 @@ export class ExamplesFeature implements vscode.Disposable {
     private examplesPath: string;
 
     constructor() {
-        this.examplesPath = path.resolve(__dirname, "../../../examples");
+        this.examplesPath = path.resolve(__dirname, "../../examples");
         this.command = vscode.commands.registerCommand("PowerShell.OpenExamplesFolder", () => {
             vscode.commands.executeCommand(
                 "vscode.openFolder",

src/features/Examples.ts

@@ -18,7 +18,7 @@ export class PesterTestsFeature implements vscode.Disposable {
     private invokePesterStubScriptPath: string;
 
     constructor(private sessionManager: SessionManager) {
-        this.invokePesterStubScriptPath = path.resolve(__dirname, "../../../modules/PowerShellEditorServices/InvokePesterStub.ps1");
+        this.invokePesterStubScriptPath = path.resolve(__dirname, "../../modules/PowerShellEditorServices/InvokePesterStub.ps1");
 
         // File context-menu command - Run Pester Tests
         this.command = vscode.commands.registerCommand(

src/features/PesterTests.ts

@@ -40,7 +40,7 @@ export class Logger implements ILogger {
     constructor() {
         this.logChannel = vscode.window.createOutputChannel("PowerShell Extension Logs");
 
-        this.logBasePath = path.resolve(__dirname, "../../logs");
+        this.logBasePath = path.resolve(__dirname, "../logs");
         utils.ensurePathExists(this.logBasePath);
 
         this.commands = [

src/logging.ts

@@ -36,7 +36,7 @@ import { LanguageClientConsumer } from "./languageClientConsumer";
 
 // The most reliable way to get the name and version of the current extension.
 // tslint:disable-next-line: no-var-requires
-const PackageJSON: any = require("../../package.json");
+const PackageJSON: any = require("../package.json");
 
 // the application insights key (also known as instrumentation key) used for telemetry.
 const AI_KEY: string = "AIF-d9b70cd4-b9f9-4d70-929b-a071c400b217";
@@ -197,7 +197,7 @@ function checkForUpdatedVersion(context: vscode.ExtensionContext, version: strin
                 if (choice === showReleaseNotes) {
                     vscode.commands.executeCommand(
                         "markdown.showPreview",
-                        vscode.Uri.file(path.resolve(__dirname, "../../CHANGELOG.md")));
+                        vscode.Uri.file(path.resolve(__dirname, "../CHANGELOG.md")));
                 }
             });
     }

src/main.ts

@@ -49,7 +49,7 @@ export function getPlatformDetails(): IPlatformDetails {
         operatingSystem = OperatingSystem.Linux;
     }
 
-    const isProcess64Bit = process.arch === "x64";
+    const isProcess64Bit = (process.arch === "x64" || process.arch === "arm64");
 
     return {
         operatingSystem,

src/platform.ts

@@ -157,7 +157,7 @@ export function load(): ISettings {
 
     const defaultDeveloperSettings: IDeveloperSettings = {
         featureFlags: [],
-        bundledModulesPath: "../../../PowerShellEditorServices/module",
+        bundledModulesPath: "../../PowerShellEditorServices/module",
         editorServicesLogLevel: "Normal",
         editorServicesWaitForDebugger: false,
         waitForSessionFileTimeoutSeconds: 240,
@@ -234,7 +234,7 @@ export function load(): ISettings {
         promptToUpdatePackageManagement:
             configuration.get<boolean>("promptToUpdatePackageManagement", true),
         bundledModulesPath:
-            "../../modules",
+            "../modules",
         useX86Host:
             configuration.get<boolean>("useX86Host", false),
         enableProfileLoading:

src/settings.ts

@@ -70,15 +70,15 @@ hello
                     content: "console.log('asdf');",
                 },
                 {
-                    fileName: "../testCustomViews.js",
+                    fileName: "../../testCustomViews.js",
                     content: "console.log('asdf');",
                 },
             ],
             cssFiles: [],
             expectedHtmlString: `<html><head></head><body>
 hello
 <script src="${convertToVSCodeResourceScheme(path.join(__dirname, "testCustomViews.js"))}"></script>
-<script src="${convertToVSCodeResourceScheme(path.join(__dirname, "../testCustomViews.js"))}"></script>
+<script src="${convertToVSCodeResourceScheme(path.join(__dirname, "../../testCustomViews.js"))}"></script>
 </body></html>`,
         },
 

test/features/CustomViews.test.ts

@@ -1,16 +1,18 @@
 {
-    "compilerOptions": {
-        "rootDir": ".",
-        "module": "commonjs",
-        "target": "es6",
-        "outDir": "out",
-        "lib": [
-            "es2017",
-            "DOM"
-        ],
-        "sourceMap": true
-    },
-    "exclude": [
-        "node_modules"
-    ]
+  "compilerOptions": {
+    // NOTE: The TypeScript compiler is only used for building the tests (and
+    // the sources which the tests need). The extension is built with `esbuild`.
+    "module": "commonjs",
+    "outDir": "out",
+    "target": "ES6",
+    "lib": [ "ES6", "DOM" ],
+    "sourceMap": true,
+    "rootDir": ".",
+    // TODO: We need to enable stricter checking...
+    // "strict": true,
+    // "noImplicitReturns": true,
+    // "noFallthroughCasesInSwitch": true,
+    // "noUnusedParameters": true
+  },
+  "include": [ "src", "test" ],
 }

tsconfig.json

@@ -64,7 +64,17 @@ task CopyEditorServices -If { !(Test-Path ./modules/PowerShellEditorServices) -a
 
 task Build CopyEditorServices, Restore, {
     Write-Host "`n### Building vscode-powershell" -ForegroundColor Green
-    exec { & npm run compile }
+    # TODO: TSLint is deprecated and we need to switch to ESLint.
+    # https://github.com/PowerShell/vscode-powershell/pull/3331
+    exec { & npm run lint }
+
+    # TODO: When supported we should use `esbuild` for the tests too. Although
+    # we now use `esbuild` to transpile, bundle, and minify the extension, we
+    # still use `tsc` to transpile everything in `src` and `test` because the VS
+    # Code test runner expects individual files (and globs them at runtime).
+    # Unfortunately `esbuild` doesn't support emitting 1:1 files (yet).
+    # https://github.com/evanw/esbuild/issues/944
+    exec { & npm run build }
 }
 
 #endregion