fix(logger): log level, use single class mode

Author: northword

src/cli.ts

@@ -4,16 +4,9 @@ import process, { env, exit } from "node:process";
 import { Command } from "@commander-js/extra-typings";
 import pkg from "../package.json" with { type: "json" };
 import { Build, Config, Release, Serve, Test } from "./index.js";
-import { Log } from "./utils/log.js";
+import { logger } from "./utils/log.js";
 import { updateNotifier } from "./utils/updater.js";
 
-const logger = new Log();
-// let globalOpts: {
-//   configCwd?: string;
-// } = {
-//   configCwd: cwd(),
-// };
-
 export default async function main() {
   const { name, version } = pkg;
   updateNotifier(name, version);

src/config.ts

@@ -1,10 +1,9 @@
 import type { Config, Context, Hooks, OverrideConfig, UserConfig } from "./types/index.js";
-import { env } from "node:process";
 import { loadConfig as c12 } from "c12";
 import { kebabCase, mapValues } from "es-toolkit";
 import { readJsonSync } from "fs-extra/esm";
 import { createHooks } from "hookable";
-import { Log } from "./utils/log.js";
+import { logger } from "./utils/log.js";
 import { dateFormat, parseRepoUrl, template } from "./utils/string.js";
 
 /**
@@ -32,9 +31,7 @@ export async function loadConfig(overrides?: OverrideConfig): Promise<Context> {
 }
 
 function resolveConfig(config: Config): Context {
-  // Sync log level to env so that logs in utils are also output as expected by log level
-  env.ZOTERO_PLUGIN_LOG_LEVEL = config.logLevel;
-  const logger = new Log(config);
+  logger.setLogLevel(config.logLevel);
 
   // Load user's package.json
   const pkgUser = readJsonSync("package.json", {

src/creator.ts

@@ -1,8 +1,6 @@
 // npx 创建模板
 // import { input } from "@inquirer/prompts";
-import { Log } from "./utils/log.js";
-
-const logger = new Log();
+import { logger } from "./utils/log.js";
 
 export default class Create {
   async run() {

src/types/config.ts

@@ -1,4 +1,5 @@
 import type { BuildOptions } from "esbuild";
+import type { LogLevelType } from "../utils/log.js";
 import type { Context } from "./index.js";
 import type { Manifest } from "./manifest.js";
 import type { UpdateJSON } from "./update-json.js";
@@ -153,7 +154,7 @@ export interface Config {
    *
    * @default "info"
    */
-  logLevel: "trace" | "debug" | "info" | "warn" | "error";
+  logLevel: LogLevelType;
 }
 
 export interface BuildConfig {

src/utils/headless.ts

@@ -1,9 +1,7 @@
 import { execSync } from "node:child_process";
 import { exit } from "node:process";
 import { isLinux } from "std-env";
-import { Log } from "./log.js";
-
-const logger = new Log();
+import { logger } from "./log.js";
 
 export async function installXvfb() {
   logger.debug("Installing xvfb...");

src/utils/log.ts

@@ -1,4 +1,3 @@
-import type { Config } from "../types/index.js";
 import process, { env } from "node:process";
 import readline from "node:readline";
 import chalk from "chalk";
@@ -8,28 +7,42 @@ import { isDebug } from "std-env";
 /**
  * Log level
  */
-enum LOG_LEVEL {
+export enum LOG_LEVEL {
   trace = 0,
   debug = 1,
   info = 2,
   warn = 3,
   error = 4,
 }
 
+export type LogLevelType = keyof typeof LOG_LEVEL;
+
 /**
  * Logger
  */
 export class Log {
+  private static instance: Log;
   private logLevel: number;
-  constructor(config?: Config) {
+  constructor(level?: LOG_LEVEL) {
     if (isDebug)
       this.logLevel = LOG_LEVEL.trace;
-    else if (config)
-      this.logLevel = LOG_LEVEL[config.logLevel];
     else if (env.ZOTERO_PLUGIN_LOG_LEVEL)
-      this.logLevel = LOG_LEVEL[env.ZOTERO_PLUGIN_LOG_LEVEL as Config["logLevel"]];
+      this.logLevel = LOG_LEVEL[env.ZOTERO_PLUGIN_LOG_LEVEL as LogLevelType];
+    else if (level)
+      this.logLevel = level;
     else
-      this.logLevel = LOG_LEVEL.trace;
+      this.logLevel = LOG_LEVEL.info;
+  }
+
+  static getInstance(): Log {
+    if (!Log.instance) {
+      Log.instance = new Log();
+    }
+    return Log.instance;
+  }
+
+  setLogLevel(level: LogLevelType) {
+    this.logLevel = LOG_LEVEL[level];
   }
 
   private formatArgs(arg: any): string {
@@ -117,3 +130,5 @@ export class Log {
     console.log("");
   }
 }
+
+export const logger = Log.getInstance();

src/utils/updater.ts

@@ -1,10 +1,8 @@
 import process from "node:process";
 import tinyUpdateNotifier from "tiny-update-notifier";
-import { Log } from "./log.js";
+import { logger } from "./log.js";
 import { ExitSignals } from "./process.js";
 
-const logger = new Log();
-
 export function updateNotifier(name: string, version: string) {
   tinyUpdateNotifier({ pkg: { name, version } }).then((update) => {
     if (update) {

src/utils/zotero-runner.ts

@@ -6,13 +6,11 @@ import { env } from "node:process";
 import { delay } from "es-toolkit";
 import { outputFile, outputJSON, pathExists, readJSON, remove } from "fs-extra/esm";
 import { isLinux, isMacOS, isWindows } from "std-env";
-import { Log } from "./log.js";
+import { logger } from "./log.js";
 import { isRunning } from "./process.js";
 import { prefs } from "./zotero/preference.js";
 import { findFreeTcpPort, RemoteFirefox } from "./zotero/remote-zotero.js";
 
-const logger = new Log();
-
 export interface ZoteroRunnerOptions {
   binaryPath: string;
   profilePath: string;
@@ -286,8 +284,6 @@ export class ZoteroRunner {
 }
 
 export function killZotero() {
-  const logger = new Log();
-
   function kill() {
     try {
       if (env.ZOTERO_PLUGIN_KILL_COMMAND) {

src/utils/zotero/remote-zotero.ts

@@ -22,10 +22,9 @@
 
 import net from "node:net";
 
-import { Log } from "../log.js";
+import { logger } from "../log.js";
 import { MessagingClient } from "./rdp-client.js";
 
-const logger = new Log();
 const MAX_RETRIES = 150;
 const RETRY_INTERVAL = 1000;