zotero-plugin-scaffold 0.0.4 → 0.0.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zotero-plugin-scaffold",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "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) {}