zotero-plugin-scaffold 0.1.0-beta.2 → 0.1.0-beta.3

package/README.md

@@ -1,14 +1,23 @@
 # Zotero Plugin Development Scaffold
 
-Working in progress.
+[![NPM Version](https://img.shields.io/npm/v/zotero-plugin-scaffold)](https://www.npmjs.com/package/zotero-plugin-scaffold)
+[![NPM Downloads](https://img.shields.io/npm/dm/zotero-plugin-scaffold)](https://www.npmjs.com/package/zotero-plugin-scaffold)
+![NPM Unpacked Size](https://img.shields.io/npm/unpacked-size/zotero-plugin-scaffold)
+![GitHub License](https://img.shields.io/github/license/northword/zotero-plugin-scaffold)
 
-Create a standalone npm package for scripts in the zotero-plugin-template repository, so that downstream developers can follow along.
+This is an npm package designed to assist in the development of Zotero plugins. It provides features such as compiling plugins, starting Zotero and installing plugins from source code, reloading plugins when the source code changes, and releasing plugins, and so on.
 
-This repository serves only as a proof-of-concept for the above.
+Initially, the code of this package was part of the [zotero-plugin-template](https://github.com/windingwind/zotero-plugin-template) repository. To allow downstream developers to easily stay up-to-date, we have abstracted these scripts into a standalone npm package.
+
+This project is under active development, and some APIs may change. However, it is ready for production and has been [used in several projects](https://github.com/northword/zotero-plugin-scaffold/network/dependents).
+
+For best practices regarding this package, please refer to [zotero-plugin-template](https://github.com/windingwind/zotero-plugin-template).
 
 ## Using in a blank project
 
-> WIP: Not yet implemented
+<details>
+
+<summary>WIP: Not yet implemented</summary>
 
 ```bash
 # npm
@@ -17,6 +26,8 @@ npx zotero-plugin create
 pnpm dlx zotero-plugin create
 ```
 
+</details>
+
 ## Using in an existing project
 
 ### 01. Install
@@ -49,28 +60,25 @@ pnpm link ../zotero-plugin-scaffold
 
 ### 02. Create a config file
 
-The configuration file needs to be stored in the following location. If the configuration file is not found, an error will be thrown.
+The configuration file needs to be stored in the following location.
 
 ```bash
 zotero-plugin.config.ts  # also avaliable in *.js  *.mjs  *.cjs  *.ts
 ```
 
-You can import `defineConfig` in js module to get type hints. If no value is specified for an optional property, the default value will be used.
+You can import helper `defineConfig` to get type hints. If no value is specified for an optional property, the default value will be used.
 
 ```ts
 import { defineConfig } from "zotero-plugin-scaffold";
 
 export default defineConfig({
-  name: pkg.config.addonName,
-  id: pkg.config.addonID,
-  namespace: pkg.config.addonRef,
+  name: "the plugin name",
+  id: "the plugin id",
+  namespace: "the plugin namespace",
   build: {
     esbuildOptions: [
       {
         entryPoints: ["src/index.ts"],
-        define: {
-          __env__: `"${process.env.NODE_ENV}"`,
-        },
         bundle: true,
         target: "firefox115",
       },
@@ -93,8 +101,7 @@ NOTE: Do not check-in this file to the repository!
 
 ```ini
 # The path of the Zotero binary file.
-# The path delimiter should be escaped as `\\` for win32.
-# The path is `*/Zotero.app/Contents/MacOS/zotero` for MacOS.
+# The path is `*/Zotero.app/Contents/MacOS/zotero` for macOS.
 ZOTERO_PLUGIN_ZOTERO_BIN_PATH = /path/to/zotero.exe
 
 # The path of the profile used for development.
@@ -144,13 +151,14 @@ cd zotero-plugin-scaffold/
 pnpm install
 
 # Development Mode
-# This command creates a js runtime using jiti, and the modified code does not need to be built again.
+# This command creates a typescript runtime using jiti,
+# and the modified code does not need to be built again.
 pnpm run dev
 
 # Build
 pnpm run build
 
-# Lint and Prettier
+# ES Lint
 pnpm run lint:fix
 ```
 

package/dist/cli.mjs

@@ -2,7 +2,7 @@
 import { exit, env } from 'node:process';
 import { Command } from 'commander';
 import updateNotifier from 'update-notifier';
-import { L as Log, C as Config, B as Build, S as Serve, R as Release } from './shared/zotero-plugin-scaffold.125bc4ce.mjs';
+import { L as Log, C as Config, B as Build, S as Serve, R as Release } from './shared/zotero-plugin-scaffold.7ad797c4.mjs';
 import 'node:path';
 import 'c12';
 import 'fs-extra';
@@ -25,7 +25,7 @@ import 'chokidar';
 import 'node:fs';
 
 const name = "zotero-plugin-scaffold";
-const version = "0.1.0-beta.2";
+const version = "0.1.0-beta.3";
 
 const logger = new Log();
 async function main() {

package/dist/index.d.mts

@@ -322,7 +322,7 @@ interface ServerConfig {
     /**
      * 启动 Zotero 时附加的命令行参数
      *
-     * @default ["--purgecaches"]
+     * @default []
      */
     startArgs: string[];
     /**

package/dist/index.d.ts

@@ -322,7 +322,7 @@ interface ServerConfig {
     /**
      * 启动 Zotero 时附加的命令行参数
      *
-     * @default ["--purgecaches"]
+     * @default []
      */
     startArgs: string[];
     /**

package/dist/index.mjs

@@ -1,4 +1,4 @@
-export { B as Build, C as Config, R as Release, S as Serve, d as defineConfig } from './shared/zotero-plugin-scaffold.125bc4ce.mjs';
+export { B as Build, C as Config, R as Release, S as Serve, d as defineConfig } from './shared/zotero-plugin-scaffold.7ad797c4.mjs';
 import 'node:path';
 import 'c12';
 import 'fs-extra';

package/dist/shared/{zotero-plugin-scaffold.125bc4ce.mjs → zotero-plugin-scaffold.7ad797c4.mjs}

@@ -911,19 +911,25 @@ class Release extends Base {
     const currentTagIndex = tags.indexOf(currentTag);
     if (currentTagIndex === -1)
       throw new Error(`Tag "${currentTag}" not found.`);
+    let previousTagIndex = currentTagIndex - 1;
+    let previousTag;
     if (currentTagIndex === 0) {
-      return execSync(`git log ${currentTag} --pretty=format:"* %s (%h)"`).toString().trim();
+      previousTag = false;
+    } else if (currentTag.includes("-")) {
+      previousTag = tags[previousTagIndex];
     } else {
-      let previousTagIndex = currentTagIndex - 1;
       while (previousTagIndex >= 0 && tags[previousTagIndex].includes("-")) {
         previousTagIndex--;
       }
-      if (previousTagIndex < 0) {
-        return execSync(`git log ${currentTag} --pretty=format:"* %s (%h)"`).toString().trim();
-      }
-      const previousTag = tags[previousTagIndex];
-      return execSync(`git log ${previousTag}..${currentTag} --pretty=format:"* %s (%h)"`).toString().trim();
+      if (previousTagIndex < 0)
+        previousTag = false;
+      else
+        previousTag = tags[previousTagIndex];
     }
+    if (previousTag)
+      return execSync(`git log --pretty=format:"* %s (%h)" ${previousTag}..${currentTag}`).toString().trim();
+    else
+      return execSync(`git log --pretty=format:"* %s (%h)" ${currentTag}`).toString().trim();
   }
   getFilteredChangelog(rawLog, commitMessage) {
     const filterRegex = new RegExp(escapeRegExp(commitMessage));
@@ -946,7 +952,8 @@ class Release extends Base {
       changelog = this.getFilteredChangelog(rawLog, resolvedCommitMessage);
     }
     this.logger.debug(`Got changelog:
-`, changelog, "\n");
+${changelog}
+`);
     return changelog;
   }
   isEnabled(enable) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "zotero-plugin-scaffold",
   "type": "module",
-  "version": "0.1.0-beta.2",
+  "version": "0.1.0-beta.3",
   "description": "A scaffold for Zotero plugin development.",
   "author": "northword",
   "license": "AGPL-3.0-or-later",
@@ -51,34 +51,34 @@
     "doc": "docs"
   },
   "dependencies": {
-    "@inquirer/prompts": "5.3.6",
-    "bumpp": "9.4.1",
-    "c12": "1.11.1",
-    "chalk": "5.3.0",
-    "chokidar": "3.6.0",
-    "commander": "12.1.0",
-    "conventional-changelog": "6.0.0",
+    "@inquirer/prompts": "^5.3.8",
+    "bumpp": "^9.5.2",
+    "c12": "^1.11.1",
+    "chalk": "^5.3.0",
+    "chokidar": "^3.6.0",
+    "commander": "^12.1.0",
+    "conventional-changelog": "^6.0.0",
     "es-toolkit": "^1.16.0",
-    "esbuild": "0.23.0",
-    "fs-extra": "11.2.0",
+    "esbuild": "^0.23.1",
+    "fs-extra": "^11.2.0",
     "globby": "^14.0.2",
-    "hookable": "5.5.3",
-    "mime": "4.0.4",
-    "octokit": "4.0.2",
-    "replace-in-file": "8.1.0",
-    "std-env": "3.7.0",
-    "update-notifier": "7.1.0",
-    "web-ext": "8.2.0"
+    "hookable": "^5.5.3",
+    "mime": "^4.0.4",
+    "octokit": "^4.0.2",
+    "replace-in-file": "^8.1.0",
+    "std-env": "^3.7.0",
+    "update-notifier": "^7.2.0",
+    "web-ext": "^8.2.0"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "^2.23.0",
-    "@types/fs-extra": "11.0.4",
-    "@types/node": "20.14.13",
-    "@types/update-notifier": "6.0.8",
-    "eslint": "9.8.0",
+    "@antfu/eslint-config": "^2.27.1",
+    "@types/fs-extra": "^11.0.4",
+    "@types/node": "^20.16.1",
+    "@types/update-notifier": "^6.0.8",
+    "eslint": "^9.9.1",
     "eslint-plugin-format": "^0.1.2",
-    "typescript": "5.5.4",
-    "unbuild": "2.0.0"
+    "typescript": "^5.5.4",
+    "unbuild": "^2.0.0"
   },
   "scripts": {
     "dev": "unbuild --stub",