Bundle extension & add publish workflow (#124)

* Setup esbuild

* Add more files to .vscodeignore

* Set up esbuild & running built extension

* Find more occurrences in logger method matching

* Always ship sourcemaps to get readable logs from users

* Use extension.js instead of extension

* Improve run config & change entrypoint during `npm test`

* Add way to package vsce

* Init GitHub publish workflow

* Update one npm package

Author: Splines

.config/tsconfig.json

@@ -9,5 +9,10 @@
     "strict": true,
     "noFallthroughCasesInSwitch": true,
     "removeComments": true,
+    "outDir": "../out/",
+    "rootDir": "../"
   },
+  "include": [
+    "../src/**/*.ts",
+  ],
 }

.config/tsconfig.paths.json

@@ -0,0 +1,6 @@
+{
+  "extends": "./tsconfig.json",
+  "include": [
+    "../tests/**/*.ts",
+  ],
+}

.config/tsconfig.tests.json

@@ -0,0 +1,36 @@
+on:
+  release:
+    types:
+      - created
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+
+    - name: Install Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: 22
+
+    - name: Install dependencies
+      run: npm install
+
+    - name: Package extension
+      run: npm run package-vsce
+
+    - name: Upload VSIX artifact to 
+      if: startsWith(github.ref, 'refs/tags/')
+      uses: actions/upload-artifact@v4
+      with:
+        name: manim-notebook.vsix
+        path: manim-notebook-*.vsix
+        if-no-files-found: error
+
+    - name: Publish
+      if: startsWith(github.ref, 'refs/tags/')
+      run: npm run deploy
+      env:
+        VSCE_PAT: ${{ secrets.VSCE_PAT }}

.github/workflows/publish.yml

@@ -102,8 +102,11 @@ jobs:
           if [ "$RUNNER_OS" == "Linux" ]; then
             # Start an X virtual framebuffer (Xvfb) server, which emulates a
             # display server without requiring a physical display.
-            xvfb-run -a npm run testInGithubActions
+            xvfb-run -a npm run test-without-pre-or-posttest
           else
-            npm run testInGithubActions
+            npm run test-without-pre-or-posttest
           fi
         shell: bash
+
+      - name: Run posttest
+        run: npm run posttest

.github/workflows/tests.yml

@@ -3,6 +3,7 @@ tmp/
 *.mp4
 .DS_Store
 out
+out-test
 dist
 node_modules
 _debug_scenes/

.gitignore

@@ -3,6 +3,7 @@
 	// for the documentation about the extensions.json format
 	"recommendations": [
 		"dbaeumer.vscode-eslint",
-    "streetsidesoftware.code-spell-checker"
+    "streetsidesoftware.code-spell-checker",
+    "connor4312.esbuild-problem-matchers"
 	]
 }

.vscode/extensions.json

@@ -13,9 +13,9 @@
         "--extensionDevelopmentPath=${workspaceFolder}"
       ],
       "outFiles": [
-        "${workspaceFolder}/out/src/**/*.js"
+        "${workspaceFolder}/dist/**/*.js"
       ],
-      "preLaunchTask": "Watch Files",
+      "preLaunchTask": "Watch (Default)",
       "sourceMaps": true
     },
     {
@@ -27,10 +27,10 @@
         "${workspaceFolder}/tests/fixtures",
         "--disable-extensions",
         "--extensionDevelopmentPath=${workspaceFolder}",
-        "--extensionTestsPath=${workspaceFolder}/out/tests/utils/testRunner.js"
+        "--extensionTestsPath=${workspaceFolder}/out-test/tests/utils/testRunner.js"
       ],
       "outFiles": [
-        "${workspaceFolder}/out/test/**/*.js"
+        "${workspaceFolder}/out-test/tests/**/*.js"
       ],
       "preLaunchTask": "Prepare For Tests",
       "sourceMaps": true,

.vscode/launch.json

@@ -108,6 +108,7 @@
     "nodenext",
     "opengl",
     "Pango",
+    "posttest",
     "prerun",
     "pycache",
     "Pyglet",

.vscode/settings.json

@@ -4,11 +4,11 @@
   "version": "2.0.0",
   "tasks": [
     {
-      "label": "Watch Files",
-      "type": "npm",
-      "script": "watch",
-      "problemMatcher": "$tsc-watch",
-      "isBackground": true,
+      "label": "Watch (Default)",
+      "dependsOn": [
+        "npm: watch:tsc",
+        "npm: watch:esbuild"
+      ],
       "presentation": {
         "reveal": "never"
       },
@@ -17,11 +17,46 @@
         "isDefault": true
       }
     },
+    {
+      "type": "npm",
+      "script": "watch:tsc",
+      "group": "build",
+      "problemMatcher": "$tsc-watch",
+      "isBackground": true,
+      "label": "npm: watch:tsc",
+      "presentation": {
+        "group": "watch",
+        "reveal": "never"
+      }
+    },
+    {
+      "type": "npm",
+      "script": "watch:esbuild",
+      "group": "build",
+      "problemMatcher": "$esbuild-watch",
+      "isBackground": true,
+      "label": "npm: watch:esbuild",
+      "presentation": {
+        "group": "watch",
+        "reveal": "never"
+      }
+    },
+    {
+      "type": "npm",
+      "script": "watch:tests",
+      "group": "build",
+      "problemMatcher": "$tsc-watch",
+      "isBackground": true,
+      "label": "npm: watch:tests",
+      "presentation": {
+        "group": "watch",
+        "reveal": "never"
+      }
+    },
     {
       "label": "Install Manim",
       "type": "npm",
       "script": "install-manim",
-      "cwd": "${workspaceFolder}",
       "presentation": {
         "reveal": "always"
       },
@@ -33,9 +68,18 @@
       "label": "Prepare For Tests",
       "dependsOrder": "sequence",
       "dependsOn": [
-        "Watch Files",
+        "npm: watch:tsc",
+        "npm: watch:esbuild",
+        "npm: watch:tests",
         "Install Manim"
-      ]
-    }
+      ],
+      "presentation": {
+        "reveal": "never"
+      },
+      "group": {
+        "kind": "build",
+        "isDefault": true
+      }
+    },
   ]
 }