refactor: use unplugin-raw instead of string template to generate test plugin

Author: northword

package.json

@@ -102,6 +102,7 @@
     "tsx": "^4.21.0",
     "typescript": "^5.9.3",
     "unbuild": "^3.6.1",
+    "unplugin-raw": "^0.6.4",
     "vitest": "^4.0.18"
   },
   "workspaces": [

pnpm-lock.yaml

@@ -1,4 +1,46 @@
-export * from "./bootsrtap.js";
-export * from "./html.js";
-export * from "./manifest.js";
-export * from "./mocha-setup.js";
+import { TESTER_PLUGIN_ID, TESTER_PLUGIN_REF } from "../../../constant.js";
+import bootstrapRaw from "./raw/bootstrap.js?raw";
+import htmlRaw from "./raw/index.html?raw";
+import manifestRaw from "./raw/manifest.json?raw";
+import mochaSetupRaw from "./raw/mocha-setup.js?raw";
+
+export function generateManifest(): Record<string, unknown> {
+  const manifestStr = manifestRaw
+    .replace("__TESTER_PLUGIN_ID__", TESTER_PLUGIN_ID);
+
+  return JSON.parse(manifestStr);
+}
+
+export function generateBootstrap(options: {
+  port: number;
+  startupDelay: number;
+  waitForPlugin: string;
+}): string {
+  return bootstrapRaw
+    .replace("__PORT__", String(options.port))
+    .replace("__STARTUP_DELAY__", String(options.startupDelay || 1000))
+    .replace("__WAIT_FOR_PLUGIN__", options.waitForPlugin)
+    .replace("__TESTER_PLUGIN_REF__", TESTER_PLUGIN_REF);
+}
+
+export function generateHtml(
+  setupCode: string,
+  testFiles: string[],
+): string {
+  const tests = testFiles.map(f => `<script src="${f}"></script>`).join("\n    ");
+
+  return htmlRaw.replace("__TEST_FILES__", tests).replace("___SETUP_CODE___", setupCode);
+}
+
+export function generateMochaSetup(options: {
+  port: number;
+  timeout: number;
+  abortOnFail: boolean;
+  exitOnFinish: boolean;
+}): string {
+  return mochaSetupRaw
+    .replace("__TIMEOUT__", String(options.timeout || 10000))
+    .replace("__PORT__", String(options.port))
+    .replace("__ABORT_ON_FAIL__", String(options.abortOnFail))
+    .replace("__EXIT_ON_FINISH__", String(options.exitOnFinish ? "true" : "false"));
+}

src/core/tester/test-bundler-template/index.ts

@@ -1,11 +1,6 @@
-import { TESTER_PLUGIN_REF } from "../../../constant.js";
-
-export function generateBootstrap(options: {
-  port: number;
-  startupDelay: number;
-  waitForPlugin: string;
-}) {
-  return `//Code generated by the zotero-plugin-scaffold tester
+/* eslint-disable eslint-comments/no-unlimited-disable */
+/* eslint-disable */
+// Code generated by the zotero-plugin-scaffold tester
 var chromeHandle;
 
 function install(data, reason) {}
@@ -17,14 +12,14 @@ async function startup({ id, version, resourceURI, rootURI }, reason) {
   ].getService(Components.interfaces.amIAddonManagerStartup);
   const manifestURI = Services.io.newURI(rootURI + "manifest.json");
   chromeHandle = aomStartup.registerChrome(manifestURI, [
-    ["content", "${TESTER_PLUGIN_REF}", rootURI + "content/"],
+    ["content", "__TESTER_PLUGIN_REF__", rootURI + "content/"],
   ]);
 
   launchTests().catch((error) => {
     Zotero.debug(error);
     Zotero.HTTP.request(
       "POST",
-      "http://localhost:${options.port}/update",
+      "http://localhost:__PORT__/update",
       {
         body: JSON.stringify({
           type: "fail",
@@ -58,9 +53,9 @@ function uninstall(data, reason) {}
 
 async function launchTests() {
   // Delay to allow plugin to fully load before opening the test page
-  await Zotero.Promise.delay(${options.startupDelay || 1000});
+  await Zotero.Promise.delay(__STARTUP_DELAY__);
 
-  const waitForPlugin = "${options.waitForPlugin}";
+  const waitForPlugin = "${WAIT_FOR_PLUGIN}";
 
   if (waitForPlugin) {
     // Wait for a plugin to be installed
@@ -98,5 +93,3 @@ function waitUtilAsync(condition, interval = 100, timeout = 1e4) {
     }, interval);
   });
 }
-`;
-}

src/core/tester/test-bundler-template/manifest.ts

@@ -1,27 +1,21 @@
-export function generateHtml(
-  setupCode: string,
-  testFiles: string[],
-) {
-  const tests = testFiles.map(f => `<script src="${f}"></script>`).join("\n    ");
-
-  return `<!-- Generated by zotero-plugin-scaffold -->
-<!DOCTYPE html>
+<!-- Generated by zotero-plugin-scaffold -->
+<!doctype html>
 <html lang="en" xmlns="http://www.w3.org/1999/xhtml">
-<head>
-    <meta charset="UTF-8"></meta>
-    <meta name="viewport" content="width=device-width, initial-scale=1.0"></meta>
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>Zotero Plugin Test</title>
     <style>
-        html {
-            min-width: 400px;
-            min-height: 600px;
-        }
-        body {
-            font-family: Arial, sans-serif;
-        }
+      html {
+        min-width: 400px;
+        min-height: 600px;
+      }
+      body {
+        font-family: Arial, sans-serif;
+      }
     </style>
-</head>
-<body>
+  </head>
+  <body>
     <div id="mocha"></div>
 
     <!-- Include Zotero Vars -->
@@ -33,17 +27,15 @@
 
     <!-- Setup Mocha -->
     <script>
-      ${setupCode}
+      __SETUP_CODE__;
     </script>
 
     <!-- Unit tests -->
-    ${tests}
+    __TEST_FILES__
 
     <!-- Run Mocha -->
     <script class="mocha-exec">
       mocha.run();
     </script>
-</body>
+  </body>
 </html>
-`;
-}

…ester/test-bundler-template/bootsrtap.ts …r/test-bundler-template/raw/bootstrap.jssrc/core/tester/test-bundler-template/bootsrtap.ts renamed to src/core/tester/test-bundler-template/raw/bootstrap.js src/core/tester/test-bundler-template/bootsrtap.ts renamed to src/core/tester/test-bundler-template/raw/bootstrap.js

@@ -0,0 +1,13 @@
+{
+  "manifest_version": 2,
+  "name": "Zotero Plugin Scaffold Test Runner",
+  "version": "0.0.1",
+  "description": "Test suite for the Zotero plugin. This is a runtime-generated plugin only for testing purposes.",
+  "applications": {
+    "zotero": {
+      "id": "__TESTER_PLUGIN_ID__",
+      "update_url": "https://example.com",
+      "strict_max_version": "999.*.*"
+    }
+  }
+}