zotero-plugin-scaffold 0.1.8-beta.2 → 0.2.0-beta.10

package/dist/chunks/github.mjs

@@ -1,27 +1,30 @@
+import { readFile, stat } from 'node:fs/promises';
 import { join, basename } from 'node:path';
 import { env } from 'node:process';
-import fs from 'fs-extra';
-import { globbySync } from 'globby';
 import mime from 'mime';
 import { Octokit } from 'octokit';
+import { globSync, glob } from 'tinyglobby';
 import { isCI } from 'std-env';
-import { a as Base } from '../shared/zotero-plugin-scaffold.ac50adf5.mjs';
+import { B as Base } from '../shared/zotero-plugin-scaffold.802444a9.mjs';
 import 'c12';
 import 'es-toolkit';
+import 'fs-extra/esm';
 import 'hookable';
 import 'node:readline';
 import 'chalk';
+import '../shared/zotero-plugin-scaffold.77c9802c.mjs';
+import 'adm-zip';
 import 'esbuild';
-import 'replace-in-file';
-import 'web-ext';
 import 'node:crypto';
+import 'node:fs';
 import 'node:child_process';
 import 'bumpp';
 import 'chokidar';
-import 'node:fs';
-import 'node:fs/promises';
+import 'node:net';
+import 'node:buffer';
+import 'node:domain';
+import 'node:events';
 import 'node:http';
-import 'fs-extra/esm';
 import 'xvfb-ts';
 
 var __defProp$1 = Object.defineProperty;
@@ -38,7 +41,7 @@ class ReleaseBase extends Base {
   }
   checkFiles() {
     const { dist } = this.ctx;
-    if (globbySync(`${dist}/*.xpi`).length === 0) {
+    if (globSync(`${dist}/*.xpi`).length === 0) {
       throw new Error("No xpi file found, are you sure you have run build?");
     }
   }
@@ -113,10 +116,10 @@ class GitHub extends ReleaseBase {
     return await this.client.rest.repos.uploadReleaseAsset({
       ...this.remote,
       release_id: releaseID,
-      data: fs.readFileSync(asset),
+      data: await readFile(asset),
       headers: {
         "content-type": mime.getType(asset) || "application/octet-stream",
-        "content-length": fs.statSync(asset).size
+        "content-length": (await stat(asset)).size
       },
       name: basename(asset)
     }).then((res) => {
@@ -131,7 +134,7 @@ class GitHub extends ReleaseBase {
       return;
     }
     const { dist, version } = this.ctx;
-    const assets = globbySync(`${dist}/update*.json`).map((p) => basename(p));
+    const assets = (await glob(`${dist}/update*.json`)).map((p) => basename(p));
     const release = await this.getReleaseByTag(updater) ?? await this.createRelease({
       ...this.remote,
       tag_name: updater,

package/dist/cli.mjs

@@ -1,34 +1,38 @@
 #!/usr/bin/env node
 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, B as Build, S as Serve, T as Test, R as Release } from './shared/zotero-plugin-scaffold.ac50adf5.mjs';
-import 'node:path';
+import { E as ExitSignals, l as logger, C as Config, a as Build, S as Serve, T as Test, R as Release } from './shared/zotero-plugin-scaffold.802444a9.mjs';
+import { readFile, writeFile } from 'node:fs/promises';
+import { pathExists, ensureFile } from 'fs-extra';
+import tinyUpdateNotifier from 'tiny-update-notifier';
 import 'c12';
 import 'es-toolkit';
-import 'fs-extra';
+import 'fs-extra/esm';
 import 'hookable';
 import 'node:readline';
 import 'chalk';
 import 'std-env';
+import './shared/zotero-plugin-scaffold.77c9802c.mjs';
+import 'tinyglobby';
+import 'node:path';
+import 'adm-zip';
 import 'esbuild';
-import 'globby';
-import 'replace-in-file';
-import 'web-ext';
 import 'node:crypto';
+import 'node:fs';
 import 'node:child_process';
 import 'bumpp';
 import 'chokidar';
-import 'node:fs';
-import 'node:fs/promises';
+import 'node:net';
+import 'node:buffer';
+import 'node:domain';
+import 'node:events';
 import 'node:http';
-import 'fs-extra/esm';
 import 'xvfb-ts';
 
 const name = "zotero-plugin-scaffold";
 const type = "module";
-const version = "0.1.8-beta.2";
-const packageManager = "pnpm@9.14.4";
+const version = "0.2.0-beta.10";
+const packageManager = "pnpm@9.15.0";
 const description = "A scaffold for Zotero plugin development.";
 const author = "northword";
 const license = "AGPL-3.0-or-later";
@@ -96,42 +100,33 @@ const peerDependenciesMeta = {
 };
 const dependencies = {
 	"@commander-js/extra-typings": "^12.1.0",
-	"@inquirer/prompts": "^7.0.0",
-	bumpp: "^9.7.1",
+	"adm-zip": "^0.5.16",
+	bumpp: "^9.9.1",
 	c12: "^2.0.1",
 	chalk: "^5.3.0",
 	chokidar: "^4.0.1",
 	commander: "^12.1.0",
-	"es-toolkit": "^1.25.2",
+	"es-toolkit": "^1.29.0",
 	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",
+	"std-env": "^3.8.0",
+	"tiny-update-notifier": "^2.0.0",
+	tinyglobby: "^0.2.10",
 	"xvfb-ts": "^1.1.0"
 };
 const devDependencies = {
-	"@antfu/eslint-config": "^3.8.0",
+	"@antfu/eslint-config": "^3.11.2",
+	"@types/adm-zip": "^0.5.7",
 	"@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",
+	"@types/node": "^22.10.2",
+	eslint: "^9.16.0",
+	"eslint-plugin-format": "^0.1.3",
 	typescript: "^5.7.2",
 	unbuild: "^2.0.0"
 };
-const pnpm = {
-	peerDependencyRules: {
-		allowAny: [
-			"node-fetch"
-		]
-	}
-};
 const pkg = {
 	name: name,
 	type: type,
@@ -157,16 +152,40 @@ const pkg = {
 	peerDependencies: peerDependencies,
 	peerDependenciesMeta: peerDependenciesMeta,
 	dependencies: dependencies,
-	devDependencies: devDependencies,
-	pnpm: pnpm
+	devDependencies: devDependencies
 };
 
-const logger = new Log();
+async function checkGitIgnore() {
+  if (!pathExists(".git"))
+    return;
+  await ensureFile(".gitignore");
+  const contents = (await readFile(".gitignore", "utf-8")).split("\n");
+  const ignores = ["node_modules", ".env", ".scaffold"];
+  ignores.forEach((ignore) => {
+    if (!contents.includes(ignore))
+      contents.push(ignore);
+  });
+  await writeFile(".gitignore", contents.join("\n"));
+}
+
+function updateNotifier(name, version) {
+  tinyUpdateNotifier({ pkg: { name, version } }).then((update) => {
+    if (update) {
+      const notify = () => {
+        logger.newLine();
+        logger.info(`New version of ${update.name} available!`);
+        logger.info(`Update: ${update.current} \u2192 ${update.latest} (${update.type})`);
+        logger.newLine();
+      };
+      ExitSignals.forEach((sig) => process.once(sig, notify));
+    }
+  }).catch();
+}
+
 async function main() {
   var _a;
   const { name, version } = pkg;
-  updateNotifier({ pkg: { name, version } }).notify();
-  process.removeAllListeners("SIGINT");
+  updateNotifier(name, version);
   (_a = env).NODE_ENV ?? (_a.NODE_ENV = "development");
   const cli = new Command();
   cli.version(version).usage("<command> [options]");
@@ -212,7 +231,9 @@ async function main() {
   });
   cli.parse();
 }
-main().catch(onError);
+main().then(() => {
+  checkGitIgnore();
+}).catch(onError);
 process.on("uncaughtException", onError);
 function onError(err) {
   logger.error(err);

package/dist/index.d.mts

@@ -1,14 +1,27 @@
 import { Hookable } from 'hookable';
 import * as esbuild from 'esbuild';
 import { BuildOptions } from 'esbuild';
-import * as child_process from 'child_process';
 
+/**
+ * Log level
+ */
+declare enum LOG_LEVEL {
+    trace = 0,
+    debug = 1,
+    info = 2,
+    warn = 3,
+    error = 4
+}
+type LogLevelType = keyof typeof LOG_LEVEL;
 /**
  * Logger
  */
 declare class Log {
+    private static instance;
     private logLevel;
-    constructor(config?: Config$1);
+    constructor(level?: LOG_LEVEL);
+    static getInstance(): Log;
+    setLogLevel(level: LogLevelType): void;
     private formatArgs;
     private logArgs;
     log(...args: any[]): void;
@@ -222,7 +235,7 @@ interface Config$1 {
      *
      * @default "info"
      */
-    logLevel: "trace" | "debug" | "info" | "warn" | "error";
+    logLevel: LogLevelType;
 }
 interface BuildConfig {
     /**
@@ -382,7 +395,6 @@ interface BuildHooks {
     "build:copyAssets": (ctx: Context) => void | Promise<void>;
     "build:makeManifest": (ctx: Context) => void | Promise<void>;
     "build:fluent": (ctx: Context) => void | Promise<void>;
-    "build:replace": (ctx: Context) => void | Promise<void>;
     "build:bundle": (ctx: Context) => void | Promise<void>;
     "build:pack": (ctx: Context) => void | Promise<void>;
     "build:makeUpdateJSON": (ctx: Context) => void | Promise<void>;
@@ -616,7 +628,7 @@ interface TestConfig {
      * 这些目录中的所有 `*.spec.js` 文件将被执行。
      * 文件将按字母顺序排序。
      *
-     * @default "test/"
+     * @default "test"
      */
     entries: string | string[];
     /**
@@ -627,14 +639,16 @@ interface TestConfig {
      * 这些首选项将在测试开始前设置。
      */
     prefs: Record<string, string | boolean | number>;
-    /**
-     * Port for the test server.
-     *
-     * 测试服务器的端口。
-     *
-     * @default 9876
-     */
-    port: number;
+    mocha: {
+        /**
+         * The timeout of the test.
+         *
+         * 测试的超时时间。
+         *
+         * @default 10000
+         */
+        timeout: number;
+    };
     /**
      * Abort the test when the first test fails.
      *
@@ -651,6 +665,19 @@ interface TestConfig {
      * @default false
      */
     exitOnFinish: boolean;
+    /**
+     * Run Zotero in deadless mode.
+     *
+     * - Supported for Linux only.
+     * - Default to true when in CI environments.
+     *
+     * 使用无头模式运行 Zotero。
+     *
+     * - 仅支持 Linux
+     * - 在 CI 模式下，默认为 true
+     *
+     * @default false
+     */
     headless: boolean;
     /**
      * The delay time before running the test. Make sure the plugin is fully loaded before running the test.
@@ -669,7 +696,7 @@ interface TestConfig {
      *
      * 如果设置，测试将等待函数返回 true 后再运行测试。
      *
-     * @default "()=>true"
+     * @default "() => true"
      *
      * @example
      * ```js
@@ -677,17 +704,20 @@ interface TestConfig {
      * ```
      */
     waitForPlugin: string;
+    /**
+     * @todo not
+     */
+    watch: boolean;
     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>;
+    "test:exit": (ctx: Context) => void;
 }
 interface Hooks extends BuildHooks, ServeHooks, ReleaseHooks, TestHooks {
 }
@@ -751,21 +781,15 @@ declare class Build extends Base {
     /**
      * Copys files in `Config.build.assets` to `Config.dist`
      */
-    copyAssets(): void;
+    makeAssets(): Promise<void>;
     /**
      * Override user's manifest
      *
-     * Write `applications.gecko` to `manifest.json`
-     *
-     */
-    makeManifest(): void;
-    /**
-     * Replace all `placeholder.key` to `placeholder.value` for all files in `dist`
      */
-    replaceString(): void;
-    prepareLocaleFiles(): void;
+    makeManifest(): Promise<void>;
+    prepareLocaleFiles(): Promise<void>;
     esbuild(): Promise<esbuild.BuildResult<esbuild.BuildOptions>[]> | undefined;
-    makeUpdateJson(): void;
+    makeUpdateJson(): Promise<void>;
     pack(): Promise<void>;
 }
 
@@ -790,6 +814,8 @@ declare class Release extends Base {
 declare class Serve extends Base {
     private builder;
     private runner?;
+    private _zoteroBinPath?;
+    private _profilePath?;
     constructor(ctx: Context);
     run(): Promise<void>;
     /**
@@ -799,29 +825,24 @@ declare class Serve extends Base {
     onChange(path: string): Promise<void>;
     reload(): Promise<void>;
     exit: () => never;
+    private onZoteroExit;
+    get zoteroBinPath(): string;
+    get profilePath(): string;
+    get dataDir(): string;
 }
 
 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[];
+    private runner?;
+    private communicator;
     constructor(ctx: Context);
     run(): Promise<void>;
-    prepareDir(): Promise<void>;
-    createManifest(): Promise<void>;
-    createBootstrap(): Promise<void>;
-    createTestResources(): Promise<void>;
+    createTestPlugin(): Promise<void>;
+    copyTestLibraries(): Promise<void>;
     bundleTests(): Promise<void>;
-    startTestServer(): Promise<void>;
-    handleTestUpdate(body: {
-        type: "start" | "suite" | "suite end" | "pending" | "pass" | "fail" | "end";
+    startHttpServer(): Promise<void>;
+    onHttpDataUpdated(body: {
+        type: "start" | "suite" | "suite end" | "pending" | "pass" | "fail" | "end" | "debug";
         data?: {
             title: string;
             str: string;
@@ -829,12 +850,19 @@ declare class Test extends Base {
             stack?: string;
         };
     }): Promise<void>;
-    prepareHeadless(): Promise<void>;
-    installXvfb(): Promise<void>;
-    installZoteroLinux(): Promise<void>;
+    watch(): Promise<void>;
+    onCodeChanged(_path: string): Promise<void>;
     startZoteroHeadless(): Promise<void>;
-    startZotero(): Promise<child_process.ChildProcessWithoutNullStreams>;
-    exit(status?: number): Promise<void>;
+    startZotero(): Promise<void>;
+    private exit;
+    private get zoteroBinPath();
+    private get profilePath();
+    private get dataDir();
+    private get testPluginDir();
+    private get cacheDir();
+    private get testPluginRef();
+    private get testPluginID();
+    private get prefs();
 }
 
 declare const Config: {

package/dist/index.d.ts

@@ -1,14 +1,27 @@
 import { Hookable } from 'hookable';
 import * as esbuild from 'esbuild';
 import { BuildOptions } from 'esbuild';
-import * as child_process from 'child_process';
 
+/**
+ * Log level
+ */
+declare enum LOG_LEVEL {
+    trace = 0,
+    debug = 1,
+    info = 2,
+    warn = 3,
+    error = 4
+}
+type LogLevelType = keyof typeof LOG_LEVEL;
 /**
  * Logger
  */
 declare class Log {
+    private static instance;
     private logLevel;
-    constructor(config?: Config$1);
+    constructor(level?: LOG_LEVEL);
+    static getInstance(): Log;
+    setLogLevel(level: LogLevelType): void;
     private formatArgs;
     private logArgs;
     log(...args: any[]): void;
@@ -222,7 +235,7 @@ interface Config$1 {
      *
      * @default "info"
      */
-    logLevel: "trace" | "debug" | "info" | "warn" | "error";
+    logLevel: LogLevelType;
 }
 interface BuildConfig {
     /**
@@ -382,7 +395,6 @@ interface BuildHooks {
     "build:copyAssets": (ctx: Context) => void | Promise<void>;
     "build:makeManifest": (ctx: Context) => void | Promise<void>;
     "build:fluent": (ctx: Context) => void | Promise<void>;
-    "build:replace": (ctx: Context) => void | Promise<void>;
     "build:bundle": (ctx: Context) => void | Promise<void>;
     "build:pack": (ctx: Context) => void | Promise<void>;
     "build:makeUpdateJSON": (ctx: Context) => void | Promise<void>;
@@ -616,7 +628,7 @@ interface TestConfig {
      * 这些目录中的所有 `*.spec.js` 文件将被执行。
      * 文件将按字母顺序排序。
      *
-     * @default "test/"
+     * @default "test"
      */
     entries: string | string[];
     /**
@@ -627,14 +639,16 @@ interface TestConfig {
      * 这些首选项将在测试开始前设置。
      */
     prefs: Record<string, string | boolean | number>;
-    /**
-     * Port for the test server.
-     *
-     * 测试服务器的端口。
-     *
-     * @default 9876
-     */
-    port: number;
+    mocha: {
+        /**
+         * The timeout of the test.
+         *
+         * 测试的超时时间。
+         *
+         * @default 10000
+         */
+        timeout: number;
+    };
     /**
      * Abort the test when the first test fails.
      *
@@ -651,6 +665,19 @@ interface TestConfig {
      * @default false
      */
     exitOnFinish: boolean;
+    /**
+     * Run Zotero in deadless mode.
+     *
+     * - Supported for Linux only.
+     * - Default to true when in CI environments.
+     *
+     * 使用无头模式运行 Zotero。
+     *
+     * - 仅支持 Linux
+     * - 在 CI 模式下，默认为 true
+     *
+     * @default false
+     */
     headless: boolean;
     /**
      * The delay time before running the test. Make sure the plugin is fully loaded before running the test.
@@ -669,7 +696,7 @@ interface TestConfig {
      *
      * 如果设置，测试将等待函数返回 true 后再运行测试。
      *
-     * @default "()=>true"
+     * @default "() => true"
      *
      * @example
      * ```js
@@ -677,17 +704,20 @@ interface TestConfig {
      * ```
      */
     waitForPlugin: string;
+    /**
+     * @todo not
+     */
+    watch: boolean;
     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>;
+    "test:exit": (ctx: Context) => void;
 }
 interface Hooks extends BuildHooks, ServeHooks, ReleaseHooks, TestHooks {
 }
@@ -751,21 +781,15 @@ declare class Build extends Base {
     /**
      * Copys files in `Config.build.assets` to `Config.dist`
      */
-    copyAssets(): void;
+    makeAssets(): Promise<void>;
     /**
      * Override user's manifest
      *
-     * Write `applications.gecko` to `manifest.json`
-     *
-     */
-    makeManifest(): void;
-    /**
-     * Replace all `placeholder.key` to `placeholder.value` for all files in `dist`
      */
-    replaceString(): void;
-    prepareLocaleFiles(): void;
+    makeManifest(): Promise<void>;
+    prepareLocaleFiles(): Promise<void>;
     esbuild(): Promise<esbuild.BuildResult<esbuild.BuildOptions>[]> | undefined;
-    makeUpdateJson(): void;
+    makeUpdateJson(): Promise<void>;
     pack(): Promise<void>;
 }
 
@@ -790,6 +814,8 @@ declare class Release extends Base {
 declare class Serve extends Base {
     private builder;
     private runner?;
+    private _zoteroBinPath?;
+    private _profilePath?;
     constructor(ctx: Context);
     run(): Promise<void>;
     /**
@@ -799,29 +825,24 @@ declare class Serve extends Base {
     onChange(path: string): Promise<void>;
     reload(): Promise<void>;
     exit: () => never;
+    private onZoteroExit;
+    get zoteroBinPath(): string;
+    get profilePath(): string;
+    get dataDir(): string;
 }
 
 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[];
+    private runner?;
+    private communicator;
     constructor(ctx: Context);
     run(): Promise<void>;
-    prepareDir(): Promise<void>;
-    createManifest(): Promise<void>;
-    createBootstrap(): Promise<void>;
-    createTestResources(): Promise<void>;
+    createTestPlugin(): Promise<void>;
+    copyTestLibraries(): Promise<void>;
     bundleTests(): Promise<void>;
-    startTestServer(): Promise<void>;
-    handleTestUpdate(body: {
-        type: "start" | "suite" | "suite end" | "pending" | "pass" | "fail" | "end";
+    startHttpServer(): Promise<void>;
+    onHttpDataUpdated(body: {
+        type: "start" | "suite" | "suite end" | "pending" | "pass" | "fail" | "end" | "debug";
         data?: {
             title: string;
             str: string;
@@ -829,12 +850,19 @@ declare class Test extends Base {
             stack?: string;
         };
     }): Promise<void>;
-    prepareHeadless(): Promise<void>;
-    installXvfb(): Promise<void>;
-    installZoteroLinux(): Promise<void>;
+    watch(): Promise<void>;
+    onCodeChanged(_path: string): Promise<void>;
     startZoteroHeadless(): Promise<void>;
-    startZotero(): Promise<child_process.ChildProcessWithoutNullStreams>;
-    exit(status?: number): Promise<void>;
+    startZotero(): Promise<void>;
+    private exit;
+    private get zoteroBinPath();
+    private get profilePath();
+    private get dataDir();
+    private get testPluginDir();
+    private get cacheDir();
+    private get testPluginRef();
+    private get testPluginID();
+    private get prefs();
 }
 
 declare const Config: {