zotero-plugin-scaffold 0.1.8-beta.2 → 0.2.0-beta.4

package/dist/chunks/github.mjs

@@ -5,7 +5,7 @@ import { globbySync } from 'globby';
 import mime from 'mime';
 import { Octokit } from 'octokit';
 import { isCI } from 'std-env';
-import { a as Base } from '../shared/zotero-plugin-scaffold.ac50adf5.mjs';
+import { a as Base } from '../shared/zotero-plugin-scaffold.619ed490.mjs';
 import 'c12';
 import 'es-toolkit';
 import 'hookable';

package/dist/cli.mjs

@@ -2,7 +2,7 @@
 import process, { exit, env } from 'node:process';
 import { Command } from '@commander-js/extra-typings';
 import updateNotifier from 'update-notifier';
-import { L as Log, C as Config, B as Build, S as Serve, T as Test, R as Release } from './shared/zotero-plugin-scaffold.ac50adf5.mjs';
+import { L as Log, C as Config, B as Build, S as Serve, T as Test, R as Release } from './shared/zotero-plugin-scaffold.619ed490.mjs';
 import 'node:path';
 import 'c12';
 import 'es-toolkit';
@@ -27,7 +27,7 @@ import 'xvfb-ts';
 
 const name = "zotero-plugin-scaffold";
 const type = "module";
-const version = "0.1.8-beta.2";
+const version = "0.2.0-beta.4";
 const packageManager = "pnpm@9.14.4";
 const description = "A scaffold for Zotero plugin development.";
 const author = "northword";

package/dist/index.d.mts

@@ -627,6 +627,16 @@ interface TestConfig {
      * 这些首选项将在测试开始前设置。
      */
     prefs: Record<string, string | boolean | number>;
+    mocha: {
+        /**
+         * The timeout of the test.
+         *
+         * 测试的超时时间。
+         *
+         * @default 10000
+         */
+        timeout: number;
+    };
     /**
      * Port for the test server.
      *
@@ -651,6 +661,19 @@ interface TestConfig {
      * @default false
      */
     exitOnFinish: boolean;
+    /**
+     * Run Zotero in deadless mode.
+     *
+     * - Supported for Linux only.
+     * - Default to true when in CI environments.
+     *
+     * 使用无头模式运行 Zotero。
+     *
+     * - 仅支持 Linux
+     * - 在 CI 模式下，默认为 true
+     *
+     * @default false
+     */
     headless: boolean;
     /**
      * The delay time before running the test. Make sure the plugin is fully loaded before running the test.
@@ -821,7 +844,7 @@ declare class Test extends Base {
     bundleTests(): Promise<void>;
     startTestServer(): Promise<void>;
     handleTestUpdate(body: {
-        type: "start" | "suite" | "suite end" | "pending" | "pass" | "fail" | "end";
+        type: "start" | "suite" | "suite end" | "pending" | "pass" | "fail" | "end" | "debug";
         data?: {
             title: string;
             str: string;

package/dist/index.d.ts

@@ -627,6 +627,16 @@ interface TestConfig {
      * 这些首选项将在测试开始前设置。
      */
     prefs: Record<string, string | boolean | number>;
+    mocha: {
+        /**
+         * The timeout of the test.
+         *
+         * 测试的超时时间。
+         *
+         * @default 10000
+         */
+        timeout: number;
+    };
     /**
      * Port for the test server.
      *
@@ -651,6 +661,19 @@ interface TestConfig {
      * @default false
      */
     exitOnFinish: boolean;
+    /**
+     * Run Zotero in deadless mode.
+     *
+     * - Supported for Linux only.
+     * - Default to true when in CI environments.
+     *
+     * 使用无头模式运行 Zotero。
+     *
+     * - 仅支持 Linux
+     * - 在 CI 模式下，默认为 true
+     *
+     * @default false
+     */
     headless: boolean;
     /**
      * The delay time before running the test. Make sure the plugin is fully loaded before running the test.
@@ -821,7 +844,7 @@ declare class Test extends Base {
     bundleTests(): Promise<void>;
     startTestServer(): Promise<void>;
     handleTestUpdate(body: {
-        type: "start" | "suite" | "suite end" | "pending" | "pass" | "fail" | "end";
+        type: "start" | "suite" | "suite end" | "pending" | "pass" | "fail" | "end" | "debug";
         data?: {
             title: string;
             str: string;

package/dist/index.mjs

@@ -1,4 +1,4 @@
-export { B as Build, C as Config, R as Release, S as Serve, T as Test, d as defineConfig } from './shared/zotero-plugin-scaffold.ac50adf5.mjs';
+export { B as Build, C as Config, R as Release, S as Serve, T as Test, d as defineConfig } from './shared/zotero-plugin-scaffold.619ed490.mjs';
 import 'node:path';
 import 'c12';
 import 'es-toolkit';

package/dist/shared/{zotero-plugin-scaffold.ac50adf5.mjs → zotero-plugin-scaffold.619ed490.mjs}

@@ -311,6 +311,9 @@ const defaultConfig = {
   test: {
     entries: "test/",
     prefs: {},
+    mocha: {
+      timeout: 1e4
+    },
     port: 9876,
     abortOnFail: false,
     exitOnFinish: false,
@@ -1457,11 +1460,36 @@ function waitUtilAsync(condition, interval = 100, timeout = 1e4) {
       return 0;
     });
     let testCode = `
-mocha.setup({ ui: "bdd", reporter: Reporter });
+mocha.setup({ ui: "bdd", reporter: Reporter, timeout: ${this.ctx.test.mocha.timeout} || 10000, });
 
 window.expect = chai.expect;
 window.assert = chai.assert;
 
+async function send(data) {
+  console.log("Sending data to server", data);
+  const req = await Zotero.HTTP.request(
+    "POST",
+    "http://localhost:${this.ctx.test.port || 9876}/update",
+    {
+      body: JSON.stringify(data),
+    }
+  );
+
+  if (req.status !== 200) {
+    dump("Error sending data to server" + req.responseText);
+    return null;
+  } else {
+    const result = JSON.parse(req.responseText);
+    return result;
+  }
+}
+
+window.debug = function (...data) {
+  const str = data.join("\\n");
+  Zotero.debug(str);
+  send({ type: "debug", data: { str } });
+};
+
 // Inherit the default test settings from Zotero
 function Reporter(runner) {
   var indents = 0,
@@ -1478,25 +1506,6 @@ function Reporter(runner) {
     document.querySelector("#mocha").innerText += str;
   }
 
-  async function send(data) {
-    console.log("Sending data to server", data);
-    const req = await Zotero.HTTP.request(
-      "POST",
-      "http://localhost:${this.ctx.test.port || 9876}/update",
-      {
-        body: JSON.stringify(data),
-      }
-    );
-
-    if (req.status !== 200) {
-      dump("Error sending data to server" + req.responseText);
-      return null;
-    } else {
-      const result = JSON.parse(req.responseText);
-      return result;
-    }
-  }
-
   runner.on("start", async function () {
     await send({ type: "start" });
   });
@@ -1625,7 +1634,7 @@ mocha.run();
             res.writeHead(200, { "Content-Type": "application/json" });
             res.end(JSON.stringify({ message: "Results received successfully" }));
           } catch (error) {
-            console.error("Error parsing JSON:", error);
+            this.logger.error("Error parsing JSON:", error);
             res.writeHead(400, { "Content-Type": "application/json" });
             res.end(JSON.stringify({ error: "Invalid JSON" }));
           }
@@ -1641,6 +1650,12 @@ mocha.run();
     });
   }
   async handleTestUpdate(body) {
+    if (body.type === "debug" && body.data?.str) {
+      for (const line of body.data?.str.split("\n")) {
+        this.logger.log(line);
+        this.logger.newLine();
+      }
+    }
     const str = body.data?.str.replaceAll("\n", "");
     if (body.type === "start") {
       this.logger.newLine();
@@ -1671,46 +1686,37 @@ mocha.run();
     process.env.ZOTERO_PLUGIN_ZOTERO_BIN_PATH = `${cwd()}/Zotero_linux-x86_64/zotero`;
   }
   async installXvfb() {
+    if (!isLinux) {
+      this.logger.error("Unsupported platform. Please install Xvfb manually.");
+      process.exit(1);
+    }
     try {
       execSync("which xvfb", { stdio: "ignore" });
     } catch {
-      if (isLinux) {
-        try {
-          const osId = execSync("cat /etc/os-release | grep '^ID='").toString();
-          if (osId.includes("ubuntu") || osId.includes("debian")) {
-            this.logger.debug("Detected Ubuntu/Debian. Installing Xvfb...");
-            execSync("sudo apt-get update && sudo apt-get install -y xvfb", { stdio: "inherit" });
-          } else if (osId.includes("centos") || osId.includes("rhel")) {
-            this.logger.debug("Detected CentOS/RHEL. Installing Xvfb...");
-            execSync("sudo yum install -y xorg-x11-server-Xvfb", { stdio: "inherit" });
-          } else {
-            throw new Error("Unsupported Linux distribution.");
-          }
-          this.logger.debug("Xvfb installation completed.");
-        } catch (error) {
-          console.error("Failed to install Xvfb:", error);
-          process.exit(1);
-        }
-      } else if (isMacOS) {
-        this.logger.debug("Detected macOS. Installing XQuartz...");
-        try {
-          execSync("brew install xquartz", { stdio: "inherit" });
-          this.logger.debug("XQuartz installation completed.");
-        } catch (error) {
-          console.error("Failed to install XQuartz:", error);
-          process.exit(1);
+      try {
+        const osId = execSync("cat /etc/os-release | grep '^ID='").toString();
+        if (osId.includes("ubuntu") || osId.includes("debian")) {
+          this.logger.debug("Detected Ubuntu/Debian. Installing Xvfb...");
+          execSync("sudo apt-get update && sudo apt-get install -y xvfb", { stdio: "pipe" });
+        } else if (osId.includes("centos") || osId.includes("rhel")) {
+          this.logger.debug("Detected CentOS/RHEL. Installing Xvfb...");
+          execSync("sudo yum install -y xorg-x11-server-Xvfb", { stdio: "pipe" });
+        } else {
+          throw new Error("Unsupported Linux distribution.");
         }
-      } else {
-        console.error("Unsupported platform. Please install Xvfb manually.");
+        this.logger.debug("Xvfb installation completed.");
+      } catch (error) {
+        this.logger.error("Failed to install Xvfb:", error);
         process.exit(1);
       }
     }
   }
   async installZoteroLinux() {
     try {
-      execSync("wget -O zotero.tar.bz2 'https://www.zotero.org/download/client/dl?platform=linux-x86_64&channel=beta'");
-      execSync("tar -xvf zotero.tar.bz2");
-    } catch {
+      execSync("wget -O zotero.tar.bz2 'https://www.zotero.org/download/client/dl?platform=linux-x86_64&channel=beta'", { stdio: "pipe" });
+      execSync("tar -xvf zotero.tar.bz2", { stdio: "pipe" });
+    } catch (e) {
+      this.logger.error(e);
       throw new Error("Zotero extracted failed");
     }
   }
@@ -1737,6 +1743,7 @@ mocha.run();
       process.exit(0);
     } else {
       this.logger.error("Test run failed");
+      this._process?.kill();
       process.exit(status);
     }
   }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "zotero-plugin-scaffold",
   "type": "module",
-  "version": "0.1.8-beta.2",
+  "version": "0.2.0-beta.4",
   "description": "A scaffold for Zotero plugin development.",
   "author": "northword",
   "license": "AGPL-3.0-or-later",