zotero-plugin-scaffold 0.0.22 → 0.0.24

package/dist/cli.mjs

@@ -24,7 +24,7 @@ import 'chokidar';
 import 'process';
 
 const name = "zotero-plugin-scaffold";
-const version = "0.0.22";
+const version = "0.0.24";
 const description = "A scaffold for Zotero plugin development.";
 const scripts = {
 	dev: "unbuild --stub",

package/dist/index.d.mts

@@ -667,15 +667,17 @@ declare class Serve extends Base {
     /**
      * Starts zotero with plugins pre-installed as proxy file
      */
-    startZotero(): Promise<child_process.ChildProcessWithoutNullStreams>;
+    startZoteroByProxyFile(): Promise<child_process.ChildProcessWithoutNullStreams>;
     /**
      * start zotero with plugin installed and reload when dist changed
      */
-    startZoteroWebExt(): Promise<any>;
+    startZoteroByWebExt(): Promise<any>;
     /**
      * Preparing the development environment
      *
-     * When asProxy=true, generate a proxy file to replace prefs.
+     * When asProxy=true, generate a proxy file and replace prefs.
+     *
+     * @see https://www.zotero.org/support/dev/client_coding/plugin_development#setting_up_a_plugin_development_environment
      */
     prepareDevEnv(): void;
     reload(): void;

package/dist/index.d.ts

@@ -667,15 +667,17 @@ declare class Serve extends Base {
     /**
      * Starts zotero with plugins pre-installed as proxy file
      */
-    startZotero(): Promise<child_process.ChildProcessWithoutNullStreams>;
+    startZoteroByProxyFile(): Promise<child_process.ChildProcessWithoutNullStreams>;
     /**
      * start zotero with plugin installed and reload when dist changed
      */
-    startZoteroWebExt(): Promise<any>;
+    startZoteroByWebExt(): Promise<any>;
     /**
      * Preparing the development environment
      *
-     * When asProxy=true, generate a proxy file to replace prefs.
+     * When asProxy=true, generate a proxy file and replace prefs.
+     *
+     * @see https://www.zotero.org/support/dev/client_coding/plugin_development#setting_up_a_plugin_development_environment
      */
     prepareDevEnv(): void;
     reload(): void;

package/dist/index.mjs

@@ -174,7 +174,6 @@ const defaultConfig = {
   },
   server: {
     startArgs: [
-      "--no-remote",
       "--start-debugger-server",
       "--jsdebugger",
       "--debugger",
@@ -734,10 +733,10 @@ class Serve extends Base {
     await this.builder.run();
     await this.ctx.hooks.callHook("serve:prebuild", this.ctx);
     if (this.ctx.server.asProxy) {
-      this.startZotero();
+      this.startZoteroByProxyFile();
     } else {
       console.log("");
-      await this.startZoteroWebExt();
+      await this.startZoteroByWebExt();
     }
     await this.watch();
   }
@@ -756,7 +755,12 @@ class Serve extends Base {
         if (path2.endsWith(".ts")) {
           this.builder.esbuild();
         } else {
-          this.builder.run();
+          await this.builder.run();
+        }
+        if (this.ctx.server.asProxy) {
+          this.reload();
+          this.logger.info("Reloaded done.");
+          await this.ctx.hooks.callHook("serve:onReloaded", this.ctx);
         }
       } catch (err) {
         this.logger.error(err);
@@ -768,18 +772,12 @@ class Serve extends Base {
       this.logger.ready("Server Ready! \n");
     }).on("change", async (path2) => {
       if (this.ctx.server.asProxy) {
-        this.logger.log(`
-${path2} changed`);
+        console.clear();
+        this.logger.log(`${path2} changed`);
       } else {
         console.log("");
       }
-      onChange.cancel();
       onChange(path2);
-      if (this.ctx.server.asProxy) {
-        this.reload();
-        this.logger.info("Reloaded done.");
-        await this.ctx.hooks.callHook("serve:onReloaded", this.ctx);
-      }
     }).on("error", (err) => {
       this.logger.error("Server start failed!", err);
     });
@@ -787,16 +785,11 @@ ${path2} changed`);
   /**
    * Starts zotero with plugins pre-installed as proxy file
    */
-  async startZotero() {
-    if (!fs.existsSync(this.zoteroBinPath)) {
-      throw new Error("Zotero binary does not exist.");
-    }
-    if (!fs.existsSync(this.profilePath)) {
-      throw new Error("The given Zotero profile does not exist.");
-    }
+  async startZoteroByProxyFile() {
     this.prepareDevEnv();
     const zoteroProcess = spawn(this.zoteroBinPath, [
-      "--no-remote",
+      // Do not disable remote, or the debug bridge command will not run.
+      // "--no-remote",
       "--start-debugger-server",
       "--jsdebugger",
       "--debugger",
@@ -819,7 +812,7 @@ ${path2} changed`);
   /**
    * start zotero with plugin installed and reload when dist changed
    */
-  async startZoteroWebExt() {
+  async startZoteroByWebExt() {
     return await webext.cmd.run(
       {
         firefox: this.zoteroBinPath,
@@ -844,7 +837,9 @@ ${path2} changed`);
   /**
    * Preparing the development environment
    *
-   * When asProxy=true, generate a proxy file to replace prefs.
+   * When asProxy=true, generate a proxy file and replace prefs.
+   *
+   * @see https://www.zotero.org/support/dev/client_coding/plugin_development#setting_up_a_plugin_development_environment
    */
   prepareDevEnv() {
     const addonProxyFilePath = path.join(
@@ -865,7 +860,8 @@ ${path2} changed`);
       `extensions/${this.id}.xpi`
     );
     if (fs.existsSync(addonXpiFilePath)) {
-      fs.rmSync(addonXpiFilePath);
+      fs.removeSync(addonXpiFilePath);
+      this.logger.debug(`XPI file found, removed.`);
     }
     const prefsPath = path.join(this.profilePath, "prefs.js");
     if (fs.existsSync(prefsPath)) {
@@ -883,6 +879,19 @@ ${path2} changed`);
       fs.writeFileSync(prefsPath, updatedPrefs, "utf-8");
       this.logger.debug("The <profile>/prefs.js has been modified.");
     }
+    const addonInfoFilePath = path.join(this.profilePath, "extensions.json");
+    if (fs.existsSync(addonInfoFilePath)) {
+      const content = fs.readJSONSync(addonInfoFilePath);
+      content.addons = content.addons.map((addon) => {
+        if (addon.id === this.id && addon.active === false) {
+          addon.active = true;
+          addon.userDisabled = false;
+          this.logger.debug(`Active plugin ${this.id} in extensions.json.`);
+        }
+        return addon;
+      });
+      fs.outputJSONSync(addonInfoFilePath, content);
+    }
   }
   reload() {
     this.logger.debug("Reloading...");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zotero-plugin-scaffold",
-  "version": "0.0.22",
+  "version": "0.0.24",
   "description": "A scaffold for Zotero plugin development.",
   "type": "module",
   "exports": {