Add esbuild to bundle and package the extension (#467)

* Add initial esbuild setup

tested the follow areas:
1) vsce package (installed and confirmed it can display coverage)
2) npm run test
3) npm run build

* Add lint step to test.yml

* Update tsconfig to exclude esbuild

* Use build again

* Test improvements

* revert package -> main change

* Fix more tests

* Add new test runner for ci / local

* Adjust CI workflow for ubuntu latest

* Run all workflows, even on sibling failure

* Adjust testing and ci actions

* Try headless for all

* Add back shell consideration

* More adjustments

* More adjustments v2

* Add more considerations v3

* Try an older test electron package

* Properly update lock file

Author: ryanluker

.github/workflows/test.yml

@@ -9,22 +9,20 @@ on:
 jobs:
   build:
     strategy:
+      fail-fast: false
       matrix:
-        include:
-          - os: macos-latest
-            test: test
-          - os: windows-latest
-            test: test
-          - os: ubuntu-latest
-            test: test-headless
+        os: [macos-latest, ubuntu-latest, windows-latest]
     runs-on: ${{ matrix.os }}
-    env:
-      CI: true
     steps:
-    - uses: actions/checkout@v1
-    - uses: actions/setup-node@v1
+    - name: Checkout
+      uses: actions/checkout@v4
+    - name: Install Node.js
+      uses: actions/setup-node@v4
       with:
-        node-version: 18
-    - run: npm ci
+        node-version: 22.x
+    - run: npm install
     - run: npm run build
-    - run: npm run ${{ matrix.test }}
+    - run: xvfb-run -a npm test
+      if: runner.os == 'Linux'
+    - run: npm test
+      if: runner.os != 'Linux'

.gitignore

@@ -1,3 +1,4 @@
+dist
 out
 node_modules
 .vscode-test

.vscode/launch.json

@@ -14,7 +14,7 @@
 				"${workspaceFolder}/example/example.code-workspace",
 				"--extensionDevelopmentPath=${workspaceFolder}"
 			],
-			"outFiles": ["${workspaceFolder}/out/**/*.js"],
+			"outFiles": ["${workspaceFolder}/dist/**/*.js"],
 			"preLaunchTask": "npm: watch"
 		},
 		{
@@ -28,7 +28,7 @@
 				"--extensionTestsPath=${workspaceFolder}/out/test/index"
 			],
 			"outFiles": ["${workspaceFolder}/out/test/**/*.js"],
-			"preLaunchTask": "npm: watch"
+			"preLaunchTask": "npm: compile-tests"
 		}
 	]
 }

.vscodeignore

@@ -1,6 +1,6 @@
-# Remove some folders from the output
-out/test/**
-out/example/**
+# Remove some folders from the build output
+out/**
+node_modules/**
 
 # Codebase files
 src/**
@@ -20,6 +20,7 @@ promo_images/**
 .gitignore
 .vscode/**
 .vscode-test/**
+esbuild.js
 
 # Typescript files
 @types

esbuild.js

@@ -0,0 +1,54 @@
+const esbuild = require('esbuild');
+
+const production = process.argv.includes('--production');
+const watch = process.argv.includes('--watch');
+
+async function main() {
+  const ctx = await esbuild.context({
+    entryPoints: ['src/extension.ts'],
+    bundle: true,
+    format: 'cjs',
+    minify: production,
+    sourcemap: !production,
+    sourcesContent: false,
+    platform: 'node',
+    outfile: 'dist/extension.js',
+    external: ['vscode'],
+    logLevel: 'silent',
+    plugins: [
+      /* add to the end of plugins array */
+      esbuildProblemMatcherPlugin
+    ]
+  });
+  if (watch) {
+    await ctx.watch();
+  } else {
+    await ctx.rebuild();
+    await ctx.dispose();
+  }
+}
+
+/**
+ * @type {import('esbuild').Plugin}
+ */
+const esbuildProblemMatcherPlugin = {
+  name: 'esbuild-problem-matcher',
+
+  setup(build) {
+    build.onStart(() => {
+      console.log('[watch] build started');
+    });
+    build.onEnd(result => {
+      result.errors.forEach(({ text, location }) => {
+        console.error(`✘ [ERROR] ${text}`);
+        console.error(`    ${location.file}:${location.line}:${location.column}:`);
+      });
+      console.log('[watch] build finished');
+    });
+  }
+};
+
+main().catch(e => {
+  console.error(e);
+  process.exit(1);
+});