Update extension to build to dist/extension.js

andyleejordan · andyleejordan · commit 8bd6e77e570c · 2024-04-02T18:14:56.000Z
This updates all the NPM tasks to be consistent with what a new-from-template
extension uses, and uses an allow-list for the published VSIX.
diff --git a/.gitignore b/.gitignore
@@ -1,12 +1,13 @@
+**.js
+**.js.map
 .vscode-test/
-logs/
+*.vsix
+dist/
 modules
 modules/
 node_modules/
-obj/
-bin/
 out/
-sessions/
+test/mocks/BinaryModule/bin/
+test/mocks/BinaryModule/obj/
 test-results.xml
-*.vsix
-*.DS_Store
+tsconfig.tsbuildinfo
diff --git a/.mocharc.json b/.mocharc.json
@@ -8,5 +8,5 @@
   "require": "source-map-support/register",
   "timeout": 600000,
   "slow": 2000,
-  "spec": "out/test/**/*.test.js"
+  "spec": "test/**/*.test.js"
 }
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -17,7 +17,7 @@
       "sourceMaps": true,
       // This speeds up source map detection and makes smartStep work correctly
       "outFiles": [
-        "${workspaceFolder}/out/**/*.js",
+        "${workspaceFolder}/**/*.js",
         "!**/node_modules/**",
         "!**/.vscode-test/**"
       ],
@@ -47,7 +47,7 @@
       "sourceMaps": true,
       // This speeds up source map detection and makes smartStep work correctly
       "outFiles": [
-        "${workspaceFolder}/out/**/*.js",
+        "${workspaceFolder}/**/*.js",
         "!**/node_modules/**",
         "!**/.vscode-test/**"
       ],
@@ -77,7 +77,7 @@
       "sourceMaps": true,
       // This speeds up source map detection and makes smartStep work correctly
       "outFiles": [
-        "${workspaceFolder}/out/**/*.js",
+        "${workspaceFolder}/**/*.js",
         "!**/node_modules/**",
         "!**/.vscode-test/**"
       ],
@@ -96,13 +96,13 @@
       "name": "Test Extension",
       "type": "node",
       "request": "launch",
-      "program": "${workspaceFolder}/out/test/runTests.js",
+      "program": "${workspaceFolder}/test/runTests.js",
       "cascadeTerminateToConfigurations": [
         "ExtensionTests",
       ],
       // This speeds up source map detection and makes smartStep work correctly
       "outFiles": [
-        "${workspaceFolder}/out/**/*.js",
+        "${workspaceFolder}/**/*.js",
         "!**/node_modules/**",
         "!**/.vscode-test/**"
       ],
@@ -111,7 +111,7 @@
         "**/node_modules/**",
         "**/.vscode-test/**"
       ],
-      "attachSimplePort": 59229, // THe default is 9229 but we want to avoid conflicts because we will have two vscode instances running.
+      "attachSimplePort": 59229, // The default is 9229 but we want to avoid conflicts because we will have two Code instances running.
       "env": {
         "__TEST_DEBUG_INSPECT_PORT": "59229" // Needs to match attachSimplePort
       },
@@ -121,7 +121,7 @@
       "internalConsoleOptions": "neverOpen",
       "console": "integratedTerminal",
       "autoAttachChildProcesses": false,
-      "preLaunchTask": "test-watch"
+      "preLaunchTask": "watch-tests"
     }
   ]
 }
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -2,29 +2,29 @@
   "version": "2.0.0",
   "tasks": [
     {
-      "label": "test-watch",
+      "label": "watch-tests",
       "icon": {
         "color": "terminal.ansiCyan",
         "id": "sync"
       },
       "type": "npm",
-      "script": "build-test-watch",
+      "script": "watch-tests",
       "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
+      "dependsOn": "watch"
     },
     {
-      "label": "build-watch",
+      "label": "watch",
       "icon": {
         "color": "terminal.ansiCyan",
         "id": "sync"
       },
       "type": "npm",
-      "script": "build-watch",
+      "script": "watch",
       "group": "build",
       "problemMatcher": "$esbuild-watch",
-      "isBackground": true,
+      "isBackground": true
     }
   ]
 }
diff --git a/.vscodeignore b/.vscodeignore
@@ -1,28 +1,10 @@
-.github/
-.poshchan/
-.vscode/
-.vscode-test/
-.vsts-ci/
-logs/
-node_modules/
-out/
-scripts/
-sessions/
-src/
-test/
-tools/
-
-!out/main.js
-
-.editorconfig
-.eslintrc.json
-.gitattributes
-.gitignore
-.markdownlint.json
-.vscodeignore
-build.ps1
-extension-dev.code-workspace
-*.vsix
-test-results.xml
-tsconfig.json
-vscode-powershell.build.ps1
+**
+!*.md
+!dist/extension.js
+!docs/
+!examples/
+!media/
+!modules/
+!snippets/
+!themes/
+!LICENSE.txt
diff --git a/Third Party Notices.txt b/Third Party Notices.txt
diff --git a/extension-dev.code-workspace b/extension-dev.code-workspace
@@ -37,6 +37,7 @@
     "markdownlint.config": {
       "MD024": false // no-duplicate-header
     },
+    "powershell.cwd": "Client",
     "powershell.codeFormatting.autoCorrectAliases": true,
     "powershell.codeFormatting.avoidSemicolonsAsLineTerminators": true,
     "powershell.codeFormatting.newLineAfterCloseBrace": false,
@@ -55,7 +56,7 @@
       "editor.formatOnSaveMode": "modificationsIfAvailable"
     },
     "mochaExplorer.configFile": ".mocharc.json",
-    "mochaExplorer.launcherScript": "out/test/runTests",
+    "mochaExplorer.launcherScript": "test/runTests",
     "mochaExplorer.autoload": false, // The test instance pops up every time discovery or run is done, this could be annoying on startup.
     "mochaExplorer.debuggerPort": 59229, // Matches the launch config, we dont want to use the default port as we are launching a duplicate instance of vscode and it might conflict.
     "mochaExplorer.ipcRole": "server",
@@ -64,8 +65,7 @@
     "mochaExplorer.env": {
       "VSCODE_VERSION": "insiders",
       "ELECTRON_RUN_AS_NODE": null
-    },
-    "powershell.cwd": "Client",
+    }
   },
   "tasks": {
     "version": "2.0.0",
diff --git a/package.json b/package.json
@@ -115,16 +115,16 @@
   "extensionDependencies": [
     "vscode.powershell"
   ],
-  "main": "./out/main.js",
+  "main": "./dist/extension.js",
   "scripts": {
-    "lint": "eslint . --ext .ts",
-    "build": "esbuild ./src/main.ts --outdir=out --sourcemap --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",
+    "compile": "esbuild ./src/extension.ts --outdir=dist --sourcemap --bundle --external:vscode --platform=node",
+    "watch": "npm run compile -- --watch",
+    "lint": "eslint src test --ext .ts",
     "package": "vsce package --no-gitHubIssueLinking",
-    "publish": "vsce publish"
+    "publish": "vsce publish",
+    "compile-test": "npm run compile && tsc --incremental",
+    "watch-tests": "npm run compile-test -- --watch",
+    "test": "npm run compile-test && node ./test/runTests.js"
   },
   "contributes": {
     "breakpoints": [
diff --git a/src/extension.ts b/src/extension.ts
diff --git a/test/features/DebugSession.test.ts b/test/features/DebugSession.test.ts
@@ -480,7 +480,7 @@ describe("DebugSessionFeature E2E", function() {
         let binaryModulePath: Uri;
 
         before(async function binarySetup() {
-            if (process.env.BUILD_SOURCEBRANCHNAME === "release") {
+            if (process.env.TF_BUILD) {
                 // The binary modules tests won't work in the release pipeline
                 // due to dependency requirements.
                 this.skip();
diff --git a/test/runTests.ts b/test/runTests.ts
@@ -17,15 +17,15 @@ import { spawnSync } from "child_process";
  * */
 async function main(): Promise<void> {
     // Verify that the extension is built
-    const compiledExtensionPath = path.resolve(__dirname, "../main.js");
+    const compiledExtensionPath = path.resolve(__dirname, "../src/extension.js");
     if (!existsSync(compiledExtensionPath)) {
         console.error("ERROR: The extension is not built yet. Please run a build first, using either the 'Run Build Task' in VSCode or ./build.ps1 in PowerShell.");
         process.exit(1);
     }
 
     try {
         /** The folder containing the Extension Manifest package.json. Passed to `--extensionDevelopmentPath */
-        const extensionDevelopmentPath = path.resolve(__dirname, "../../");
+        const extensionDevelopmentPath = path.resolve(__dirname, "../");
 
         /** The path to the test script that will run inside the vscode instance. Passed to --extensionTestsPath */
         const extensionTestsPath = path.resolve(__dirname, "./runTestsInner");
diff --git a/test/utils.ts b/test/utils.ts
@@ -8,8 +8,8 @@ import { IPowerShellExtensionClient } from "../src/features/ExternalApi";
 import { execSync } from "child_process";
 
 // This lets us test the rest of our path assumptions against the baseline of
-// this test file existing at `<root>/out/test/utils.js`.
-export const rootPath = path.resolve(__dirname, "../../");
+// this test file existing at `<root>/test/utils.js`.
+export const rootPath = path.resolve(__dirname, "../");
 // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-var-requires
 const packageJSON: any = require(path.resolve(rootPath, "package.json"));
 export const extensionId = `${packageJSON.publisher}.${packageJSON.name}`;
@@ -75,7 +75,7 @@ export function stubInterface<T>(object?: Partial<T>): T {
 
 /** Builds the sample binary module code. We need to do this because the source maps have absolute paths so they are not portable between machines, and while we could do deterministic with source maps, that's way more complicated and everywhere we build has dotnet already anyways */
 export function BuildBinaryModuleMock(): void {
-    const projectPath = path.resolve(`${__dirname}/../../test/mocks/BinaryModule/BinaryModule.csproj`); //Relative to "out/test" when testing.
+    const projectPath = path.resolve(`${__dirname}/../test/mocks/BinaryModule/BinaryModule.csproj`);
     try {
         execSync(`dotnet publish ${projectPath}`, {
             encoding: "utf8"
diff --git a/tsconfig.json b/tsconfig.json
@@ -3,7 +3,6 @@
     // 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": "ES2022",
     "lib": [
       "ES2022",
diff --git a/vscode-powershell.build.ps1 b/vscode-powershell.build.ps1
@@ -76,7 +76,7 @@ task Restore RestoreEditorServices, RestoreNodeModules
 
 task Clean {
     Write-Host "`n### Cleaning vscode-powershell`n" -ForegroundColor Green
-    Remove-BuildItem ./modules, ./out, ./node_modules, *.vsix
+    Remove-BuildItem *.js, *.js.map, *.vsix, ./dist, ./modules, ./node_modules
 }
 
 task CleanEditorServices -If (Get-EditorServicesPath) {
@@ -101,8 +101,8 @@ task Build Restore, {
     # Unfortunately `esbuild` doesn't support emitting 1:1 files (yet).
     # https://github.com/evanw/esbuild/issues/944
     switch ($Configuration) {
-        "Debug" { Invoke-BuildExec { & npm run build } }
-        "Release" { Invoke-BuildExec { & npm run build -- --minify } }
+        "Debug" { Invoke-BuildExec { & npm run compile } }
+        "Release" { Invoke-BuildExec { & npm run compile -- --minify } }
     }
 }
 
@@ -133,6 +133,7 @@ task Package Build, {
     Assert-Build ($packageJson.version -eq $packageVersion)
 
     Write-Host "`n### Packaging powershell-$packageVersion.vsix`n" -ForegroundColor Green
+    Remove-BuildItem ./*.vsix
 
     # Packaging requires a copy of the modules folder, not a symbolic link. But
     # we might have built in Debug configuration, not Release, and still want to

Original file line number	Diff line number	Diff line change
`@@ -8,5 +8,5 @@`
`8`	`8`	`"require": "source-map-support/register",`
`9`	`9`	`"timeout": 600000,`
`10`	`10`	`"slow": 2000,`
`11`		`- "spec": "out/test/*/.test.js"`
	`11`	`+ "spec": "test/*/.test.js"`
`12`	`12`	`}`