zotero-plugin-scaffold 0.1.6 → 0.1.8-beta.1

package/dist/chunks/github.mjs

@@ -4,9 +4,8 @@ import fs from 'fs-extra';
 import { globbySync } from 'globby';
 import mime from 'mime';
 import { Octokit } from 'octokit';
-import { R as ReleaseBase } from '../shared/zotero-plugin-scaffold.3e58ced7.mjs';
-import 'std-env';
-import '../shared/zotero-plugin-scaffold.c7c8af0c.mjs';
+import { isCI } from 'std-env';
+import { a as Base } from '../shared/zotero-plugin-scaffold.dad9978d.mjs';
 import 'c12';
 import 'es-toolkit';
 import 'hookable';
@@ -17,10 +16,33 @@ import 'replace-in-file';
 import 'web-ext';
 import 'node:crypto';
 import 'node:child_process';
-import 'conventional-changelog';
 import 'bumpp';
 import 'chokidar';
 import 'node:fs';
+import 'node:fs/promises';
+import 'node:http';
+import 'fs-extra/esm';
+import 'xvfb-ts';
+
+var __defProp$1 = Object.defineProperty;
+var __defNormalProp$1 = (obj, key, value) => key in obj ? __defProp$1(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$1 = (obj, key, value) => {
+  __defNormalProp$1(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+class ReleaseBase extends Base {
+  constructor(ctx) {
+    super(ctx);
+    __publicField$1(this, "isCI");
+    this.isCI = isCI;
+  }
+  checkFiles() {
+    const { dist } = this.ctx;
+    if (globbySync(`${dist}/*.xpi`).length === 0) {
+      throw new Error("No xpi file found, are you sure you have run build?");
+    }
+  }
+}
 
 var __defProp = Object.defineProperty;
 var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;

package/dist/cli.mjs

@@ -2,7 +2,7 @@
 import process, { exit, env } from 'node:process';
 import { Command } from '@commander-js/extra-typings';
 import updateNotifier from 'update-notifier';
-import { L as Log, C as Config, a as Build, S as Serve, R as Release } from './shared/zotero-plugin-scaffold.c7c8af0c.mjs';
+import { L as Log, C as Config, B as Build, S as Serve, T as Test, R as Release } from './shared/zotero-plugin-scaffold.dad9978d.mjs';
 import 'node:path';
 import 'c12';
 import 'es-toolkit';
@@ -17,17 +17,154 @@ import 'replace-in-file';
 import 'web-ext';
 import 'node:crypto';
 import 'node:child_process';
-import 'conventional-changelog';
 import 'bumpp';
 import 'chokidar';
 import 'node:fs';
+import 'node:fs/promises';
+import 'node:http';
+import 'fs-extra/esm';
+import 'xvfb-ts';
 
 const name = "zotero-plugin-scaffold";
-const version = "0.1.6";
+const type = "module";
+const version = "0.1.8-beta.1";
+const packageManager = "pnpm@9.14.4";
+const description = "A scaffold for Zotero plugin development.";
+const author = "northword";
+const license = "AGPL-3.0-or-later";
+const homepage = "https://github.com/northword/zotero-plugin-scaffold#readme";
+const repository = {
+	type: "git",
+	url: "https://github.com/northword/zotero-plugin-scaffold.git"
+};
+const bugs = {
+	url: "https://github.com/northword/zotero-plugin-scaffold/issues"
+};
+const keywords = [
+	"zotero",
+	"plugin",
+	"developer",
+	"scaffold",
+	"web-ext"
+];
+const exports = {
+	".": {
+		types: "./dist/index.d.ts",
+		"import": "./dist/index.mjs"
+	},
+	"./vendor": {
+		types: "./dist/vendor/index.d.ts",
+		"import": "./dist/vendor/index.mjs"
+	}
+};
+const main$1 = "./dist/index.mjs";
+const module = "./dist/index.mjs";
+const types = "./dist/index.d.ts";
+const bin = {
+	"zotero-plugin": "./dist/cli.mjs"
+};
+const files = [
+	"dist"
+];
+const engines = {
+	node: ">=18"
+};
+const scripts = {
+	dev: "unbuild --stub",
+	build: "tsc --noEmit && unbuild",
+	"lint:check": "eslint .",
+	"lint:fix": "eslint . --fix",
+	release: "bumpp --commit \"chore(release): publish v%s\"",
+	"update:deps": "pnpx taze minor -w -f -l",
+	test: "echo \"Error: no test specified\" && exit 1"
+};
+const publishConfig = {
+	access: "public",
+	registry: "https://registry.npmjs.org"
+};
+const directories = {
+	lib: "dist",
+	doc: "docs"
+};
+const peerDependencies = {
+	"conventional-changelog": "^6.0.0"
+};
+const peerDependenciesMeta = {
+	"conventional-changelog": {
+		optional: true
+	}
+};
+const dependencies = {
+	"@commander-js/extra-typings": "^12.1.0",
+	"@inquirer/prompts": "^7.0.0",
+	bumpp: "^9.7.1",
+	c12: "^2.0.1",
+	chalk: "^5.3.0",
+	chokidar: "^4.0.1",
+	commander: "^12.1.0",
+	"es-toolkit": "^1.25.2",
+	esbuild: "^0.24.0",
+	"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.2.0",
+	"std-env": "^3.7.0",
+	"update-notifier": "^7.3.1",
+	"web-ext": "^8.3.0",
+	"xvfb-ts": "^1.1.0"
+};
+const devDependencies = {
+	"@antfu/eslint-config": "^3.8.0",
+	"@types/fs-extra": "^11.0.4",
+	"@types/node": "^22.0.0",
+	"@types/update-notifier": "^6.0.8",
+	eslint: "^9.12.0",
+	"eslint-plugin-format": "^0.1.2",
+	typescript: "^5.7.2",
+	unbuild: "^2.0.0"
+};
+const pnpm = {
+	peerDependencyRules: {
+		allowAny: [
+			"node-fetch"
+		]
+	}
+};
+const pkg = {
+	name: name,
+	type: type,
+	version: version,
+	packageManager: packageManager,
+	description: description,
+	author: author,
+	license: license,
+	homepage: homepage,
+	repository: repository,
+	bugs: bugs,
+	keywords: keywords,
+	exports: exports,
+	main: main$1,
+	module: module,
+	types: types,
+	bin: bin,
+	files: files,
+	engines: engines,
+	scripts: scripts,
+	publishConfig: publishConfig,
+	directories: directories,
+	peerDependencies: peerDependencies,
+	peerDependenciesMeta: peerDependenciesMeta,
+	dependencies: dependencies,
+	devDependencies: devDependencies,
+	pnpm: pnpm
+};
 
 const logger = new Log();
 async function main() {
   var _a;
+  const { name, version } = pkg;
   updateNotifier({ pkg: { name, version } }).notify();
   process.removeAllListeners("SIGINT");
   (_a = env).NODE_ENV ?? (_a.NODE_ENV = "development");
@@ -42,6 +179,18 @@ async function main() {
   cli.command("serve").alias("dev").description("Start development server").action((_options) => {
     Config.loadConfig({}).then((ctx) => new Serve(ctx).run());
   });
+  cli.command("test").description("Run tests").option("--abort-on-fail", "Abort the test suite on first failure").option("--exit-on-finish", "Exit the test suite after all tests have run").action((options) => {
+    env.NODE_ENV = "test";
+    Config.loadConfig({}).then((ctx) => {
+      if (options.abortOnFail) {
+        ctx.test.abortOnFail = true;
+      }
+      if (options.exitOnFinish) {
+        ctx.test.exitOnFinish = true;
+      }
+      new Test(ctx).run();
+    });
+  });
   cli.command("create").description("Create the plugin template").action((_options) => {
     logger.error("The create not yet implemented");
   });

package/dist/index.d.mts

@@ -1,6 +1,7 @@
 import { Hookable } from 'hookable';
 import * as esbuild from 'esbuild';
 import { BuildOptions } from 'esbuild';
+import * as child_process from 'child_process';
 
 /**
  * Logger
@@ -10,6 +11,7 @@ declare class Log {
     constructor(config?: Config$1);
     private formatArgs;
     private logArgs;
+    log(...args: any[]): void;
     error(...args: any[]): void;
     warn(...args: any[]): void;
     tip(...args: any[]): void;
@@ -178,7 +180,7 @@ interface Config$1 {
      *
      * 一些可用的占位符请参阅 Context.templateData。
      *
-     * @default `https://github.com/{{owner}}/{{repo}}/release/download/release/update.json`
+     * @default `https://github.com/{{owner}}/{{repo}}/releaser/download/release/{{updateJson}}`
      *
      * @see {@link Context.templateData}
      */
@@ -205,6 +207,14 @@ interface Config$1 {
      * 发布相关配置。
      */
     release: ReleaseConfig;
+    /**
+     * Configurations required to run the test.
+     *
+     * 测试相关配置。
+     *
+     * Test is a variant of server, so it is not a separate hooks.
+     */
+    test: TestConfig;
     /**
      * Level of the log.
      *
@@ -522,14 +532,19 @@ interface ReleaseConfig {
     /**
      * Changelog.
      *
-     * If a string is provided, it must be command line
-     * and with changelog output to stdout.
+     * - "conventional-changelog": use conventional-changelog with angular preset,
+     *    you must install "conventional-changelog" as an peer dependency.
+     * - string: a command line with changelog output to stdout.
+     *
+     * 变更日志。
      *
-     * 如果提供了字符串，则必须为命令行，且变更日志输出到stdout
+     * - "conventional-changelog": 使用约定式变更日志，使用 angular 预设，
+     *   你需要手动安装 conventional-changelog 作为依赖项。
+     * - string: 命令行，变更日志输出到 stdout
      *
      * @default "git log {{previousTag}}..{{currentTag}}"
      */
-    changelog: string | ((ctx: Context) => string);
+    changelog: "conventional-changelog" | string | ((ctx: Context) => string);
     /**
      * Release to GitHub.
      */
@@ -580,6 +595,8 @@ interface ReleaseConfig {
     };
     /**
      * Release to Gitee
+     *
+     * @todo Not implemented yet
      */
     gitee: ReleaseConfig["github"];
     hooks: Partial<ReleaseHooks>;
@@ -589,7 +606,90 @@ interface ReleaseHooks {
     "release:push": (ctx: Context) => void | Promise<void>;
     "release:done": (ctx: Context) => void | Promise<void>;
 }
-interface Hooks extends BuildHooks, ServeHooks, ReleaseHooks {
+interface TestConfig {
+    /**
+     * The test source code directories, starting from the root directory of the project.
+     * All `*.spec.js` files in these directories will be executed.
+     * The files will be sorted by alphabetical order.
+     *
+     * 测试源码目录，从项目的根目录开始。
+     * 这些目录中的所有 `*.spec.js` 文件将被执行。
+     * 文件将按字母顺序排序。
+     *
+     * @default "test/"
+     */
+    entries: string | string[];
+    /**
+     * The default preferences for the test.
+     * These preferences will be set before the test starts.
+     *
+     * 测试的默认首选项。
+     * 这些首选项将在测试开始前设置。
+     */
+    prefs: Record<string, string | boolean | number>;
+    /**
+     * Port for the test server.
+     *
+     * 测试服务器的端口。
+     *
+     * @default 9876
+     */
+    port: number;
+    /**
+     * Abort the test when the first test fails.
+     *
+     * 当第一个测试失败时中止测试。
+     *
+     * @default false
+     */
+    abortOnFail: boolean;
+    /**
+     * Exit Zotero when the test is finished.
+     *
+     * 测试完成后退出 Zotero。
+     *
+     * @default false
+     */
+    exitOnFinish: boolean;
+    headless: boolean;
+    /**
+     * The delay time before running the test. Make sure the plugin is fully loaded before running the test.
+     *
+     * 运行测试前的延迟时间。确保插件在运行测试前完全加载。
+     *
+     * @default 1000
+     */
+    startupDelay: number;
+    /**
+     * Function string that returns the initialization status of the plugin.
+     *
+     * If set, the test will wait until the function returns true before running the test.
+     *
+     * 返回插件初始化状态的函数字符串。
+     *
+     * 如果设置，测试将等待函数返回 true 后再运行测试。
+     *
+     * @default "()=>true"
+     *
+     * @example
+     * ```js
+     * () => !!Zotero.BetterNotes.data.initialized
+     * ```
+     */
+    waitForPlugin: string;
+    hooks: Partial<TestHooks>;
+}
+interface TestHooks {
+    "test:init": (ctx: Context) => void | Promise<void>;
+    "test:prebuild": (ctx: Context) => void | Promise<void>;
+    "test:listen": (ctx: Context) => void | Promise<void>;
+    "test:mkdir": (ctx: Context) => void | Promise<void>;
+    "test:copyAssets": (ctx: Context) => void | Promise<void>;
+    "test:bundleTests": (ctx: Context) => void | Promise<void>;
+    "test:run": (ctx: Context) => void | Promise<void>;
+    "test:done": (ctx: Context) => void | Promise<void>;
+}
+interface Hooks extends BuildHooks, ServeHooks, ReleaseHooks, TestHooks {
 }
 
 type RecursivePartial<T> = {
@@ -680,9 +780,9 @@ declare class Release extends Base {
      */
     run(): Promise<void>;
     getConventionalChangelog(): Promise<string>;
-    getGitLog(currentTag: string): string;
-    getFilteredChangelog(rawLog: string, commitMessage: string): string;
-    getChangelog(): string;
+    getGitLog(): string;
+    getFilteredChangelog(rawLog: string): string;
+    getChangelog(): Promise<string>;
     private isEnabled;
     get resolvedCommitMessage(): string;
 }
@@ -701,9 +801,45 @@ declare class Serve extends Base {
     exit: () => never;
 }
 
+declare class Test extends Base {
+    private builder;
+    private _profileDir?;
+    private _dataDir?;
+    private _testPluginDir?;
+    private _testPluginRef;
+    private _testPluginID;
+    private _testBuildDir?;
+    private _server?;
+    private _process?;
+    get startArgs(): string[];
+    constructor(ctx: Context);
+    run(): Promise<void>;
+    prepareDir(): Promise<void>;
+    createManifest(): Promise<void>;
+    createBootstrap(): Promise<void>;
+    createTestResources(): Promise<void>;
+    bundleTests(): Promise<void>;
+    startTestServer(): Promise<void>;
+    handleTestUpdate(body: {
+        type: "start" | "suite" | "suite end" | "pending" | "pass" | "fail" | "end";
+        data?: {
+            title: string;
+            str: string;
+            duration?: number;
+            stack?: string;
+        };
+    }): Promise<void>;
+    prepareHeadless(): Promise<void>;
+    installXvfb(): Promise<void>;
+    installZoteroLinux(): Promise<void>;
+    startZoteroHeadless(): Promise<void>;
+    startZotero(): Promise<child_process.ChildProcessWithoutNullStreams>;
+    exit(status?: number): Promise<void>;
+}
+
 declare const Config: {
     defineConfig: typeof defineConfig;
     loadConfig: typeof loadConfig;
 };
 
-export { Build, Config, Release, Serve, defineConfig };
+export { Build, Config, Release, Serve, Test, defineConfig };

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 import { Hookable } from 'hookable';
 import * as esbuild from 'esbuild';
 import { BuildOptions } from 'esbuild';
+import * as child_process from 'child_process';
 
 /**
  * Logger
@@ -10,6 +11,7 @@ declare class Log {
     constructor(config?: Config$1);
     private formatArgs;
     private logArgs;
+    log(...args: any[]): void;
     error(...args: any[]): void;
     warn(...args: any[]): void;
     tip(...args: any[]): void;
@@ -178,7 +180,7 @@ interface Config$1 {
      *
      * 一些可用的占位符请参阅 Context.templateData。
      *
-     * @default `https://github.com/{{owner}}/{{repo}}/release/download/release/update.json`
+     * @default `https://github.com/{{owner}}/{{repo}}/releaser/download/release/{{updateJson}}`
      *
      * @see {@link Context.templateData}
      */
@@ -205,6 +207,14 @@ interface Config$1 {
      * 发布相关配置。
      */
     release: ReleaseConfig;
+    /**
+     * Configurations required to run the test.
+     *
+     * 测试相关配置。
+     *
+     * Test is a variant of server, so it is not a separate hooks.
+     */
+    test: TestConfig;
     /**
      * Level of the log.
      *
@@ -522,14 +532,19 @@ interface ReleaseConfig {
     /**
      * Changelog.
      *
-     * If a string is provided, it must be command line
-     * and with changelog output to stdout.
+     * - "conventional-changelog": use conventional-changelog with angular preset,
+     *    you must install "conventional-changelog" as an peer dependency.
+     * - string: a command line with changelog output to stdout.
+     *
+     * 变更日志。
      *
-     * 如果提供了字符串，则必须为命令行，且变更日志输出到stdout
+     * - "conventional-changelog": 使用约定式变更日志，使用 angular 预设，
+     *   你需要手动安装 conventional-changelog 作为依赖项。
+     * - string: 命令行，变更日志输出到 stdout
      *
      * @default "git log {{previousTag}}..{{currentTag}}"
      */
-    changelog: string | ((ctx: Context) => string);
+    changelog: "conventional-changelog" | string | ((ctx: Context) => string);
     /**
      * Release to GitHub.
      */
@@ -580,6 +595,8 @@ interface ReleaseConfig {
     };
     /**
      * Release to Gitee
+     *
+     * @todo Not implemented yet
      */
     gitee: ReleaseConfig["github"];
     hooks: Partial<ReleaseHooks>;
@@ -589,7 +606,90 @@ interface ReleaseHooks {
     "release:push": (ctx: Context) => void | Promise<void>;
     "release:done": (ctx: Context) => void | Promise<void>;
 }
-interface Hooks extends BuildHooks, ServeHooks, ReleaseHooks {
+interface TestConfig {
+    /**
+     * The test source code directories, starting from the root directory of the project.
+     * All `*.spec.js` files in these directories will be executed.
+     * The files will be sorted by alphabetical order.
+     *
+     * 测试源码目录，从项目的根目录开始。
+     * 这些目录中的所有 `*.spec.js` 文件将被执行。
+     * 文件将按字母顺序排序。
+     *
+     * @default "test/"
+     */
+    entries: string | string[];
+    /**
+     * The default preferences for the test.
+     * These preferences will be set before the test starts.
+     *
+     * 测试的默认首选项。
+     * 这些首选项将在测试开始前设置。
+     */
+    prefs: Record<string, string | boolean | number>;
+    /**
+     * Port for the test server.
+     *
+     * 测试服务器的端口。
+     *
+     * @default 9876
+     */
+    port: number;
+    /**
+     * Abort the test when the first test fails.
+     *
+     * 当第一个测试失败时中止测试。
+     *
+     * @default false
+     */
+    abortOnFail: boolean;
+    /**
+     * Exit Zotero when the test is finished.
+     *
+     * 测试完成后退出 Zotero。
+     *
+     * @default false
+     */
+    exitOnFinish: boolean;
+    headless: boolean;
+    /**
+     * The delay time before running the test. Make sure the plugin is fully loaded before running the test.
+     *
+     * 运行测试前的延迟时间。确保插件在运行测试前完全加载。
+     *
+     * @default 1000
+     */
+    startupDelay: number;
+    /**
+     * Function string that returns the initialization status of the plugin.
+     *
+     * If set, the test will wait until the function returns true before running the test.
+     *
+     * 返回插件初始化状态的函数字符串。
+     *
+     * 如果设置，测试将等待函数返回 true 后再运行测试。
+     *
+     * @default "()=>true"
+     *
+     * @example
+     * ```js
+     * () => !!Zotero.BetterNotes.data.initialized
+     * ```
+     */
+    waitForPlugin: string;
+    hooks: Partial<TestHooks>;
+}
+interface TestHooks {
+    "test:init": (ctx: Context) => void | Promise<void>;
+    "test:prebuild": (ctx: Context) => void | Promise<void>;
+    "test:listen": (ctx: Context) => void | Promise<void>;
+    "test:mkdir": (ctx: Context) => void | Promise<void>;
+    "test:copyAssets": (ctx: Context) => void | Promise<void>;
+    "test:bundleTests": (ctx: Context) => void | Promise<void>;
+    "test:run": (ctx: Context) => void | Promise<void>;
+    "test:done": (ctx: Context) => void | Promise<void>;
+}
+interface Hooks extends BuildHooks, ServeHooks, ReleaseHooks, TestHooks {
 }
 
 type RecursivePartial<T> = {
@@ -680,9 +780,9 @@ declare class Release extends Base {
      */
     run(): Promise<void>;
     getConventionalChangelog(): Promise<string>;
-    getGitLog(currentTag: string): string;
-    getFilteredChangelog(rawLog: string, commitMessage: string): string;
-    getChangelog(): string;
+    getGitLog(): string;
+    getFilteredChangelog(rawLog: string): string;
+    getChangelog(): Promise<string>;
     private isEnabled;
     get resolvedCommitMessage(): string;
 }
@@ -701,9 +801,45 @@ declare class Serve extends Base {
     exit: () => never;
 }
 
+declare class Test extends Base {
+    private builder;
+    private _profileDir?;
+    private _dataDir?;
+    private _testPluginDir?;
+    private _testPluginRef;
+    private _testPluginID;
+    private _testBuildDir?;
+    private _server?;
+    private _process?;
+    get startArgs(): string[];
+    constructor(ctx: Context);
+    run(): Promise<void>;
+    prepareDir(): Promise<void>;
+    createManifest(): Promise<void>;
+    createBootstrap(): Promise<void>;
+    createTestResources(): Promise<void>;
+    bundleTests(): Promise<void>;
+    startTestServer(): Promise<void>;
+    handleTestUpdate(body: {
+        type: "start" | "suite" | "suite end" | "pending" | "pass" | "fail" | "end";
+        data?: {
+            title: string;
+            str: string;
+            duration?: number;
+            stack?: string;
+        };
+    }): Promise<void>;
+    prepareHeadless(): Promise<void>;
+    installXvfb(): Promise<void>;
+    installZoteroLinux(): Promise<void>;
+    startZoteroHeadless(): Promise<void>;
+    startZotero(): Promise<child_process.ChildProcessWithoutNullStreams>;
+    exit(status?: number): Promise<void>;
+}
+
 declare const Config: {
     defineConfig: typeof defineConfig;
     loadConfig: typeof loadConfig;
 };
 
-export { Build, Config, Release, Serve, defineConfig };
+export { Build, Config, Release, Serve, Test, defineConfig };

package/dist/index.mjs

@@ -1,4 +1,4 @@
-export { a as Build, C as Config, R as Release, S as Serve, d as defineConfig } from './shared/zotero-plugin-scaffold.c7c8af0c.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.dad9978d.mjs';
 import 'node:path';
 import 'c12';
 import 'es-toolkit';
@@ -14,7 +14,10 @@ import 'replace-in-file';
 import 'web-ext';
 import 'node:crypto';
 import 'node:child_process';
-import 'conventional-changelog';
 import 'bumpp';
 import 'chokidar';
 import 'node:fs';
+import 'node:fs/promises';
+import 'node:http';
+import 'fs-extra/esm';
+import 'xvfb-ts';