zotero-plugin-scaffold 0.2.4 → 0.2.7

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.D7j478bu.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.BfbnPYjV.mjs';
 import { readFile, writeFile } from 'node:fs/promises';
 import { pathExists, ensureFile } from 'fs-extra';
 import tinyUpdateNotifier from 'tiny-update-notifier';
@@ -32,7 +32,7 @@ import 'xvfb-ts';
 
 const name = "zotero-plugin-scaffold";
 const type = "module";
-const version = "0.2.4";
+const version = "0.2.7";
 const packageManager = "pnpm@10.2.0";
 const description = "A scaffold for Zotero plugin development.";
 const author = "northword";

package/dist/index.d.mts

@@ -3,39 +3,54 @@ import * as esbuild from 'esbuild';
 import { BuildOptions } from 'esbuild';
 
 /**
- * Log level
+ * Log level enumeration
  */
 declare enum LOG_LEVEL {
-    trace = 0,
-    debug = 1,
-    info = 2,
-    warn = 3,
-    error = 4
+    TRACE = 0,
+    DEBUG = 1,
+    INFO = 2,
+    WARN = 3,
+    ERROR = 4
 }
 type LogLevelType = keyof typeof LOG_LEVEL;
-/**
- * Logger
- */
-declare class Log {
+interface LoggerOptions {
+    space?: number;
+    newLine?: boolean;
+}
+declare class Logger {
     private static instance;
-    private logLevel;
-    constructor(level?: LOG_LEVEL);
-    static getInstance(): Log;
+    private currentLogLevel;
+    private constructor();
+    /**
+     * Determine the appropriate log level
+     */
+    private determineLogLevel;
+    static getInstance(): Logger;
     setLogLevel(level: LogLevelType): void;
-    get level(): number;
-    private formatArgs;
-    private logArgs;
-    log(...args: any[]): void;
-    error(...args: any[]): void;
-    warn(...args: any[]): void;
-    tip(...args: any[]): void;
-    info(...args: any[]): void;
-    debug(...args: any[]): void;
-    ready(...args: any[]): void;
-    success(...args: any[]): void;
-    fail(...args: any[]): 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 {
@@ -771,7 +786,7 @@ interface Context extends Config$1 {
     pkgUser: any;
     version: string;
     hooks: Hookable<Hooks>;
-    logger: InstanceType<typeof Log>;
+    logger: Logger;
     templateData: TemplateData;
 }
 interface TemplateData {
@@ -802,7 +817,7 @@ declare abstract class Base {
     ctx: Context;
     constructor(ctx: Context);
     abstract run(): any;
-    get logger(): Log;
+    get logger(): Logger;
 }
 
 declare class Build extends Base {

package/dist/index.d.ts

@@ -3,39 +3,54 @@ import * as esbuild from 'esbuild';
 import { BuildOptions } from 'esbuild';
 
 /**
- * Log level
+ * Log level enumeration
  */
 declare enum LOG_LEVEL {
-    trace = 0,
-    debug = 1,
-    info = 2,
-    warn = 3,
-    error = 4
+    TRACE = 0,
+    DEBUG = 1,
+    INFO = 2,
+    WARN = 3,
+    ERROR = 4
 }
 type LogLevelType = keyof typeof LOG_LEVEL;
-/**
- * Logger
- */
-declare class Log {
+interface LoggerOptions {
+    space?: number;
+    newLine?: boolean;
+}
+declare class Logger {
     private static instance;
-    private logLevel;
-    constructor(level?: LOG_LEVEL);
-    static getInstance(): Log;
+    private currentLogLevel;
+    private constructor();
+    /**
+     * Determine the appropriate log level
+     */
+    private determineLogLevel;
+    static getInstance(): Logger;
     setLogLevel(level: LogLevelType): void;
-    get level(): number;
-    private formatArgs;
-    private logArgs;
-    log(...args: any[]): void;
-    error(...args: any[]): void;
-    warn(...args: any[]): void;
-    tip(...args: any[]): void;
-    info(...args: any[]): void;
-    debug(...args: any[]): void;
-    ready(...args: any[]): void;
-    success(...args: any[]): void;
-    fail(...args: any[]): 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 {
@@ -771,7 +786,7 @@ interface Context extends Config$1 {
     pkgUser: any;
     version: string;
     hooks: Hookable<Hooks>;
-    logger: InstanceType<typeof Log>;
+    logger: Logger;
     templateData: TemplateData;
 }
 interface TemplateData {
@@ -802,7 +817,7 @@ declare abstract class Base {
     ctx: Context;
     constructor(ctx: Context);
     abstract run(): any;
-    get logger(): Log;
+    get logger(): Logger;
 }
 
 declare class Build extends Base {

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.D7j478bu.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.BfbnPYjV.mjs';
 import 'c12';
 import 'es-toolkit';
 import 'fs-extra/esm';

package/dist/shared/{zotero-plugin-scaffold.D7j478bu.mjs → zotero-plugin-scaffold.BfbnPYjV.mjs}

@@ -27,101 +27,170 @@ import http from 'node:http';
 import { Xvfb } from 'xvfb-ts';
 
 var LOG_LEVEL = /* @__PURE__ */ ((LOG_LEVEL2) => {
-  LOG_LEVEL2[LOG_LEVEL2["trace"] = 0] = "trace";
-  LOG_LEVEL2[LOG_LEVEL2["debug"] = 1] = "debug";
-  LOG_LEVEL2[LOG_LEVEL2["info"] = 2] = "info";
-  LOG_LEVEL2[LOG_LEVEL2["warn"] = 3] = "warn";
-  LOG_LEVEL2[LOG_LEVEL2["error"] = 4] = "error";
+  LOG_LEVEL2[LOG_LEVEL2["TRACE"] = 0] = "TRACE";
+  LOG_LEVEL2[LOG_LEVEL2["DEBUG"] = 1] = "DEBUG";
+  LOG_LEVEL2[LOG_LEVEL2["INFO"] = 2] = "INFO";
+  LOG_LEVEL2[LOG_LEVEL2["WARN"] = 3] = "WARN";
+  LOG_LEVEL2[LOG_LEVEL2["ERROR"] = 4] = "ERROR";
   return LOG_LEVEL2;
 })(LOG_LEVEL || {});
-class Log {
+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"),
+  NONE: ""
+};
+const DEFAULT_OPTIONS = {
+  SPACE: 0,
+  LEVEL: 2 /* INFO */,
+  SYMBOL: "",
+  NEW_LINE: false
+};
+const LOG_METHODS_CONFIG = {
+  error: {
+    level: 4 /* ERROR */,
+    symbol: SYMBOLS.ERROR,
+    wrapNewLine: true
+  },
+  warn: {
+    level: 3 /* WARN */,
+    symbol: SYMBOLS.WARN,
+    wrapNewLine: true
+  },
+  tip: {
+    level: 2 /* INFO */,
+    symbol: SYMBOLS.TIP
+  },
+  info: {
+    level: 2 /* INFO */,
+    symbol: SYMBOLS.INFO
+  },
+  debug: {
+    level: 1 /* DEBUG */,
+    symbol: SYMBOLS.DEBUG
+  },
+  success: {
+    level: 2 /* INFO */,
+    symbol: SYMBOLS.SUCCESS
+  },
+  ready: {
+    level: 2 /* INFO */,
+    symbol: SYMBOLS.SUCCESS,
+    wrapNewLine: true
+  },
+  fail: {
+    level: 4 /* ERROR */,
+    symbol: SYMBOLS.FAIL
+  }
+};
+class Logger {
   static instance;
-  logLevel;
+  currentLogLevel;
   constructor(level) {
+    this.currentLogLevel = this.determineLogLevel(level);
+  }
+  /**
+   * Determine the appropriate log level
+   */
+  determineLogLevel(level) {
     if (isDebug)
-      this.logLevel = 0 /* trace */;
-    else if (process.env.ZOTERO_PLUGIN_LOG_LEVEL)
-      this.logLevel = LOG_LEVEL[process.env.ZOTERO_PLUGIN_LOG_LEVEL];
-    else if (level)
-      this.logLevel = level;
-    else
-      this.logLevel = 2 /* info */;
+      return 0 /* TRACE */;
+    const envLevel = process.env.ZOTERO_PLUGIN_LOG_LEVEL;
+    return envLevel ? LOG_LEVEL[envLevel] : level ?? 2 /* INFO */;
   }
   static getInstance() {
-    if (!Log.instance) {
-      Log.instance = new Log();
+    if (!Logger.instance) {
+      Logger.instance = new Logger();
     }
-    return Log.instance;
+    return Logger.instance;
   }
   setLogLevel(level) {
-    this.logLevel = LOG_LEVEL[level];
+    this.currentLogLevel = LOG_LEVEL[level];
   }
   get level() {
-    return this.logLevel;
-  }
-  formatArgs(arg) {
-    if (typeof arg === "string")
-      return arg;
-    if (arg instanceof Error) {
-      return `${chalk.red(arg.name)}: ${chalk.red(arg.message)}
-${arg.stack}`;
-    }
-    if (typeof arg === "object" && arg !== null && isPlainObject(arg)) {
-      return JSON.stringify(arg, null, 2);
-    }
-    return arg;
+    return this.currentLogLevel;
   }
-  logArgs(level, ...args) {
-    if (this.logLevel > level)
-      return;
-    args = args.map((arg) => this.formatArgs(arg));
-    console.log(...args);
+  /**
+   * Generic log formatting logic
+   */
+  formatContent(content) {
+    if (typeof content === "string")
+      return content;
+    if (content instanceof Error)
+      return this.formatError(content);
+    if (isPlainObject(content))
+      return JSON.stringify(content, null, 2);
+    return String(content);
+  }
+  formatError(error) {
+    return `${chalk.red(error.name)}: ${chalk.red(error.message)}
+${error.stack}`;
   }
-  log(...args) {
-    console.log(...args);
+  /**
+   * Core logging method
+   */
+  logInternal(content, config, options = {}) {
+    if (this.currentLogLevel > config.level)
+      return;
+    const { space = DEFAULT_OPTIONS.SPACE, newLine = DEFAULT_OPTIONS.NEW_LINE } = options;
+    const formattedContent = this.formatContent(content);
+    const output = [
+      " ".repeat(space),
+      config.symbol,
+      formattedContent
+    ].join(" ");
+    if (config.wrapNewLine)
+      this.newLine();
+    console.log(output);
+    if (newLine || config.wrapNewLine)
+      this.newLine();
   }
-  error(...args) {
-    this.newLine();
-    this.logArgs(4 /* error */, chalk.bgRed(" ERROR "), ...args);
-    this.newLine();
+  // Public API methods
+  error(content, options) {
+    this.logInternal(content, LOG_METHODS_CONFIG.error, options);
   }
-  warn(...args) {
-    this.newLine();
-    this.logArgs(3 /* warn */, chalk.bgYellow(" WARN "), ...args);
-    this.newLine();
+  warn(content, options) {
+    this.logInternal(content, LOG_METHODS_CONFIG.warn, options);
   }
-  tip(...args) {
-    this.logArgs(2 /* info */, chalk.blue("\u2192"), ...args);
+  tip(content, options) {
+    this.logInternal(content, LOG_METHODS_CONFIG.tip, options);
   }
-  info(...args) {
-    this.logArgs(2 /* info */, chalk.blue("\u2139"), ...args);
+  info(content, options) {
+    this.logInternal(content, LOG_METHODS_CONFIG.info, options);
   }
-  debug(...args) {
-    this.logArgs(1 /* debug */, chalk.grey("\u2699"), ...args);
+  debug(content, options) {
+    this.logInternal(content, LOG_METHODS_CONFIG.debug, options);
   }
-  ready(...args) {
-    this.newLine();
-    this.logArgs(2 /* info */, chalk.green("\u2714", ...args));
-    this.newLine();
+  success(content, options) {
+    this.logInternal(content, LOG_METHODS_CONFIG.success, options);
   }
-  success(...args) {
-    this.logArgs(2 /* info */, chalk.green("\u2714"), ...args);
+  fail(content, options) {
+    this.logInternal(content, LOG_METHODS_CONFIG.fail, options);
   }
-  fail(...args) {
-    this.logArgs(4 /* error */, chalk.red("\u2716"), ...args);
+  ready(content) {
+    this.logInternal(chalk.green(content), LOG_METHODS_CONFIG.success);
   }
   clear() {
-    const repeatCount = process.stdout.rows - 2;
-    const blank = repeatCount > 0 ? "\n".repeat(repeatCount) : "";
+    const blank = process.stdout.rows > 2 ? "\n".repeat(process.stdout.rows - 2) : "";
     console.log(blank);
     readline.cursorTo(process.stdout, 0, 0);
     readline.clearScreenDown(process.stdout);
   }
   newLine() {
-    console.log("");
+    console.log();
+  }
+  /**
+   * Direct passthrough to console.log
+   */
+  log(content) {
+    console.log(content);
   }
 }
-const logger = Log.getInstance();
+const logger = Logger.getInstance();
 
 function defineConfig(userConfig) {
   return userConfig;
@@ -268,7 +337,7 @@ const defaultConfig = {
     watch: false,
     hooks: {}
   },
-  logLevel: "info"
+  logLevel: "INFO"
 };
 const getDefaultConfig = () => defaultConfig;
 
@@ -528,7 +597,7 @@ class Build extends Base {
         define[key]
       ])
     );
-    this.logger.debug("replace map: ", replaceMap);
+    this.logger.debug(`replace map: ${replaceMap}`);
     await replaceInFile({
       files: newPaths,
       from: Array.from(replaceMap.keys()),
@@ -560,7 +629,7 @@ class Build extends Base {
       }
     };
     const data = toMerged(userData, template);
-    this.logger.debug("manifest: ", JSON.stringify(data, null, 2));
+    this.logger.debug(`manifest: ${JSON.stringify(data, null, 2)}`);
     outputJSON(`${dist}/addon/manifest.json`, data, { spaces: 2 });
   }
   async prepareLocaleFiles() {
@@ -570,7 +639,7 @@ class Build extends Base {
     const HTML_DATAI10NID_PATTERN = new RegExp(`(data-l10n-id)="((?!${namespace})\\S*)"`, "g");
     const localePaths = await glob(`${dist}/addon/locale/*`, { onlyDirectories: true });
     const localeNames = localePaths.map((locale) => basename(locale));
-    this.logger.debug("Locale names:", localeNames);
+    this.logger.debug(`Locale names:", ${localeNames}`);
     const allMessages = /* @__PURE__ */ new Set();
     const messagesByLocale = /* @__PURE__ */ new Map();
     for (const localeName of localeNames) {
@@ -755,7 +824,7 @@ class Bump extends Base {
     this.ctx.version = result.newVersion;
     this.ctx.release.bumpp.tag = result.tag || this.ctx.release.bumpp.tag.toString().replace("%s", result.newVersion);
     this.ctx.release.bumpp.commit = result.commit || this.ctx.release.bumpp.commit.toString().replace("%s", result.newVersion);
-    this.logger.debug("The release context after bump: ", this.ctx.release);
+    this.logger.debug(`The release context after bump: ", ${this.ctx.release}`);
   }
   /**
    * bumpp 显示进度的回调
@@ -868,7 +937,8 @@ class GitHub extends ReleaseBase {
     });
   }
   async createRelease(options) {
-    this.logger.debug("Creating release...", options);
+    this.logger.debug("Creating release...");
+    this.logger.debug(options);
     return await this.client.rest.repos.createRelease(options).catch((e) => {
       this.logger.error(e);
       throw new Error("Create release failed.");
@@ -994,7 +1064,7 @@ class Release extends Base {
       this.logger.warn(`The current release needs to run the build after bumping the version number, please configure the build script in 'config.release.bumpp.execute'${isBumpNeeded ? "" : " or run build before run release"}.`);
       this.ctx.release.bumpp.execute ||= "npm run build";
     }
-    this.logger.debug("Release config: ", this.ctx.release);
+    this.logger.debug(`Release config: ", ${this.ctx.release}`);
     await this.ctx.hooks.callHook("release:init", this.ctx);
     await new Bump(this.ctx).run();
     await this.ctx.hooks.callHook("release:push", this.ctx);
@@ -1437,7 +1507,7 @@ class RemoteFirefox {
       });
       return response;
     } catch (err) {
-      logger.debug(`Client responded to '${request}' request with error:`, err);
+      logger.debug(`Client responded to '${request}' request with error: ${err}`);
       const message = requestErrorToMessage(err);
       throw new Error(`Remote Firefox: addonRequest() error: ${message}`);
     }
@@ -1454,7 +1524,7 @@ class RemoteFirefox {
       }
       return response.addonsActor;
     } catch (err) {
-      logger.debug("Falling back to listTabs because getRoot failed", err);
+      logger.debug(`Falling back to listTabs because getRoot failed", ${err}`);
     }
     try {
       const response = await this.client.request("listTabs");
@@ -1470,7 +1540,7 @@ class RemoteFirefox {
       }
       return response.addonsActor;
     } catch (err) {
-      logger.debug("listTabs error", err);
+      logger.debug(`listTabs error: ${err}`);
       const message = requestErrorToMessage(err);
       throw new Error(`Remote Firefox: listTabs() error: ${message}`);
     }
@@ -1646,7 +1716,7 @@ class ZoteroRunner {
     }
     const remotePort = await findFreeTcpPort();
     args.push("-start-debugger-server", String(remotePort));
-    logger.debug("Zotero start args: ", args);
+    logger.debug(`Zotero start args: ${args}`);
     const env = {
       ...process.env,
       XPCOM_DEBUG_BREAK: "stack",
@@ -1655,7 +1725,7 @@ class ZoteroRunner {
     if (!await pathExists(this.options.binary.path))
       throw new Error("The Zotero binary not found.");
     this.zotero = spawn(this.options.binary.path, args, { env });
-    logger.debug("Zotero started, pid:", this.zotero.pid);
+    logger.debug(`Zotero started, pid: ${this.zotero.pid}`);
     this.zotero.stdout?.on("data", (_data) => {
     });
     logger.debug("Connecting to the remote Firefox debugger...");
@@ -1871,7 +1941,8 @@ class Serve extends Base {
       this.logger.info(`${path} changed`);
       await onChangeDebounced(path);
     }).on("error", (err) => {
-      this.logger.error("Server start failed!", err);
+      this.logger.fail("Server start failed!");
+      this.logger.error(err);
     });
   }
   async onChange(path) {
@@ -1929,13 +2000,13 @@ function isPackageInstalled(packageName) {
   }
 }
 function installPackage(packageName) {
-  const debug = isDebug || logger.level <= LOG_LEVEL.debug;
+  const debug = isDebug || logger.level <= LOG_LEVEL.DEBUG;
   try {
     logger.debug(`Installing ${packageName}...`);
     execSync(`sudo apt update && sudo apt install -y ${packageName}`, { stdio: debug ? "inherit" : "pipe" });
     logger.debug(`${packageName} installed successfully.`);
   } catch (error) {
-    logger.fail(`Failed to install ${packageName}.`, error);
+    logger.fail(`Failed to install ${packageName}. ${error}`);
     throw error;
   }
 }
@@ -2387,7 +2458,7 @@ class Test extends Base {
             res.writeHead(200, { "Content-Type": "application/json" });
             res.end(JSON.stringify({ message: "Results received successfully" }));
           } catch (error) {
-            this.logger.error("Error parsing JSON:", error);
+            this.logger.error(`Error parsing JSON:, ${error}`);
             res.writeHead(400, { "Content-Type": "application/json" });
             res.end(JSON.stringify({ error: "Invalid JSON" }));
           }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "zotero-plugin-scaffold",
   "type": "module",
-  "version": "0.2.4",
+  "version": "0.2.7",
   "description": "A scaffold for Zotero plugin development.",
   "author": "northword",
   "license": "AGPL-3.0-or-later",