zotero-plugin-scaffold 0.7.1 → 0.8.0

package/README.md

@@ -3,26 +3,26 @@
 [![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)
+![GitHub License](https://img.shields.io/github/license/zotero-plugin-dev/zotero-plugin-scaffold)
 [![code style](https://antfu.me/badge-code-style.svg)](https://github.com/antfu/eslint-config)
 
 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.
 
 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).
+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/zotero-plugin-dev/zotero-plugin-scaffold/network/dependents).
 
 For best practices regarding this package, please refer to [zotero-plugin-template](https://github.com/windingwind/zotero-plugin-template).
 
 ## Documentation
 
-[Read the Docs to Learn More](https://northword.github.io/zotero-plugin-scaffold).
+[Read the Docs to Learn More](https://zotero-plugin-dev.github.io/zotero-plugin-scaffold).
 
 ## Contributing
 
 ```bash
 # Git Clone
-git clone https://github.com/northword/zotero-plugin-scaffold.git zotero-plugin-scaffold
+git clone https://github.com/zotero-plugin-dev/zotero-plugin-scaffold.git
 cd zotero-plugin-scaffold/
 
 # Install deps
@@ -36,7 +36,7 @@ pnpm run dev
 
 # link local scaffold to your plugin
 cd your-plugin-work-dir/
-pnpm link ../zotero-plugin-scaffold/packages/scaffold/
+pnpm link ../zotero-plugin-scaffold/
 cd zotero-plugin-scaffold/
 ```
 
@@ -60,4 +60,4 @@ GNU Affero General Public License Version 3.
 
 This project references the design and code of the [Zotero Plugin Template](https://github.com/windingwind/zotero-plugin-template).
 
-This project would not be possible without the support of the [open source community](https://github.com/northword/zotero-plugin-scaffold/network/dependencies).
+This project would not be possible without the support of the [open source community](https://github.com/zotero-plugin-dev/zotero-plugin-scaffold/network/dependencies).

package/dist/cli.d.mts

@@ -1,4 +1,4 @@
-import { B as Base, C as Context, O as OverrideConfig } from './shared/zotero-plugin-scaffold.CIruZpuO.mjs';
+import { B as Base, C as Context, O as OverrideConfig } from './shared/zotero-plugin-scaffold.fkuivpCE.mjs';
 import 'hookable';
 import 'esbuild';
 

package/dist/cli.mjs

@@ -1,6 +1,6 @@
 import process from 'node:process';
 import { Command } from 'commander';
-import { E as ExitSignals, C as Config, B as Build, S as Serve, T as Test, R as Release } from './shared/zotero-plugin-scaffold.BLTrbfUc.mjs';
+import { E as ExitSignals, C as Config, B as Build, S as Serve, T as Test, R as Release } from './shared/zotero-plugin-scaffold.8gLns8GX.mjs';
 import { readFile } from 'node:fs/promises';
 import { pathExists } from 'fs-extra';
 import { l as logger } from './shared/zotero-plugin-scaffold.CzBjWbS8.mjs';
@@ -36,7 +36,7 @@ import 'node:http';
 import 'node:readline';
 
 const name = "zotero-plugin-scaffold";
-const version = "0.7.1";
+const version = "0.8.0";
 const pkg = {
 	name: name,
 	version: version};

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { U as UserConfig, O as OverrideConfig, C as Context, B as Base } from './shared/zotero-plugin-scaffold.CIruZpuO.mjs';
+import { U as UserConfig, O as OverrideConfig, C as Context, B as Base } from './shared/zotero-plugin-scaffold.fkuivpCE.mjs';
 import 'hookable';
 import 'esbuild';
 

package/dist/index.mjs

@@ -1,4 +1,4 @@
-export { B as Build, C as Config, R as Release, S as Serve, T as Test, d as defineConfig } from './shared/zotero-plugin-scaffold.BLTrbfUc.mjs';
+export { B as Build, C as Config, R as Release, S as Serve, T as Test, d as defineConfig } from './shared/zotero-plugin-scaffold.8gLns8GX.mjs';
 import 'c12';
 import 'es-toolkit';
 import 'fs-extra/esm';

package/dist/shared/{zotero-plugin-scaffold.BLTrbfUc.mjs → zotero-plugin-scaffold.8gLns8GX.mjs}

@@ -87,6 +87,7 @@ function resolveConfig$1(config) {
 }
 const defaultConfig = {
   source: "src",
+  watchIgnore: [],
   dist: ".scaffold/build",
   name: "",
   id: "",
@@ -2454,18 +2455,19 @@ function resolveModuleURL(input, options) {
     }
   }
   const conditionsSet = options?.conditions ? new Set(options.conditions) : DEFAULT_CONDITIONS_SET;
+  const target = specifier || url.href;
   const bases = _normalizeBases(options?.from);
   const suffixes = options?.suffixes || [""];
   const extensions = options?.extensions ? ["", ...options.extensions] : [""];
   let resolved;
   for (const base of bases) {
     for (const suffix of suffixes) {
+      let name = _join(target, suffix);
+      if (name === ".") {
+        name += "/.";
+      }
       for (const extension of extensions) {
-        resolved = _tryModuleResolve(
-          _join(specifier || url.href, suffix) + extension,
-          base,
-          conditionsSet
-        );
+        resolved = _tryModuleResolve(name + extension, base, conditionsSet);
         if (resolved) {
           break;
         }
@@ -2529,7 +2531,7 @@ function _normalizeBase(input) {
   if (!input) {
     return [];
   }
-  if (input instanceof URL) {
+  if (_isURL(input)) {
     return [input];
   }
   if (typeof input !== "string") {
@@ -2572,6 +2574,9 @@ function _join(a, b) {
 function _normalizeWinPath(path) {
   return path.replace(/\\/g, "/").replace(/^[a-z]:\//, (r) => r.toUpperCase());
 }
+function _isURL(input) {
+  return input instanceof URL || input?.constructor?.name === "URL";
+}
 function _parseInput(input) {
   if (typeof input === "string") {
     if (input.startsWith("file:")) {
@@ -2589,7 +2594,7 @@ function _parseInput(input) {
     }
     return { specifier: input };
   }
-  if (input instanceof URL) {
+  if (_isURL(input)) {
     if (input.protocol === "file:") {
       return { url: input, absolutePath: fileURLToPath(input) };
     }
@@ -2732,6 +2737,52 @@ async function getGitDiff(from, to = "HEAD", cwd) {
     return r2;
   });
 }
+function parseCommits(commits, config) {
+  return commits.map((commit) => parseGitCommit(commit, config)).filter(Boolean);
+}
+const ConventionalCommitRegex = /(?<emoji>:.+:|(\uD83C[\uDF00-\uDFFF])|(\uD83D[\uDC00-\uDE4F\uDE80-\uDEFF])|[\u2600-\u2B55])?( *)?(?<type>[a-z]+)(\((?<scope>.+)\))?(?<breaking>!)?: (?<description>.+)/i;
+const CoAuthoredByRegex = /co-authored-by:\s*(?<name>.+)(<(?<email>.+)>)/gim;
+const PullRequestRE = /\([ a-z]*(#\d+)\s*\)/gm;
+const IssueRE = /(#\d+)/gm;
+function parseGitCommit(commit, config) {
+  const match = commit.message.match(ConventionalCommitRegex);
+  if (!match) {
+    return null;
+  }
+  const type = match.groups.type;
+  const hasBreakingBody = /breaking change:/i.test(commit.body);
+  let scope = match.groups.scope || "";
+  scope = config.scopeMap[scope] || scope;
+  const isBreaking = Boolean(match.groups.breaking || hasBreakingBody);
+  let description = match.groups.description;
+  const references = [];
+  for (const m of description.matchAll(PullRequestRE)) {
+    references.push({ type: "pull-request", value: m[1] });
+  }
+  for (const m of description.matchAll(IssueRE)) {
+    if (!references.some((i) => i.value === m[1])) {
+      references.push({ type: "issue", value: m[1] });
+    }
+  }
+  references.push({ value: commit.shortHash, type: "hash" });
+  description = description.replace(PullRequestRE, "").trim();
+  const authors = [commit.author];
+  for (const match2 of commit.body.matchAll(CoAuthoredByRegex)) {
+    authors.push({
+      name: (match2.groups.name || "").trim(),
+      email: (match2.groups.email || "").trim()
+    });
+  }
+  return {
+    ...commit,
+    authors,
+    description,
+    type,
+    scope,
+    references,
+    isBreaking
+  };
+}
 
 const providerToRefSpec = {
   github: { "pull-request": "pull", hash: "commit", issue: "issues" },
@@ -2883,9 +2934,9 @@ async function generateMarkDown(commits, config) {
         const _email = [...i.email].find(
           (e) => !e.includes("noreply.github.com")
         );
-        const email = config.hideAuthorEmail !== true && _email ? `<${_email}>` : "";
-        const github = i.github ? `([@${i.github}](https://github.com/${i.github}))` : "";
-        return `- ${i.name} ${github || email}`;
+        const email = config.hideAuthorEmail !== true && _email ? ` <${_email}>` : "";
+        const github = i.github ? ` ([@${i.github}](https://github.com/${i.github}))` : "";
+        return `- ${i.name}${github || email || ""}`;
       })
     );
   }
@@ -3272,10 +3323,17 @@ ${changelog}
   }
 }
 
-function watch(source, event) {
+function watch(source, ignore, event) {
   const watcher = chokidar.watch(source, {
-    ignored: /(^|[/\\])\../,
-    // ignore dotfiles
+    ignored: [
+      /(^|[/\\])\../,
+      // ignore dotfiles
+      /[\\/]\.git[\\/]/,
+      /[\\/]node_modules[\\/]/,
+      ...toArray(ignore)
+    ],
+    ignoreInitial: true,
+    ignorePermissionErrors: true,
     persistent: true
   });
   const onChangeDebounced = safeDebounce(event.onChange);
@@ -4102,9 +4160,10 @@ class Serve extends Base {
    * watch source dir and build when file changed
    */
   async watch() {
-    const { source } = this.ctx;
+    const { source, watchIgnore } = this.ctx;
     watch(
       source,
+      watchIgnore,
       {
         onReady: async () => {
           await this.ctx.hooks.callHook("serve:ready", this.ctx);
@@ -4800,6 +4859,7 @@ class Test extends Base {
     }
     watch(
       [this.ctx.source, this.ctx.test.entries].flat(),
+      this.ctx.watchIgnore,
       {
         onChange: async (path) => {
           if (isSource(path)) {

package/dist/shared/{zotero-plugin-scaffold.CIruZpuO.d.mts → zotero-plugin-scaffold.fkuivpCE.d.mts}

@@ -125,17 +125,31 @@ interface UpdateJSON {
 
 interface Config {
     /**
-     * The source code directories.
+     * Source root directory or directories for the plugin.
      *
-     * Can be multiple directories, and changes to these directories will be watched when `server` is running.
+     * These paths are:
+     * - Watched during development to trigger rebuilds on changes.
+     * - Used to remove the top-level asset directory (e.g. `assets/`) during build,
+     *   so that only its contents are copied directly to the output root.
      *
-     * 源码目录。
+     * 插件的源码根目录（可为字符串或字符串数组）。
      *
-     * 可以是多个目录，将在 `server` 运行时监听这些目录的变更。
+     * 用于以下两个目的：
+     * - 在开发模式下监听这些目录，以便在文件变更时触发重建；
+     * - 在构建阶段中，用于识别 assets 所在的顶层目录，以移除该目录本身，仅将其内容复制到输出目录的根部。
      *
+     * @example ["src", "addon"]
      * @default "src"
      */
     source: string | string[];
+    /**
+     * The files to ignore when watching.
+     *
+     * 忽略的监听文件。
+     *
+     * @default []
+     */
+    watchIgnore: string | string[] | RegExp | RegExp[];
     /**
      * The build directories.
      *

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "zotero-plugin-scaffold",
   "type": "module",
-  "version": "0.7.1",
+  "version": "0.8.0",
   "description": "A scaffold for Zotero plugin development.",
   "author": "northword",
   "license": "AGPL-3.0-or-later",
@@ -55,14 +55,14 @@
   },
   "dependencies": {
     "@fluent/syntax": "^0.19.0",
-    "@swc/core": "^1.12.0",
+    "@swc/core": "^1.13.3",
     "adm-zip": "^0.5.16",
-    "bumpp": "^10.1.1",
-    "c12": "^3.0.4",
+    "bumpp": "^10.2.1",
+    "c12": "^3.2.0",
     "chokidar": "^4.0.3",
     "commander": "^14.0.0",
-    "es-toolkit": "^1.39.3",
-    "esbuild": "^0.25.5",
+    "es-toolkit": "^1.39.8",
+    "esbuild": "^0.25.8",
     "fs-extra": "^11.3.0",
     "hookable": "^5.5.3",
     "octokit": "^5.0.3",
@@ -72,22 +72,22 @@
     "xvfb-ts": "^1.1.0"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "^4.14.1",
+    "@antfu/eslint-config": "^5.0.0",
     "@commander-js/extra-typings": "^14.0.0",
     "@types/adm-zip": "^0.5.7",
     "@types/fs-extra": "^11.0.4",
-    "@types/node": "^22.15.31",
-    "bumpp": "^10.1.1",
-    "changelogen": "^0.6.1",
-    "eslint": "^9.28.0",
+    "@types/node": "^22.17.0",
+    "bumpp": "^10.2.1",
+    "changelogen": "^0.6.2",
+    "eslint": "^9.32.0",
     "eslint-plugin-format": "^1.0.1",
     "husky": "^9.1.7",
-    "lint-staged": "^16.1.0",
+    "lint-staged": "^16.1.2",
     "node-style-text": "^0.0.8",
-    "tsx": "^4.20.1",
-    "typescript": "^5.8.3",
-    "unbuild": "^3.5.0",
-    "vitest": "^3.2.3"
+    "tsx": "^4.20.3",
+    "typescript": "^5.9.2",
+    "unbuild": "^3.6.0",
+    "vitest": "^3.2.4"
   },
   "workspaces": [
     "src",