feat: pass formatOptions and other options to reporters

Author: pi0

examples/fancy.ts

@@ -1,4 +1,4 @@
 import { FancyReporter } from "../src/reporters";
 import { reporterDemo } from "./utils";
 
-reporterDemo(new FancyReporter({}));
+reporterDemo(new FancyReporter());

examples/utils/index.ts

@@ -27,5 +27,5 @@ export function reporterDemo(reporter) {
 }
 
 export const consola = createConsola({
-  reporters: [new FancyReporter({})],
+  reporters: [new FancyReporter()],
 });

package.json

@@ -50,6 +50,7 @@
     "@vitest/coverage-c8": "^0.29.8",
     "changelogen": "^0.5.2",
     "colorette": "^2.0.19",
+    "defu": "^6.1.2",
     "eslint": "^8.37.0",
     "eslint-config-unjs": "^0.1.0",
     "figures": "^5.0.0",

pnpm-lock.yaml

@@ -1,24 +1,17 @@
+import { defu } from "defu";
 import { LogTypes, LogType, LogLevel } from "./constants";
 import { isLogObj } from "./utils/index";
-import type { ConsolaReporter, InputLogObject, LogObject } from "./types";
+import type {
+  ConsolaReporter,
+  InputLogObject,
+  LogObject,
+  ConsolaOptions,
+} from "./types";
 import type { PromptOptions } from "./prompt";
 
 let paused = false;
 const queue: any[] = [];
 
-export interface ConsolaOptions {
-  reporters: ConsolaReporter[];
-  types: Record<LogType, InputLogObject>;
-  level: LogLevel;
-  defaults: InputLogObject;
-  throttle: number;
-  throttleMin: number;
-  stdout?: NodeJS.WritableStream;
-  stderr?: NodeJS.WritableStream;
-  mockFn?: (type: LogType, defaults: InputLogObject) => (...args: any) => void;
-  prompt?: typeof import("./prompt").prompt | undefined;
-}
-
 export class Consola {
   options: ConsolaOptions;
 
@@ -33,18 +26,24 @@ export class Consola {
   constructor(options: Partial<ConsolaOptions> = {}) {
     // Options
     const types = options.types || LogTypes;
-    this.options = {
-      // Defaults
-      throttle: 1000,
-      throttleMin: 5,
-      // User
-      ...options,
-      // Overrides, Normalizations and Clones
-      defaults: { ...options.defaults },
-      level: _normalizeLogLevel(options.level, types),
-      reporters: [...(options.reporters || [])],
-      types,
-    };
+    this.options = defu(
+      <ConsolaOptions>{
+        ...options,
+        defaults: { ...options.defaults },
+        level: _normalizeLogLevel(options.level, types),
+        reporters: [...(options.reporters || [])],
+      },
+      <ConsolaOptions>{
+        types: LogTypes,
+        throttle: 1000,
+        throttleMin: 5,
+        formatOptions: {
+          date: true,
+          colors: false,
+          compact: true,
+        },
+      }
+    );
 
     // Create logger functions for current instance
     for (const type in types) {
@@ -353,8 +352,7 @@ export class Consola {
   _log(logObj: LogObject) {
     for (const reporter of this.options.reporters) {
       reporter.log(logObj, {
-        stdout: this.stdout,
-        stderr: this.stderr,
+        options: this.options,
       });
     }
   }

src/consola.ts

@@ -1,6 +1,6 @@
 import BrowserReporter from "./reporters/browser";
 import { createConsola as _createConsola } from "./consola";
-import type { ConsolaOptions } from "./consola";
+import type { ConsolaOptions } from "./types";
 
 export * from "./index.shared";
 

src/index.browser.ts

@@ -1,12 +1,14 @@
 import { isDebug, isTest, isCI } from "std-env";
 import { LogLevels, LogLevel } from "./constants";
-import type { ConsolaOptions } from "./consola";
+import type { ConsolaOptions } from "./types";
 import { BasicReporter, FancyReporter } from "./reporters";
-import { createConsola as _createConsola } from "./consola";
+import { ConsolaInstance, createConsola as _createConsola } from "./consola";
 
 export * from "./index.shared";
 
-export function createConsola(options: Partial<ConsolaOptions> = {}) {
+export function createConsola(
+  options: Partial<ConsolaOptions> = {}
+): ConsolaInstance {
   // Log level
   let level = _getDefaultLogLevel();
   if (process.env.CONSOLA_LEVEL) {
@@ -17,9 +19,11 @@ export function createConsola(options: Partial<ConsolaOptions> = {}) {
   const consola = _createConsola({
     level: level as LogLevel,
     defaults: { level },
+    stdout: process.stdout,
+    stderr: process.stderr,
     prompt: (...args) => import("./prompt").then((m) => m.prompt(...args)),
     reporters: options.reporters || [
-      isCI || isTest ? new BasicReporter({}) : new FancyReporter({}),
+      isCI || isTest ? new BasicReporter() : new FancyReporter(),
     ],
     ...options,
   });

src/index.node.ts

@@ -1,6 +1,6 @@
-export { Consola } from "./consola";
 export { LogLevels, LogTypes } from "./constants";
+export { Consola } from "./consola";
 
-export type { ConsolaInstance, ConsolaOptions } from "./consola";
-export type { LogLevel, LogType } from "./constants";
 export type * from "./types";
+export type { ConsolaInstance } from "./consola";
+export type { LogLevel, LogType } from "./constants";

src/index.shared.ts

@@ -1,54 +1,43 @@
-import util from "node:util";
-import { LogObject } from "../types";
+import { formatWithOptions } from "node:util";
+import type {
+  LogObject,
+  ConsolaReporter,
+  ConsolaOptions,
+  FormatOptions,
+} from "../types";
 import { parseStack } from "../utils/error";
 import { writeStream } from "../utils/stream";
 
-const DEFAULTS = {
-  formatOptions: {
-    date: true,
-    colors: false,
-    compact: true,
-  },
-};
-
 const bracket = (x: string) => (x ? `[${x}]` : "");
 
-export default class BasicReporter {
-  options: typeof DEFAULTS;
-
-  constructor(options: Partial<typeof DEFAULTS>) {
-    this.options = { ...DEFAULTS, ...options };
-  }
-
-  formatStack(stack: string) {
+export default class BasicReporter implements ConsolaReporter {
+  formatStack(stack: string, opts: FormatOptions) {
     return "  " + parseStack(stack).join("\n  ");
   }
 
-  formatArgs(args: any[]) {
+  formatArgs(args: any[], opts: FormatOptions) {
     const _args = args.map((arg) => {
       if (arg && typeof arg.stack === "string") {
-        return arg.message + "\n" + this.formatStack(arg.stack);
+        return arg.message + "\n" + this.formatStack(arg.stack, opts);
       }
       return arg;
     });
 
     // Only supported with Node >= 10
     // https://nodejs.org/api/util.html#util_util_inspect_object_options
-    return typeof util.formatWithOptions === "function"
-      ? util.formatWithOptions(this.options.formatOptions, ..._args)
-      : util.format(..._args);
+    return formatWithOptions(opts, ..._args);
   }
 
-  formatDate(date: Date) {
-    return this.options.formatOptions.date ? date.toLocaleTimeString() : "";
+  formatDate(date: Date, opts: FormatOptions) {
+    return opts.date ? date.toLocaleTimeString() : "";
   }
 
   filterAndJoin(arr: any[]) {
     return arr.filter(Boolean).join(" ");
   }
 
-  formatLogObj(logObj: LogObject, _opts: any) {
-    const message = this.formatArgs(logObj.args);
+  formatLogObj(logObj: LogObject, opts: FormatOptions) {
+    const message = this.formatArgs(logObj.args, opts);
 
     return this.filterAndJoin([
       bracket(logObj.type),
@@ -57,11 +46,17 @@ export default class BasicReporter {
     ]);
   }
 
-  log(logObj: LogObject, { stdout, stderr }: any = {}) {
+  log(logObj: LogObject, ctx: { options: ConsolaOptions }) {
     const line = this.formatLogObj(logObj, {
-      width: stdout.columns || 0,
+      columns: (ctx.options.stdout as any).columns || 0,
+      ...ctx.options.formatOptions,
     });
 
-    return writeStream(line + "\n", logObj.level < 2 ? stderr : stdout);
+    return writeStream(
+      line + "\n",
+      logObj.level < 2
+        ? ctx.options.stderr || process.stderr
+        : ctx.options.stdout || process.stdout
+    );
   }
 }

src/reporters/basic.ts

@@ -3,7 +3,7 @@ import { mainSymbols } from "figures";
 import * as colors from "colorette";
 import { parseStack } from "../utils/error";
 import { TYPE_COLOR_MAP, LEVEL_COLOR_MAP } from "../utils/fancy";
-import { LogObject } from "../types";
+import { FormatOptions, LogObject } from "../types";
 import BasicReporter from "./basic";
 
 const DEFAULTS = {
@@ -24,10 +24,6 @@ const TYPE_ICONS = {
 };
 
 export default class FancyReporter extends BasicReporter {
-  constructor(options: Partial<typeof DEFAULTS>) {
-    super({ ...DEFAULTS, ...options });
-  }
-
   formatStack(stack: string) {
     return (
       "\n" +
@@ -43,11 +39,11 @@ export default class FancyReporter extends BasicReporter {
     );
   }
 
-  formatType(logObj: LogObject, isBadge: boolean) {
+  formatType(logObj: LogObject, isBadge: boolean, opts: FormatOptions) {
     const typeColor =
       (TYPE_COLOR_MAP as any)[logObj.type] ||
       (LEVEL_COLOR_MAP as any)[logObj.level] ||
-      (this.options as any).secondaryColor;
+      "gray";
 
     if (isBadge) {
       return getBgColor(typeColor)(
@@ -62,20 +58,22 @@ export default class FancyReporter extends BasicReporter {
     return _type ? getColor(typeColor)(_type) : "";
   }
 
-  formatLogObj(logObj: LogObject, opts: { width: number }) {
-    const [message, ...additional] = this.formatArgs(logObj.args).split("\n");
+  formatLogObj(logObj: LogObject, opts: FormatOptions) {
+    const [message, ...additional] = this.formatArgs(logObj.args, opts).split(
+      "\n"
+    );
 
     const isBadge =
       typeof (logObj as any).badge !== "undefined"
         ? Boolean((logObj as any).badge)
         : logObj.level < 2;
 
-    const secondaryColor = getColor((this.options as any).secondaryColor);
+    const secondaryColor = getColor("gray");
 
-    const date = this.formatDate(logObj.date);
+    const date = this.formatDate(logObj.date, opts);
     const coloredDate = date && secondaryColor(date);
 
-    const type = this.formatType(logObj, isBadge);
+    const type = this.formatType(logObj, isBadge, opts);
 
     const tag = logObj.tag ? secondaryColor(logObj.tag) : "";
 
@@ -86,10 +84,11 @@ export default class FancyReporter extends BasicReporter {
     let line;
     const left = this.filterAndJoin([type, formattedMessage]);
     const right = this.filterAndJoin([tag, coloredDate]);
-    const space = opts.width - stringWidth(left) - stringWidth(right) - 2;
+    const space =
+      (opts.columns || 0) - stringWidth(left) - stringWidth(right) - 2;
 
     line =
-      space > 0 && opts.width >= 80
+      space > 0 && (opts.columns || 0) >= 80
         ? left + " ".repeat(space) + right
         : `[ ${right} ] ${left}`;