nightingale 16.2.0 → 17.0.0

package/src/formatters/JSONFormatter.ts

@@ -38,25 +38,29 @@ function stringify(value: unknown, space?: number | string): string {
 
 export const JSONFormatter: NightingaleFormatter = {
   format(record) {
-    return stringify({
-      key: record.key,
-      level: record.level,
-      datetime: record.datetime,
-      message: record.message,
-      metadata: record.metadata,
-      extra: record.extra,
-    });
+    return [
+      stringify({
+        key: record.key,
+        level: record.level,
+        datetime: record.datetime,
+        message: record.message,
+        metadata: record.metadata,
+        extra: record.extra,
+      }),
+    ];
   },
 };
 
 export const JSONCLIFormatter: NightingaleFormatter = {
   format(record) {
-    return stringify({
-      key: record.key,
-      time: record.datetime.toTimeString().split(" ", 2)[0]!,
-      message: record.message,
-      ...record.metadata,
-      ...record.extra,
-    });
+    return [
+      stringify({
+        key: record.key,
+        time: record.datetime.toTimeString().split(" ", 2)[0]!,
+        message: record.message,
+        ...record.metadata,
+        ...record.extra,
+      }),
+    ];
   },
 };

package/src/formatters/MarkdownFormatter.test.ts

@@ -15,5 +15,7 @@ test("format simple message", () => {
     extra: {},
   };
 
-  expect(MarkdownFormatter.format(record)).toBe("record.key *01:00:00* → test");
+  expect(MarkdownFormatter.format(record)).toStrictEqual([
+    "record.key *01:00:00* → test",
+  ]);
 });

package/src/formatters/RawFormatter.test.ts

@@ -15,7 +15,7 @@ test("format simple message", () => {
     extra: {},
   };
 
-  expect(RawFormatter.format(record)).toBe(
+  expect(RawFormatter.format(record)).toStrictEqual([
     "record.key 01:00:00 → record.message",
-  );
+  ]);
 });

package/src/handlers/ConsoleCLIHandler.ts

@@ -9,11 +9,19 @@ import type {
 import { createFindDebugLevel } from "../debug/debug";
 import { ANSIFormatter } from "../formatters/ANSIFormatter";
 import { JSONFormatter } from "../formatters/JSONFormatter";
+import { RawFormatter } from "../formatters/RawFormatter";
 import { cliConsoleOutput } from "../outputs/cliConsoleOutput";
 import { consoleOutput } from "../outputs/consoleOutput";
 
-const createHandle = ({ json }: ConsoleCLIHandlerOptions): Handle => {
-  const formatter = json ? JSONFormatter.format : ANSIFormatter.format;
+const createHandle = ({
+  json,
+  noColor = process.env.NO_COLOR === "1" || process.env.NO_COLOR === "true",
+}: ConsoleCLIHandlerOptions): Handle => {
+  const formatter = (() => {
+    if (json) return JSONFormatter.format;
+    if (noColor) return RawFormatter.format;
+    return ANSIFormatter.format;
+  })();
   const output = json ? consoleOutput : cliConsoleOutput;
   return <T extends Metadata>(record: LogRecord<T>): void => {
     output(formatter(record), record);
@@ -23,6 +31,7 @@ const findDebugLevel = createFindDebugLevel(process.env.DEBUG);
 
 export interface ConsoleCLIHandlerOptions {
   json?: boolean;
+  noColor?: boolean;
 }
 
 export class ConsoleCLIHandler implements Handler {

package/src/handlers/ConsoleHandler.ts

@@ -6,18 +6,10 @@ import type {
   LogRecord,
   Metadata,
 } from "nightingale-types";
-import { POB_TARGET } from "pob-babel";
 import { createFindDebugLevel } from "../debug/debug";
-import { ANSIFormatter } from "../formatters/ANSIFormatter";
-import { JSONFormatter } from "../formatters/JSONFormatter";
+import type { NightingaleFormatter } from "../formatter-utils";
 import { consoleOutput } from "../outputs/consoleOutput";
-
-const defaultFormatter =
-  POB_TARGET === "node" &&
-  !process.stdout.isTTY &&
-  process.env.NIGHTINGALE_CONSOLE_FORMATTER !== "ansi"
-    ? JSONFormatter.format
-    : ANSIFormatter.format;
+import { defaultFormatter } from "./defaultFormatter";
 
 const createHandle = (
   formatter = defaultFormatter,
@@ -30,7 +22,7 @@ const createHandle = (
 const findDebugLevel = createFindDebugLevel(process.env.DEBUG);
 
 export interface ConsoleHandlerOptions {
-  formatter?: <T extends Metadata>(record: LogRecord<T>) => string;
+  formatter?: NightingaleFormatter["format"];
   output?: <T extends Metadata>(
     param: string[] | string,
     record: LogRecord<T>,

package/src/handlers/StringHandler.ts

@@ -16,6 +16,6 @@ export class StringHandler implements Handler {
   }
 
   handle<T extends Metadata>(record: LogRecord<T>): void {
-    this._buffer += RawFormatter.format(record) + "\n";
+    this._buffer += RawFormatter.format(record)[0] + "\n";
   }
 }

package/src/handlers/defaultFormatter.target-node.ts

@@ -0,0 +1,7 @@
+import { ANSIFormatter } from "../formatters/ANSIFormatter";
+import { JSONFormatter } from "../formatters/JSONFormatter";
+
+export const defaultFormatter =
+  !process.stdout.isTTY && process.env.NIGHTINGALE_CONSOLE_FORMATTER !== "ansi"
+    ? JSONFormatter.format
+    : ANSIFormatter.format;

package/src/handlers/defaultFormatter.ts

@@ -0,0 +1,3 @@
+import { ANSIFormatter } from "../formatters/ANSIFormatter";
+
+export const defaultFormatter = ANSIFormatter.format;

package/src/loggers/LoggerCLI.test.ts

@@ -0,0 +1,19 @@
+import { LoggerCLIString } from "./LoggerCLI";
+
+describe("LoggerCLI", () => {
+  test("LoggerCLIString", () => {
+    import.meta.jest.useFakeTimers({
+      now: new Date("2023-10-01T10:57:49.000Z"),
+    });
+
+    const consoleLogSpy = import.meta.jest
+      .spyOn(console, "log")
+      .mockImplementation(() => {});
+    const logger = new LoggerCLIString("test", { noColor: true });
+    logger.info("Test message", { key: "value" });
+
+    expect(consoleLogSpy).toHaveBeenCalledWith(
+      'test 10:57:49 → Test message { key: "value" }',
+    );
+  });
+});

package/src/loggers/LoggerCLI.ts

@@ -8,6 +8,7 @@ export interface LoggerCLIOptions {
   handlers?: Handler[];
   processors?: Processor[];
   json?: boolean;
+  noColor?: boolean;
 }
 
 export class LoggerCLI extends Logger {
@@ -16,10 +17,10 @@ export class LoggerCLI extends Logger {
   private json: boolean;
   constructor(
     key: string,
-    { displayName, processors, json = false }: LoggerCLIOptions = {},
+    { displayName, processors, json = false, noColor }: LoggerCLIOptions = {},
   ) {
     super(key, displayName);
-    this.handlers = [new ConsoleCLIHandler(Level.INFO, { json })];
+    this.handlers = [new ConsoleCLIHandler(Level.INFO, { json, noColor })];
     this.processors = processors ?? [];
     this.json = json;
   }
@@ -100,4 +101,23 @@ export class LoggerCLI extends Logger {
       }
     }
   }
+
+  separator(): void {
+    console.log();
+  }
+}
+
+export class LoggerCLIString extends LoggerCLI {
+  constructor(
+    key: string,
+    {
+      displayName,
+      handlers,
+      processors,
+      json = false,
+      noColor = false,
+    }: LoggerCLIOptions = {},
+  ) {
+    super(key, { displayName, handlers, processors, json, noColor });
+  }
 }

package/src/outputs/cliConsoleOutput.ts

@@ -1,17 +1,10 @@
 /* eslint-disable no-console */
 import { Level } from "nightingale-levels";
 import type { LogRecord, Metadata } from "nightingale-types";
-import { POB_TARGET } from "pob-babel";
 
 export function cliConsoleOutput<T extends Metadata>(
-  param: string[] | string,
+  param: [string, ...string[]],
   record: LogRecord<T>,
 ): void {
-  if (POB_TARGET !== "browser") {
-    console[record.level >= Level.ERROR ? "error" : "log"](param as string);
-  } else {
-    console[record.level >= Level.ERROR ? "error" : "log"](
-      ...(param as string[]),
-    );
-  }
+  console[record.level >= Level.ERROR ? "error" : "log"](...param);
 }

package/src/outputs/consoleOutput.target-node.ts

@@ -0,0 +1,10 @@
+import { Level } from "nightingale-levels";
+import type { LogRecord, Metadata } from "nightingale-types";
+
+export function consoleOutput<T extends Metadata>(
+  param: [string, ...string[]],
+  record: LogRecord<T>,
+): void {
+  const outKey = record.level >= Level.ERROR ? "stderr" : "stdout";
+  process[outKey].write(`${param[0]}\n`);
+}

package/src/outputs/consoleOutput.ts

@@ -1,18 +1,10 @@
 /* eslint-disable no-console */
 import { Level } from "nightingale-levels";
 import type { LogRecord, Metadata } from "nightingale-types";
-import { POB_TARGET } from "pob-babel";
 
 export function consoleOutput<T extends Metadata>(
-  param: string[] | string,
+  param: [string, ...string[]],
   record: LogRecord<T>,
 ): void {
-  if (POB_TARGET !== "browser") {
-    const outKey = record.level >= Level.ERROR ? "stderr" : "stdout";
-    process[outKey].write(`${param as string}\n`);
-  } else {
-    console[record.level >= Level.ERROR ? "error" : "log"](
-      ...(param as string[]),
-    );
-  }
+  console[record.level >= Level.ERROR ? "error" : "log"](...param);
 }