zotero-plugin-scaffold 0.2.11 → 0.3.0

package/dist/cli.mjs

@@ -1,6 +1,6 @@
 import process from 'node:process';
 import { Command } from 'commander';
-import { E as ExitSignals, l as logger, C as Config, B as Build, S as Serve, T as Test, R as Release } from './shared/zotero-plugin-scaffold.Cogc0b_B.mjs';
+import { E as ExitSignals, l as logger, C as Config, B as Build, S as Serve, T as Test, R as Release } from './shared/zotero-plugin-scaffold.DWzaUAX4.mjs';
 import { readFile, writeFile } from 'node:fs/promises';
 import { pathExists, ensureFile } from 'fs-extra';
 import tinyUpdateNotifier from 'tiny-update-notifier';
@@ -9,7 +9,7 @@ import 'es-toolkit';
 import 'fs-extra/esm';
 import 'hookable';
 import 'node:readline';
-import 'chalk';
+import 'node:util';
 import 'std-env';
 import './shared/zotero-plugin-scaffold.v8dJZZ-v.mjs';
 import 'tinyglobby';
@@ -31,7 +31,7 @@ import 'node:http';
 import 'xvfb-ts';
 
 const name = "zotero-plugin-scaffold";
-const version = "0.2.11";
+const version = "0.3.0";
 const pkg = {
 	name: name,
 	version: version};

package/dist/index.d.mts

@@ -44,7 +44,7 @@ declare class Logger {
     debug(content: unknown, options?: LoggerOptions): void;
     success(content: unknown, options?: LoggerOptions): void;
     fail(content: unknown, options?: LoggerOptions): void;
-    ready(content: unknown): void;
+    ready(content: string): void;
     clear(): void;
     newLine(): void;
     /**

package/dist/index.mjs

@@ -1,11 +1,11 @@
-export { B as Build, C as Config, R as Release, S as Serve, T as Test, d as defineConfig } from './shared/zotero-plugin-scaffold.Cogc0b_B.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.DWzaUAX4.mjs';
 import 'c12';
 import 'es-toolkit';
 import 'fs-extra/esm';
 import 'hookable';
 import 'node:process';
 import 'node:readline';
-import 'chalk';
+import 'node:util';
 import 'std-env';
 import './shared/zotero-plugin-scaffold.v8dJZZ-v.mjs';
 import 'node:fs/promises';

package/dist/shared/{zotero-plugin-scaffold.Cogc0b_B.mjs → zotero-plugin-scaffold.DWzaUAX4.mjs}

@@ -4,7 +4,7 @@ import { readJsonSync, outputFile, emptyDir, copy, readJSON, outputJSON, move, w
 import { createHooks } from 'hookable';
 import process from 'node:process';
 import readline from 'node:readline';
-import chalk from 'chalk';
+import util from 'node:util';
 import { isDebug, isCI, isWindows, isMacOS, isLinux } from 'std-env';
 import { p as parseRepoUrl, d as dateFormat, t as template, b as toArray, a as replaceInFile } from './zotero-plugin-scaffold.v8dJZZ-v.mjs';
 import { createReadStream, existsSync } from 'node:fs';
@@ -26,6 +26,14 @@ import EventEmitter from 'node:events';
 import http from 'node:http';
 import { Xvfb } from 'xvfb-ts';
 
+const factory = (...formats) =>
+  new Proxy(util.styleText.bind(util, formats), {
+    get: (_, format) =>
+      util.inspect.colors[format] && factory(...formats, format),
+  });
+
+const styleText = factory();
+
 var LOG_LEVEL = /* @__PURE__ */ ((LOG_LEVEL2) => {
   LOG_LEVEL2[LOG_LEVEL2["TRACE"] = 0] = "TRACE";
   LOG_LEVEL2[LOG_LEVEL2["DEBUG"] = 1] = "DEBUG";
@@ -35,13 +43,13 @@ var LOG_LEVEL = /* @__PURE__ */ ((LOG_LEVEL2) => {
   return LOG_LEVEL2;
 })(LOG_LEVEL || {});
 const SYMBOLS = {
-  SUCCESS: chalk.green("\u2714"),
-  INFO: chalk.blue("\u2139"),
-  FAIL: chalk.red("\u2716"),
-  TIP: chalk.blue("\u2192"),
-  ERROR: chalk.bgRed(" ERROR "),
-  WARN: chalk.bgYellow(" WARN "),
-  DEBUG: chalk.grey("\u2699")};
+  SUCCESS: styleText.green("\u2714"),
+  INFO: styleText.blue("\u2139"),
+  FAIL: styleText.red("\u2716"),
+  TIP: styleText.blue("\u2192"),
+  ERROR: styleText.bgRed(" ERROR "),
+  WARN: styleText.bgYellow(" WARN "),
+  DEBUG: styleText.grey("\u2699")};
 const DEFAULT_OPTIONS = {
   SPACE: 0,
   NEW_LINE: false
@@ -118,7 +126,7 @@ class Logger {
     return String(content);
   }
   formatError(error) {
-    return `${chalk.red(error.name)}: ${chalk.red(error.message)}
+    return `${styleText.red(error.name)}: ${styleText.red(error.message)}
 ${error.stack}`;
   }
   /**
@@ -163,7 +171,7 @@ ${error.stack}`;
     this.logInternal(content, LOG_METHODS_CONFIG.fail, options);
   }
   ready(content) {
-    this.logInternal(chalk.green(content), LOG_METHODS_CONFIG.success);
+    this.logInternal(styleText.green(content), LOG_METHODS_CONFIG.success);
   }
   clear() {
     const blank = process.stdout.rows > 2 ? "\n".repeat(process.stdout.rows - 2) : "";
@@ -540,7 +548,7 @@ class Build extends Base {
     const t = /* @__PURE__ */ new Date();
     this.buildTime = dateFormat("YYYY-mm-dd HH:MM:SS", t);
     this.logger.info(
-      `Building version ${chalk.blue(version)} to ${chalk.blue(dist)} at ${chalk.blue(this.buildTime)} in ${chalk.blue(process.env.NODE_ENV)} mode.`
+      `Building version ${styleText.blue(version)} to ${styleText.blue(dist)} at ${styleText.blue(this.buildTime)} in ${styleText.blue(process.env.NODE_ENV)} mode.`
     );
     await this.ctx.hooks.callHook("build:init", this.ctx);
     await emptyDir(dist);
@@ -671,13 +679,13 @@ class Build extends Base {
           continue;
         }
         if (!allMessages.has(attrVal)) {
-          this.logger.warn(`HTML data-i10n-id '${chalk.blue(attrVal)}' in ${chalk.gray(htmlPath)} do not exist in any FTL message, skip to namespace it.`);
+          this.logger.warn(`HTML data-i10n-id '${styleText.blue(attrVal)}' in ${styleText.gray(htmlPath)} do not exist in any FTL message, skip to namespace it.`);
           continue;
         }
         messagesInHTML.add(attrVal);
         const namespacedAttr = `${namespace}-${attrVal}`;
         htmlContent = htmlContent.replace(matched, `${attrKey}="${namespacedAttr}"`);
-        this.logger.debug(`HTML data-i10n-id '${chalk.blue(attrVal)}' in ${chalk.gray(htmlPath)} is namespaced to ${chalk.blue(namespacedAttr)}.`);
+        this.logger.debug(`HTML data-i10n-id '${styleText.blue(attrVal)}' in ${styleText.gray(htmlPath)} is namespaced to ${styleText.blue(namespacedAttr)}.`);
       }
       if (build.fluent.prefixFluentMessages)
         await writeFile(htmlPath, htmlContent);
@@ -687,7 +695,7 @@ class Build extends Base {
         return;
       const missingLocales = [...messagesByLocale.entries()].filter(([_, messages]) => !messages.has(messageInHTML)).map(([locale]) => locale);
       if (missingLocales.length > 0) {
-        this.logger.warn(`HTML data-l10n-id '${chalk.blue(messageInHTML)}' is missing in locales: ${missingLocales.join(", ")}.`);
+        this.logger.warn(`HTML data-l10n-id '${styleText.blue(messageInHTML)}' is missing in locales: ${missingLocales.join(", ")}.`);
       }
     });
   }
@@ -721,17 +729,17 @@ class Build extends Base {
         for (const match of matchs) {
           const [matched, key] = match;
           if (key.startsWith(prefix)) {
-            this.logger.debug(`Pref key '${chalk.blue(key)}' is already starts with '${prefix}', skip prefixing it.`);
+            this.logger.debug(`Pref key '${styleText.blue(key)}' is already starts with '${prefix}', skip prefixing it.`);
             continue;
           } else if (key.startsWith("extensions.")) {
-            this.logger.warn(`Pref key '${chalk.blue(key)}' in ${chalk.gray(path)} starts with 'extensions.' but not '${chalk.blue(prefix)}', skip prefixing it.`);
+            this.logger.warn(`Pref key '${styleText.blue(key)}' in ${styleText.gray(path)} starts with 'extensions.' but not '${styleText.blue(prefix)}', skip prefixing it.`);
             continue;
           } else if (!(key in prefsWithPrefix) && !(key in prefsWithoutPrefix)) {
-            this.logger.warn(`Pref key '${chalk.blue(key)}' in ${chalk.gray(path)} is not found in prefs.js, skip prefixing it.`);
+            this.logger.warn(`Pref key '${styleText.blue(key)}' in ${styleText.gray(path)} is not found in prefs.js, skip prefixing it.`);
             continue;
           } else {
             const prefixed = `${prefix}.${key}`;
-            this.logger.debug(`Pref key '${chalk.blue(key)}' in ${chalk.gray(path)} is prefixed to ${chalk.blue(prefixed)}.`);
+            this.logger.debug(`Pref key '${styleText.blue(key)}' in ${styleText.gray(path)} is prefixed to ${styleText.blue(prefixed)}.`);
             content = content.replace(matched, `preference="${prefixed}"`);
           }
         }
@@ -1087,7 +1095,7 @@ class Release extends Base {
       conventionalChangelog({ releaseCount: 2, preset: "angular" }, { version }).on("data", (chunk) => {
         changelog += chunk.toString();
       }).on("end", () => {
-        changelog = changelog.split("\n").filter((line) => !line.match(/^## .*/)).join("\n").trim();
+        changelog = changelog.split("\n").filter((line) => !line.match(/^## .*/) || !line.match(/^# .*/)).join("\n").trim();
         resolve(changelog);
       }).on("error", (err) => {
         reject(err);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "zotero-plugin-scaffold",
   "type": "module",
-  "version": "0.2.11",
+  "version": "0.3.0",
   "description": "A scaffold for Zotero plugin development.",
   "author": "northword",
   "license": "AGPL-3.0-or-later",
@@ -23,20 +23,20 @@
   ],
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
+      "types": "./dist/index.d.mts",
       "import": "./dist/index.mjs"
     },
     "./cli": {
       "import": "./dist/cli.mjs"
     },
     "./vendor": {
-      "types": "./dist/vendor/index.d.ts",
+      "types": "./dist/vendor/index.d.mts",
       "import": "./dist/vendor/index.mjs"
     }
   },
   "main": "./dist/index.mjs",
   "module": "./dist/index.mjs",
-  "types": "./dist/index.d.ts",
+  "types": "./dist/index.d.mts",
   "bin": {
     "zotero-plugin": "./bin/zotero-plugin.mjs"
   },
@@ -45,7 +45,7 @@
     "dist"
   ],
   "engines": {
-    "node": ">=18.20.7"
+    "node": ">=22.8.0"
   },
   "publishConfig": {
     "access": "public",
@@ -67,7 +67,6 @@
     "adm-zip": "^0.5.16",
     "bumpp": "^10.0.3",
     "c12": "^3.0.2",
-    "chalk": "^5.4.1",
     "chokidar": "^4.0.3",
     "commander": "^13.1.0",
     "es-toolkit": "^1.32.0",
@@ -83,7 +82,8 @@
   "devDependencies": {
     "@commander-js/extra-typings": "^13.1.0",
     "@types/adm-zip": "^0.5.7",
-    "@types/fs-extra": "^11.0.4"
+    "@types/fs-extra": "^11.0.4",
+    "node-style-text": "^0.0.7"
   },
   "scripts": {
     "dev": "unbuild --stub",

package/dist/cli.d.ts

@@ -1,3 +0,0 @@
-declare function mainWithErrorHandler(): Promise<void>;
-
-export { mainWithErrorHandler as default };

package/dist/index.d.ts

@@ -1,931 +0,0 @@
-import { Hookable } from 'hookable';
-import * as esbuild from 'esbuild';
-import { BuildOptions } from 'esbuild';
-
-/**
- * Log level enumeration
- */
-declare enum LOG_LEVEL {
-    TRACE = 0,
-    DEBUG = 1,
-    INFO = 2,
-    WARN = 3,
-    ERROR = 4
-}
-type LogLevelType = keyof typeof LOG_LEVEL;
-interface LoggerOptions {
-    space?: number;
-    newLine?: boolean;
-}
-declare class Logger {
-    private static instance;
-    private currentLogLevel;
-    private constructor();
-    /**
-     * Determine the appropriate log level
-     */
-    private determineLogLevel;
-    static getInstance(): Logger;
-    setLogLevel(level: LogLevelType): void;
-    get level(): LOG_LEVEL;
-    /**
-     * Generic log formatting logic
-     */
-    private formatContent;
-    private formatError;
-    /**
-     * Core logging method
-     */
-    private logInternal;
-    error(content: unknown, options?: LoggerOptions): void;
-    warn(content: unknown, options?: LoggerOptions): void;
-    tip(content: unknown, options?: LoggerOptions): void;
-    info(content: unknown, options?: LoggerOptions): void;
-    debug(content: unknown, options?: LoggerOptions): void;
-    success(content: unknown, options?: LoggerOptions): void;
-    fail(content: unknown, options?: LoggerOptions): void;
-    ready(content: unknown): void;
-    clear(): void;
-    newLine(): void;
-    /**
-     * Direct passthrough to console.log
-     */
-    log(content: unknown): void;
-}
-
-interface Manifest {
-    [key: string]: any;
-    manifest_version: number;
-    name: string;
-    version: string;
-    description?: string;
-    homepage_url?: string;
-    author?: string;
-    icons?: Record<string, string>;
-    applications: {
-        zotero: {
-            id: string;
-            update_url: string;
-            strict_min_version?: string;
-            strict_max_version?: string;
-        };
-    };
-}
-
-/**
- * Update json
- * @see https://extensionworkshop.com/documentation/manage/updating-your-extension/
- */
-interface UpdateJSON {
-    addons: {
-        [addonID: string]: {
-            updates: Array<{
-                version: string;
-                update_link?: string;
-                /**
-                 * A cryptographic hash of the file pointed to by `update_link`.
-                 * This must be provided if `update_link` is not a secure URL.
-                 * If present, this must be a string beginning with either `sha256:` or `sha512:`,
-                 * followed by the hexadecimal-encoded hash of the matching type.
-                 */
-                update_hash?: string;
-                applications: {
-                    zotero: {
-                        strict_min_version?: string;
-                        strict_max_version?: string;
-                    };
-                    [application: string]: {
-                        strict_min_version?: string;
-                        strict_max_version?: string;
-                    };
-                };
-            }>;
-        };
-    };
-}
-
-interface Config$1 {
-    /**
-     * The source code directories.
-     *
-     * Can be multiple directories, and changes to these directories will be watched when `server` is running.
-     *
-     * 源码目录。
-     *
-     * 可以是多个目录，将在 `server` 运行时监听这些目录的变更。
-     *
-     * @default "src"
-     */
-    source: string | string[];
-    /**
-     * The build directories.
-     *
-     * Scaffold will store the code before packaging after the build at `${dist}/addon`.
-     * Store the packaging results at `${dist}/${package_json.name}.xpi`.
-     *
-     * 构建目录。
-     *
-     * 脚手架将在 `${dist}/addon` 存放构建后打包前的代码。
-     * 在 `${dist}/${xpiName}.xpi` 存放打包结果。
-     *
-     * @default ".scaffold/build"
-     */
-    dist: string;
-    /**
-     * The name of plugin.
-     *
-     * 插件名。
-     *
-     * @default package-json.name
-     *
-     */
-    name: string;
-    /**
-     * The ID of plugin.
-     *
-     * Usually in the form of an email address or UUID.
-     *
-     * 插件 ID。
-     *
-     * 通常是邮箱地址或UUID的形式。
-     *
-     * @default package-json.name
-     */
-    id: string;
-    /**
-     * namespace of plugin.
-     *
-     * This attribute is also used to prevent plugin conflicts,
-     * it may be used for plugin HTML element ids, preference prefixes,
-     * fluent filename prefixes, fluent message prefixes, etc.
-     *
-     * Unlike the plugin id, this value should be HTML ID and Fluent Message compliant,
-     * i.e.: contain at least one character and only letters and dashes.
-     *
-     * 插件命名空间。
-     *
-     * 这个属性也用于防止插件冲突，它可能被用于插件的 HTML 元素 id，
-     * 首选项前缀，Fluent 文件名前缀、Fluent message 前缀等。
-     *
-     * 与插件 ID 不同的是，这个值应是符合 HTML ID 和 Fluent Message 规范的，
-     * 即：至少包含一个字符，仅包含字母和短横线。
-     *
-     * @default kebabCase(name)
-     */
-    namespace: string;
-    /**
-     * XPI filename.
-     *
-     * XPI 文件名。
-     *
-     * @default kebabCase(name)
-     */
-    xpiName: string;
-    /**
-     * The download link of XPI.
-     *
-     * Some placeholders are available, see Context.templateData.
-     *
-     * XPI 文件的地址。
-     *
-     * 一些可用的占位符请参阅 Context.templateData。
-     *
-     * @default `https://github.com/{{owner}}/{{repo}}/release/download/v{{version}}/{{xpiName}}.xpi`
-     *
-     * @see {@link Context.templateData}
-     */
-    xpiDownloadLink: string;
-    /**
-     * The uri of update.json.
-     *
-     * Some placeholders are available, see Context.templateData.
-     *
-     * update.json 文件的地址。
-     *
-     * 一些可用的占位符请参阅 Context.templateData。
-     *
-     * @default `https://github.com/{{owner}}/{{repo}}/releaser/download/release/{{updateJson}}`
-     *
-     * @see {@link Context.templateData}
-     */
-    updateURL: string;
-    /**
-     * Configurations required to run the build.
-     *
-     * 构建所需的配置。
-     */
-    build: BuildConfig;
-    /**
-     * Configurations required to run the server.
-     *
-     * serve 所需的配置。
-     */
-    server: ServerConfig;
-    /**
-     * @todo Use addonLint package to lint XPI.
-     */
-    addonLint: object;
-    /**
-     * Configurations required to run the release.
-     *
-     * 发布相关配置。
-     */
-    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.
-     *
-     * 日志等级。
-     *
-     * @default "info"
-     */
-    logLevel: LogLevelType;
-}
-interface BuildConfig {
-    /**
-     * The static assets.
-     *
-     * - Typically includes icons, ftl files, 3rd party JavaScript files, CSS files, XHTML files, etc.
-     * - is an array of `glob` modes and supports negation modes.
-     * - Do not add an entire directory unless it has no files to exclude.
-     *
-     * 静态资源文件。
-     *
-     * - 通常包括图标、ftl 文件、第三方 JavaScript 文件、CSS 文件、XHTML 文件等。
-     * - 是一个 `glob` 模式数组，支持否定模式。
-     * - 除非一个目录没有需要排除的文件，否则不要添加整个目录。
-     *
-     * @see {@link https://github.com/sindresorhus/globby?tab=readme-ov-file#globbing-patterns | Pattern syntax | 语法说明 }
-     *
-     * @example `["src/**\/*.*", "!src/**\/*.ts"]` (no `\`)
-     *
-     * @default "addon/**\/*.*" (no `\`)
-     */
-    assets: string | string[];
-    /**
-     * The placeholders to replace in static assets.
-     *
-     * - At build time, scaffolding uses the key of the placeholder to build the regular pattern `/__${key}__/g` and replaces matches with `value`.
-     * - Replacement happens for all files under `assets`.
-     *
-     * 静态资源文本占位符。
-     *
-     * - 在构建时，脚手架使用占位符的 key 建立正则模式 `/__${key}__/g`，并将匹配到的内容替换为 `value`。
-     * - 替换发生在 `assets` 下的所有文件。
-     *
-     * @see {@link Context.templateData}
-     */
-    define: {
-        [key: string]: string;
-    };
-    fluent: {
-        /**
-         * Add plugin namespace prefixes to all FTL files to avoid conflicts.
-         *
-         * The default prefix is `${namespace}-`.
-         *
-         * 为所有 FTL 文件添加插件前缀以避免冲突。
-         *
-         * 默认前缀为 `${namespace}-`。
-         *
-         * @default true
-         */
-        prefixLocaleFiles: boolean;
-        /**
-         * Add plugin namespace prefixes to all FTL messages to avoid conflicts.
-         *
-         * The default prefix is `${namespace}-`.
-         *
-         * 为所有 FTL message 添加插件前缀以避免冲突。
-         *
-         * 默认前缀为 `${namespace}-`。
-         *
-         * @default true
-         */
-        prefixFluentMessages: boolean;
-        /**
-         * Messages to ignore.
-         *
-         * 需要忽略的 Fluent Messages。
-         *
-         * @default []
-         */
-        ignore: string[];
-    };
-    prefs: {
-        /**
-         * Prefixes the keys of preferences in `prefs.js` and
-         * the value of the `preference` attribute in XHTML files.
-         *
-         * 为 `prefs.js` 中的首选项键和 XHTML 文件中的 `preference` 属性的值
-         * 添加前缀。
-         *
-         * @default true
-         */
-        prefixPrefKeys: boolean;
-        /**
-         * Prefixes for Preference Keys, no dot at the end.
-         *
-         * 首选项键的前缀，结尾不需要加点号。
-         *
-         * @default 'extensions.${namespace}'
-         */
-        prefix: string;
-        /**
-         * Generate prefs.d.ts form prefs.js.
-         *
-         * - false: disable
-         * - string: path of dts file
-         *
-         * 为首选项生成类型声明文件。
-         *
-         * - false: 禁用
-         * - string：dts 文件路径
-         *
-         * @default 'typings/prefs.d.ts'
-         */
-        dts: false | string;
-    };
-    /**
-     * Configurations of esbuild.
-     *
-     * Paths should be relative to the root directory of the project.
-     * And if `outfile` and `outdir` not start with `dist`,
-     * `dist/` will be automatically added as a prefix.
-     *
-     * esbuild 配置。
-     *
-     * 路径应相对于项目根目录。
-     * 其中“outfile”和“outdir”若不以 `dist` 开头，
-     * 则会自动添加 `dist/` 前缀。
-     *
-     * @default []
-     *
-     */
-    esbuildOptions: BuildOptions[];
-    /**
-     * Make manifest.json.
-     *
-     */
-    makeManifest: {
-        /**
-         * 是否自动管理 manifest.json。
-         * 如果此项为 false，则开发者应自行准备 manifest.json。
-         *
-         * @default true
-         */
-        enable: boolean;
-        /**
-         * template of manifest.
-         *
-         * @deprecated
-         *
-         * @default
-         *
-         * ```json
-         * {
-         *   manifest_version: 2,
-         *   name: "${name}",
-         *   version: "${version}",
-         *   applications: {
-         *     zotero: {
-         *       id: "${id}",
-         *       update_url: "${updateURL}",
-         *       strict_min_version: "6.999",
-         *       strict_max_version: "7.0.*",
-         *     },
-         *     gecko: {
-         *       id: "${id}",
-         *       update_url: "${updateURL}",
-         *       strict_min_version: "102",
-         *     };
-         *   };
-         * };
-         * ```
-         */
-        template: Manifest;
-    };
-    /**
-     * Make update manifest.
-     *
-     * 生成 `update.json`。
-     *
-     */
-    makeUpdateJson: {
-        /**
-         * Historical update data.
-         *
-         * This can be useful if you need to distribute different plugin versions
-         * for different versions of Zotero.
-         *
-         * 已有的更新数据。
-         *
-         * 如果你需要为不同版本的 Zotero 分发不同的插件版本，这可能会很有用。
-         *
-         * @see {@link https://www.zotero.org/support/dev/zotero_7_for_developers#updaterdf_updatesjson | Zotero 7 for developers}
-         * @see {@link https://extensionworkshop.com/documentation/manage/updating-your-extension/ | Updating your extension}
-         * @see {@link https://zotero-chinese.com/plugin-dev-guide/reference/update | 更新清单 (In chinese)}
-         *
-         * @default []
-         */
-        updates: UpdateJSON["addons"][string]["updates"];
-        /**
-         * Whether or not to write the hash of the xpi file to update.json.
-         *
-         * 是否向 update.json 中写入 xpi 文件的 hash。
-         *
-         * @default true
-         */
-        hash: boolean;
-    };
-    /**
-     * The lifecycle hooks.
-     */
-    hooks: Partial<BuildHooks>;
-}
-interface BuildHooks {
-    "build:init": (ctx: Context) => void | Promise<void>;
-    "build:mkdir": (ctx: Context) => void | Promise<void>;
-    "build:copyAssets": (ctx: Context) => void | Promise<void>;
-    "build:makeManifest": (ctx: Context) => void | Promise<void>;
-    "build:fluent": (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>;
-    "build:done": (ctx: Context) => void | Promise<void>;
-}
-interface ServerConfig {
-    /**
-     * Open devtool on Zotero start.
-     *
-     * 在 Zotero 启动时打开 devtool。
-     *
-     * @default true
-     */
-    devtools: boolean;
-    /**
-     * Additional command line arguments when starting Zotero.
-     *
-     * 启动 Zotero 时附加的命令行参数。
-     *
-     * @default []
-     */
-    startArgs: string[];
-    /**
-     * Install the plugin as a Proxy File mode.
-     *
-     * 以 Proxy File 方式载入插件
-     *
-     * @default false
-     */
-    asProxy: boolean;
-    prebuild: boolean;
-    createProfileIfMissing: boolean;
-    /**
-     * The lifecycle hook.
-     */
-    hooks: Partial<ServeHooks>;
-}
-interface ServeHooks {
-    "serve:init": (ctx: Context) => void | Promise<void>;
-    "serve:prebuild": (ctx: Context) => void | Promise<void>;
-    "serve:ready": (ctx: Context) => void | Promise<void>;
-    "serve:onChanged": (ctx: Context, path: string) => void | Promise<void>;
-    "serve:onReloaded": (ctx: Context) => void | Promise<void>;
-    "serve:exit": (ctx: Context) => void;
-}
-interface ReleaseConfig {
-    /**
-     * Configurations of bumpp
-     *
-     * bumpp 包的部分配置。
-     */
-    bumpp: {
-        /**
-         * The release version or type. Can be one of the following:
-         *
-         * - A release type (e.g. "major", "minor", "patch", "prerelease", etc.)
-         * - "prompt" to prompt the user for the version number
-         *
-         * In general, it is recommended to set this to “prompt”.
-         * If you need a command that always releases a certain type,
-         * you can override this option on the command line.
-         *
-         * 发布的类型，可以是以下其中之一：
-         *
-         * - 版本类型（如 “major”、“minor”、“patch”、“prerelease”等）
-         * - “prompt” 以选择版本号
-         *
-         * 通常来说，建议将此项设置为“prompt”。
-         * 如果需要一个始终发布某类型的命令，可以在命令行中覆盖该选项。
-         *
-         * @default "prompt"
-         */
-        release: string;
-        /**
-         * The prerelease type (e.g. "alpha", "beta", "next").
-         *
-         * 预发布的类型，如 alpha，beta，next 等。
-         *
-         * @default "beta"
-         */
-        preid: string;
-        /**
-         * The commit message.
-         *
-         * Any `%s` placeholders in the message string will be replaced with the new version number.
-         * If the message string does _not_ contain any `%s` placeholders,
-         * then the new version number will be appended to the message.
-         *
-         * 提交说明模板。
-         *
-         * 模板中的 `%s` 占位符将被替换为新版本号。
-         * 如果模板中不包含任何 `%s` 占位符，则新版本号将附加到模板末端。
-         *
-         * @default "chore(publish): release %s"
-         */
-        commit: string;
-        /**
-         * The tag template.
-         *
-         * Any `%s` placeholders in the tag string will be replaced with the new version number.
-         * If the tag string does _not_ contain any `%s` placeholders,
-         * then the new version number will be appended to the tag.
-         *
-         * 标签模板。
-         *
-         * 模板中的 `%s` 占位符将被替换为新版本号。
-         * 如果模板中不包含任何 `%s` 占位符，则新版本号将附加到模板末端。
-         *
-         * @default "v%s"
-         */
-        tag: string;
-        /**
-         * Indicates whether the git commit should include ALL files (`git commit --all`)
-         * rather than just the files that were modified by `versionBump()`.
-         *
-         * 表示 git 提交是否应包括所有文件（`git commit --all`)，
-         * 而不是只包含被 `versionBump()` 修改过的文件。
-         *
-         * @default false
-         *
-         */
-        all: boolean;
-        /**
-         * Prompt for confirmation.
-         *
-         * 选择版本号后是否要求二次确认。
-         *
-         * @default true
-         */
-        confirm: boolean;
-        /**
-         * Indicates whether to bypass git commit hooks (`git commit --no-verify`).
-         *
-         * 表示是否绕过 git commit hooks（`git commit --no-verify` ）。
-         *
-         * @default false
-         */
-        noVerify: boolean;
-        /**
-         * Excute additional command after bumping and before commiting.
-         *
-         * 在提升版本号之后，提交之前运行的额外命令。
-         *
-         * @default "npm run build"
-         *
-         */
-        execute: string;
-    };
-    /**
-     * Changelog.
-     *
-     * - "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.
-     *
-     * 变更日志。
-     *
-     * - "conventional-changelog": 使用约定式变更日志，使用 angular 预设，
-     *   你需要手动安装 conventional-changelog 作为依赖项。
-     * - string: 命令行，变更日志输出到 stdout
-     *
-     * @default "git log {{previousTag}}..{{currentTag}}"
-     */
-    changelog: "conventional-changelog" | string | ((ctx: Context) => string);
-    /**
-     * Release to GitHub.
-     */
-    github: {
-        /**
-         * Enable release to GitHub.
-         *
-         * Include uploading XPI asset to GitHub release and all following steps.
-         *
-         * - "ci" to only enable in ci
-         * - "local" to only enable in non-ci
-         * - "always" to always enable
-         * - "false" to always disable
-         *
-         * @default "ci"
-         */
-        enable: "ci" | "local" | "always" | "false";
-        /**
-         * The information of remote repository.
-         *
-         * Will be extracted from the `repository` property in `package.json` by default.
-         *
-         * @default {{owner}}/{{repo}}
-         * @see {@link Context.templateData}
-         */
-        repository: string;
-        /**
-         * Upload update.json to release.
-         *
-         * This is the tagName of the release when the value is a string.
-         *
-         * 将 update.json 上传到指定的 GitHub release。
-         *
-         * 当值为字符串时，其为 release 的tagName。
-         *
-         * @default "release"
-         */
-        updater: string | false;
-        /**
-         * Comment to issues and prs inlcuded in release.
-         *
-         * @todo Not implemented yet
-         *
-         * @default false
-         */
-        comment: boolean;
-        releaseNote: (ctx: Context) => string;
-    };
-    hooks: Partial<ReleaseHooks>;
-}
-interface ReleaseHooks {
-    "release:init": (ctx: Context) => void | Promise<void>;
-    "release:push": (ctx: Context) => void | Promise<void>;
-    "release:done": (ctx: Context) => void | Promise<void>;
-}
-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>;
-    mocha: {
-        /**
-         * The timeout of the test.
-         *
-         * 测试的超时时间。
-         *
-         * @default 10000
-         */
-        timeout: 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;
-    /**
-     * 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.
-     *
-     * 运行测试前的延迟时间。确保插件在运行测试前完全加载。
-     *
-     * @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;
-    /**
-     * @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:copyAssets": (ctx: Context) => void | Promise<void>;
-    "test:bundleTests": (ctx: Context) => void | Promise<void>;
-    "test:run": (ctx: Context) => void | Promise<void>;
-    "test:exit": (ctx: Context) => void;
-}
-interface Hooks extends BuildHooks, ServeHooks, ReleaseHooks, TestHooks {
-}
-
-type RecursivePartial<T> = {
-    [P in keyof T]?: T[P] extends object ? RecursivePartial<T[P]> : T[P];
-};
-
-/**
- * User config
- */
-interface UserConfig extends RecursivePartial<Config$1> {
-}
-interface OverrideConfig extends RecursivePartial<Config$1> {
-}
-interface Context extends Config$1 {
-    pkgUser: any;
-    version: string;
-    hooks: Hookable<Hooks>;
-    logger: Logger;
-    templateData: TemplateData;
-}
-interface TemplateData {
-    /**
-     * `owner` and `repo` will be extracted from the `repository` property in `package.json`.
-     */
-    owner: string;
-    repo: string;
-    version: string;
-    isPreRelease: string;
-    updateJson: "update-beta.json" | "update.json" | string;
-    xpiName: string;
-    buildTime: string;
-}
-
-/**
- * Helper for user define configuration.
- */
-declare function defineConfig(userConfig: UserConfig): UserConfig;
-/**
- * Loads config
- * @param [overrides] Highest Priority Configuration.
- * @returns Config with userDefined and defaultConfig merged.
- */
-declare function loadConfig(overrides?: OverrideConfig): Promise<Context>;
-
-declare abstract class Base {
-    ctx: Context;
-    constructor(ctx: Context);
-    abstract run(): any;
-    get logger(): Logger;
-}
-
-declare class Build extends Base {
-    private buildTime;
-    private isPreRelease;
-    constructor(ctx: Context);
-    /**
-     * Default build runner
-     */
-    run(): Promise<void>;
-    /**
-     * Copys files in `Config.build.assets` to `Config.dist`
-     */
-    makeAssets(): Promise<void>;
-    /**
-     * Override user's manifest
-     *
-     */
-    makeManifest(): Promise<void>;
-    prepareLocaleFiles(): Promise<void>;
-    preparePrefs(): Promise<void>;
-    esbuild(): Promise<esbuild.BuildResult<esbuild.BuildOptions>[]> | undefined;
-    makeUpdateJson(): Promise<void>;
-    pack(): Promise<void>;
-}
-
-declare class Release extends Base {
-    constructor(ctx: Context);
-    /**
-     * Runs release
-     *
-     * if is not CI，bump version, git add (package.json), git commit, git tag, git push;
-     * if is CI, do not bump version, do not run git, create release (tag is `v${version}`) and upload xpi,
-     *    then, create or update release (tag is "release"), update `update.json`.
-     */
-    run(): Promise<void>;
-    getConventionalChangelog(): Promise<string>;
-    getGitLog(): string;
-    getFilteredChangelog(rawLog: string): string;
-    getChangelog(): Promise<string>;
-    private isEnabled;
-    get resolvedCommitMessage(): string;
-}
-
-declare class Serve extends Base {
-    private builder;
-    private runner?;
-    private _zoteroBinPath?;
-    constructor(ctx: Context);
-    run(): Promise<void>;
-    /**
-     * watch source dir and build when file changed
-     */
-    watch(): Promise<void>;
-    onChange(path: string): Promise<void>;
-    reload(): Promise<void>;
-    exit: () => never;
-    private onZoteroExit;
-    get zoteroBinPath(): string;
-    get profilePath(): string | undefined;
-    get dataDir(): string | undefined;
-}
-
-declare class Test extends Base {
-    private builder;
-    private runner?;
-    private communicator;
-    constructor(ctx: Context);
-    run(): Promise<void>;
-    createTestPlugin(): Promise<void>;
-    copyTestLibraries(): Promise<void>;
-    bundleTests(): Promise<void>;
-    startHttpServer(): Promise<void>;
-    onHttpDataUpdated(body: {
-        type: "start" | "suite" | "suite end" | "pending" | "pass" | "fail" | "end" | "debug";
-        data?: {
-            title: string;
-            str: string;
-            duration?: number;
-            stack?: string;
-        };
-    }): Promise<void>;
-    watch(): Promise<void>;
-    onCodeChanged(_path: string): Promise<void>;
-    startZoteroHeadless(): 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: {
-    defineConfig: typeof defineConfig;
-    loadConfig: typeof loadConfig;
-};
-
-export { Build, Config, Release, Serve, Test, defineConfig };

package/dist/vendor/index.d.ts

@@ -1,14 +0,0 @@
-import * as esToolkit from 'es-toolkit';
-export { esToolkit };
-import * as esm from 'fs-extra/esm';
-export { esm as fse };
-
-declare function replace(contents: string, from: RegExp | RegExp[], to: string | string[]): string;
-declare function replaceInFile({ files, from, to, isGlob }: {
-    files: string | string[];
-    from: RegExp | RegExp[];
-    to: string | string[];
-    isGlob?: boolean;
-}): Promise<void>;
-
-export { replace, replaceInFile };