zotero-plugin-scaffold 0.0.4 → 0.0.6

package/README.md

@@ -23,8 +23,6 @@ pnpm dlx zotero-plugin create
 
 #### From NPM
 
-> WIP
-
 ```bash
 npm install -D zotero-plugin-scaffold
 
@@ -66,7 +64,7 @@ You can import `defineConfig` in js module to get type hints. If no value is spe
 import { defineConfig } from "zotero-plugin-scaffold";
 
 export default defineConfig({
-  placeholders: {
+  define: {
     addonName: "Test Addon for Zotero",
     addonID: "",
     addonRef: "",
@@ -137,7 +135,7 @@ import { Build, Config } from "zotero-plugin-scaffold";
 
 const config = await Config.loadConfig();
 
-const Builder = new Build(config, "production");
+const Builder = new Build(config);
 await Builder.run();
 ```
 

package/dist/config.js

@@ -28,8 +28,7 @@ export async function loadConfig(file) {
     const dotenvResult = dotenv.config({
         path: path.resolve(process.cwd(), userConfig.dotEnvPath ?? ".env"),
     }).parsed;
-    if (!dotenvResult)
-        throw new Error(".env file not found");
+    // if (!dotenvResult) throw new Error(".env file not found");
     // Load user's package.json
     const pkg = fs.readJsonSync(path.join("package.json"), {
         encoding: "utf-8",
@@ -160,11 +159,6 @@ export async function loadConfig(file) {
         },
         logLevel: "info",
         dotEnvPath: ".env",
-        cmd: {
-            zoteroBinPath: dotenvResult["zoteroBinPath"],
-            profilePath: dotenvResult["profilePath"],
-            dataDir: dotenvResult["dataDir"],
-        },
         pkgUser: pkg,
         pkgAbsolute: path.join(path.dirname(fileURLToPath(import.meta.url)), "../"),
     };

package/dist/{utils/libBase.d.ts → lib/base.d.ts}

@@ -1,6 +1,6 @@
 import { Config } from "../types.js";
-import Log from "./log.js";
-export declare abstract class LibBase {
+import Log from "../utils/log.js";
+export declare abstract class Base {
     config: Config;
     logger: InstanceType<typeof Log>;
     constructor(config: Config);

package/dist/{utils/libBase.js → lib/base.js}

@@ -1,5 +1,5 @@
-import Log from "./log.js";
-export class LibBase {
+import Log from "../utils/log.js";
+export class Base {
     config;
     logger;
     constructor(config) {

package/dist/lib/build.d.ts

@@ -1,6 +1,6 @@
 import { Config } from "../types.js";
-import { LibBase } from "../utils/libBase.js";
-export default class Build extends LibBase {
+import { Base } from "./base.js";
+export default class Build extends Base {
     private buildTime;
     private isPreRelease;
     constructor(config: Config);

package/dist/lib/build.js

@@ -1,6 +1,6 @@
 import { generateHashSync } from "../utils/crypto.js";
-import { LibBase } from "../utils/libBase.js";
 import { dateFormat } from "../utils/string.js";
+import { Base } from "./base.js";
 import chalk from "chalk";
 import { zip } from "compressing";
 import { buildSync } from "esbuild";
@@ -9,11 +9,12 @@ import fs from "fs-extra";
 import path from "path";
 import replaceInFile from "replace-in-file";
 const { replaceInFileSync } = replaceInFile;
-export default class Build extends LibBase {
+export default class Build extends Base {
     buildTime;
     isPreRelease;
     constructor(config) {
         super(config);
+        process.env.NODE_ENV ??= "production";
         this.buildTime = "";
         this.isPreRelease = this.version.includes("-");
     }

package/dist/lib/release.d.ts

@@ -1,7 +1,7 @@
 import { Config } from "../types.js";
-import { LibBase } from "../utils/libBase.js";
+import { Base } from "./base.js";
 import { Octokit } from "@octokit/rest";
-export default class Release extends LibBase {
+export default class Release extends Base {
     isCI: boolean;
     client: Octokit;
     constructor(config: Config);

package/dist/lib/release.js

@@ -1,4 +1,4 @@
-import { LibBase } from "../utils/libBase.js";
+import { Base } from "./base.js";
 import { Octokit } from "@octokit/rest";
 import ci from "ci-info";
 import { default as glob } from "fast-glob";
@@ -7,7 +7,7 @@ import _ from "lodash";
 import mime from "mime";
 import path from "path";
 import releaseIt from "release-it";
-export default class Release extends LibBase {
+export default class Release extends Base {
     isCI;
     client;
     constructor(config) {

package/dist/lib/serve.d.ts

@@ -1,6 +1,6 @@
 import { Config } from "../types.js";
-import { LibBase } from "../utils/libBase.js";
-export default class Serve extends LibBase {
+import { Base } from "./base.js";
+export default class Serve extends Base {
     private builder;
     constructor(config: Config);
     run(): Promise<void>;

package/dist/lib/serve.js

@@ -1,4 +1,4 @@
-import { LibBase } from "../utils/libBase.js";
+import { Base } from "./base.js";
 import Build from "./build.js";
 import { execSync, spawn } from "child_process";
 import chokidar from "chokidar";
@@ -7,10 +7,11 @@ import _ from "lodash";
 import path from "path";
 import { exit } from "process";
 import webext from "web-ext";
-export default class Serve extends LibBase {
+export default class Serve extends Base {
     builder;
     constructor(config) {
         super(config);
+        process.env.NODE_ENV ??= "development";
         this.builder = new Build(config);
     }
     async run() {
@@ -90,8 +91,8 @@ export default class Serve extends LibBase {
      */
     async startZoteroWebExt() {
         await webext.cmd.run({
-            firefox: this.config.cmd.zoteroBinPath,
-            firefoxProfile: this.config.cmd.profilePath,
+            firefox: this.zoteroBinPath,
+            firefoxProfile: this.profilePath,
             sourceDir: path.resolve(`${this.config.dist}/addon`),
             keepProfileChanges: true,
             args: ["--debugger", "--purgecaches"],

package/dist/types.d.ts

@@ -282,11 +282,6 @@ export interface ConfigBase {
     logLevel: "trace" | "debug" | "info" | "warn" | "error";
 }
 export interface Config extends ConfigBase {
-    cmd: {
-        zoteroBinPath: string;
-        profilePath: string;
-        dataDir: string;
-    };
     pkgUser: any;
     pkgAbsolute: string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zotero-plugin-scaffold",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "description": "A scaffold for Zotero plugin development.",
   "main": "dist/index.js",
   "bin": {
@@ -30,8 +30,8 @@
   },
   "files": [
     "bin/**/*",
-    "dist/**/*.d.ts",
-    "dist/**/*.js",
+    "dist/**/*",
+    "template/**/*",
     "docs/**/*",
     "types/**/*.d.ts"
   ],

package/template/default/.github/workflows/release.yaml

@@ -0,0 +1,56 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - v**
+
+permissions:
+  contents: write
+  issues: write
+  pull-requests: write
+
+jobs:
+  release-it:
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_TOKEN: ${{ secrets.GitHub_TOKEN }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      # - name: Setup pnpm
+      #   uses: pnpm/action-setup@v2
+      #   with:
+      #     version: 8.12.1
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Install deps
+        run: |
+          npm install
+          # echo "public-hoist-pattern[]=@types*" >> .npmrc
+          # pnpm install
+
+      - name: Build
+        run: |
+          npm run build
+
+      - name: Release to GitHub
+        run: |
+          npx release-it -- --no-increment --no-git --no-npm.publish --github.release --ci --VV
+          # pnpm dlx release-it --no-increment --no-git --no-npm.publish --github.release --ci --VV
+          sleep 1s
+
+      - name: Notify release
+        uses: apexskier/github-release-commenter@v1
+        continue-on-error: true
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          comment-template: |
+            :rocket: _This ticket has been resolved in {release_tag}. See {release_link} for release notes._

package/template/default/bootstrap.js

@@ -0,0 +1,78 @@
+/**
+ * Most of this code is from Zotero team's official Make It Red example[1]
+ * or the Zotero 7 documentation[2].
+ * [1] https://github.com/zotero/make-it-red
+ * [2] https://www.zotero.org/support/dev/zotero_7_for_developers
+ */
+
+var chromeHandle;
+
+function install(data, reason) {}
+
+async function startup({ id, version, resourceURI, rootURI }, reason) {
+  await Zotero.initializationPromise;
+
+  // String 'rootURI' introduced in Zotero 7
+  if (!rootURI) {
+    rootURI = resourceURI.spec;
+  }
+
+  var aomStartup = Components.classes[
+    "@mozilla.org/addons/addon-manager-startup;1"
+  ].getService(Components.interfaces.amIAddonManagerStartup);
+  var manifestURI = Services.io.newURI(rootURI + "manifest.json");
+  chromeHandle = aomStartup.registerChrome(manifestURI, [
+    ["content", "__addonRef__", rootURI + "chrome/content/"],
+  ]);
+
+  /**
+   * Global variables for plugin code.
+   * The `_globalThis` is the global root variable of the plugin sandbox environment
+   * and all child variables assigned to it is globally accessible.
+   * See `src/index.ts` for details.
+   */
+  const ctx = {
+    rootURI,
+  };
+  ctx._globalThis = ctx;
+
+  Services.scriptloader.loadSubScript(
+    `${rootURI}/chrome/content/scripts/__addonRef__.js`,
+    ctx,
+  );
+  Zotero.__addonInstance__.hooks.onStartup();
+}
+
+async function onMainWindowLoad({ window }, reason) {
+  Zotero.__addonInstance__?.hooks.onMainWindowLoad(window);
+}
+
+async function onMainWindowUnload({ window }, reason) {
+  Zotero.__addonInstance__?.hooks.onMainWindowUnload(window);
+}
+
+function shutdown({ id, version, resourceURI, rootURI }, reason) {
+  if (reason === APP_SHUTDOWN) {
+    return;
+  }
+
+  if (typeof Zotero === "undefined") {
+    Zotero = Components.classes["@zotero.org/Zotero;1"].getService(
+      Components.interfaces.nsISupports,
+    ).wrappedJSObject;
+  }
+  Zotero.__addonInstance__?.hooks.onShutdown();
+
+  Cc["@mozilla.org/intl/stringbundle;1"]
+    .getService(Components.interfaces.nsIStringBundleService)
+    .flushBundles();
+
+  Cu.unload(`${rootURI}/chrome/content/scripts/__addonRef__.js`);
+
+  if (chromeHandle) {
+    chromeHandle.destruct();
+    chromeHandle = null;
+  }
+}
+
+function uninstall(data, reason) {}