zotero-plugin-scaffold 0.0.21 → 0.0.23

package/dist/cli.mjs

@@ -24,7 +24,7 @@ import 'chokidar';
 import 'process';
 
 const name = "zotero-plugin-scaffold";
-const version = "0.0.21";
+const version = "0.0.23";
 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",
@@ -495,6 +494,9 @@ class Release extends Base {
     __publicField$1(this, "client");
     this.isCI = isCI;
     this.client = this.getClient();
+    if (this.isCI) {
+      this.logger.level = 4;
+    }
   }
   /**
    * Runs release
@@ -511,7 +513,9 @@ class Release extends Base {
       if (glob.globSync(`${this.dist}/*.xpi`).length == 0) {
         throw new Error("No xpi file found, are you sure you have run build?");
       }
+      this.logger.info("Uploading XPI...");
       await this.uploadXPI();
+      this.logger.info("Uploading update manifest...");
       await this.uploadUpdateJSON();
     }
     this.logger.success(
@@ -541,21 +545,32 @@ class Release extends Base {
     });
     if (!release)
       throw new Error("Create release failed!");
-    this.uploadAsset(release.id, path.join(this.dist, `${this.xpiName}.xpi`));
+    this.logger.debug("Uploading xpi asset...");
+    await this.uploadAsset(
+      release.id,
+      path.join(this.dist, `${this.xpiName}.xpi`)
+    );
   }
   async getReleaseByTag(tag) {
     return await this.client.rest.repos.getReleaseByTag({
       owner: this.owner,
       repo: this.repo,
       tag
+    }).catch((e) => {
+      this.logger.log(`Release with tag ${tag} not found.`);
+      return void 0;
     }).then((res) => {
-      if (res.status == 200) {
+      if (res && res.status == 200) {
         return res.data;
       }
     });
   }
   async creatRelease(options) {
-    return await this.client.rest.repos.createRelease(options).then((res) => {
+    this.logger.debug("Creating release...", options);
+    return await this.client.rest.repos.createRelease(options).catch((e) => {
+      this.logger.error(e);
+      throw new Error("Create release failed.");
+    }).then((res) => {
       if (res.status == 201) {
         return res.data;
       }
@@ -581,7 +596,8 @@ class Release extends Base {
     const release = await this.getReleaseByTag("release") ?? await this.creatRelease({
       owner: this.owner,
       repo: this.repo,
-      tag_name: "release"
+      tag_name: "release",
+      make_latest: "false"
     });
     if (!release)
       throw new Error("Get or create 'release' failed.");
@@ -620,8 +636,8 @@ class Release extends Base {
       conventionalChangelog({ releaseCount: 2 }, { version: this.version }).on("data", (chunk) => {
         changelog += chunk.toString();
       }).on("end", () => {
-        this.logger.debug("changelog:", changelog);
-        resolve(changelog);
+        this.logger.debug("changelog:", changelog.trim());
+        resolve(changelog.trim());
       }).on("error", (err) => {
         reject(err);
       });
@@ -717,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();
   }
@@ -770,16 +786,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",
@@ -802,7 +813,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,
@@ -827,7 +838,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(
@@ -848,7 +861,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)) {
@@ -866,6 +880,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.21",
+  "version": "0.0.23",
   "description": "A scaffold for Zotero plugin development.",
   "type": "module",
   "exports": {