@holz/ansi-terminal-backend 0.2.0 → 0.5.0

package/dist/holz-ansi-terminal-backend.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});var s=(o=>(o.Error="error",o.Warn="warn",o.Info="info",o.Debug="debug",o))(s||{});function t(o){return`\x1B[${o}`}const i={black:t("30m"),red:t("31m"),green:t("32m"),yellow:t("33m"),blue:t("34m"),magenta:t("35m"),cyan:t("36m"),white:t("37m")},n={reset:t("0m"),bold:t("1m"),dim:t("2m")};class d{constructor(e={}){this.console=e.console??console}processLog(e){const m=this.getTimestamp(new Date),c=[{include:!0,command:"%s",content:`${n.reset}${n.dim}${m}${n.reset}`},{include:!0,command:"%s",content:u[e.level]},{include:!0,command:"%s",content:e.message},{include:e.origin.length>0,command:"%s",content:`${n.dim}${e.origin.join(":")}${n.reset}`},{include:Object.keys(e.context).length>0,command:"%O",content:e.context}].filter(r=>r.include),a=c.map(r=>r.command).join(" "),l=c.map(r=>r.content);this.console.error(a,...l)}getTimestamp(e){const m=e.getHours().toString().padStart(2,"0"),c=e.getMinutes().toString().padStart(2,"0"),a=e.getSeconds().toString().padStart(2,"0"),l=e.getMilliseconds().toString().padStart(3,"0");return`[${m}:${c}:${a}.${l}]`}}const u={[s.Debug]:`${i.blue}DEBUG${n.reset}`,[s.Info]:`${i.green}INFO${n.reset} `,[s.Warn]:`${i.yellow}WARN${n.reset} `,[s.Error]:`${i.red}ERROR${n.reset}`};exports.AnsiTerminalBackend=d;exports.default=d;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const s=require("@holz/core");function o(e){return`\x1B[${e}`}const n=o("0m"),u=o("2m"),g=o("31m"),p=o("32m"),L=o("33m"),S=o("34m");function f(e={}){const r=e.console??console,i=" ".repeat(s.LogLevel.Error.length);return t=>{const a=v(new Date),m=`${n}${u}${a}${n}`,l=[{include:!0,command:"%s",content:m},{include:!0,command:"%s",content:b[t.level]},{include:!0,command:"%s",content:t.message.replace(/(\r?\n)/g,`$1${m} ${i} `)},{include:Object.keys(t.context).length>0,command:"%O",content:t.context},{include:t.origin.length>0,command:"%s",content:`${u}${t.origin.join(":")}${n}`}].filter(c=>c.include),d=l.map(c=>c.command).join(" "),$=l.map(c=>c.content);r.error(d,...$)}}function v(e){const r=e.getHours().toString().padStart(2,"0"),i=e.getMinutes().toString().padStart(2,"0"),t=e.getSeconds().toString().padStart(2,"0"),a=e.getMilliseconds().toString().padStart(3,"0");return`[${r}:${i}:${t}.${a}]`}const b={[s.LogLevel.Debug]:`${S}DEBUG${n}`,[s.LogLevel.Info]:`${p}INFO${n} `,[s.LogLevel.Warn]:`${L}WARN${n} `,[s.LogLevel.Error]:`${g}ERROR${n}`};exports.createAnsiTerminalBackend=f;

package/dist/holz-ansi-terminal-backend.js

@@ -1,68 +1,54 @@
-var s = /* @__PURE__ */ ((o) => (o.Error = "error", o.Warn = "warn", o.Info = "info", o.Debug = "debug", o))(s || {});
-function t(o) {
-  return `\x1B[${o}`;
+import { LogLevel as s } from "@holz/core";
+function o(t) {
+  return `\x1B[${t}`;
 }
-const m = {
-  black: t("30m"),
-  red: t("31m"),
-  green: t("32m"),
-  yellow: t("33m"),
-  blue: t("34m"),
-  magenta: t("35m"),
-  cyan: t("36m"),
-  white: t("37m")
-}, n = {
-  reset: t("0m"),
-  bold: t("1m"),
-  dim: t("2m")
-};
-class u {
-  constructor(e = {}) {
-    this.console = e.console ?? console;
-  }
-  processLog(e) {
-    const i = this.getTimestamp(new Date()), c = [
+const e = o("0m"), u = o("2m"), g = o("31m"), p = o("32m"), S = o("33m"), f = o("34m");
+function v(t = {}) {
+  const r = t.console ?? console, i = " ".repeat(s.Error.length);
+  return (n) => {
+    const m = b(new Date()), a = `${e}${u}${m}${e}`, l = [
       {
         include: !0,
         command: "%s",
-        content: `${n.reset}${n.dim}${i}${n.reset}`
+        content: a
       },
       {
         include: !0,
         command: "%s",
-        content: d[e.level]
+        content: h[n.level]
       },
       {
         include: !0,
         command: "%s",
-        content: e.message
+        content: n.message.replace(
+          /(\r?\n)/g,
+          `$1${a} ${i} `
+        )
       },
       {
-        include: e.origin.length > 0,
-        command: "%s",
-        content: `${n.dim}${e.origin.join(":")}${n.reset}`
+        include: Object.keys(n.context).length > 0,
+        command: "%O",
+        content: n.context
       },
       {
-        include: Object.keys(e.context).length > 0,
-        command: "%O",
-        content: e.context
+        include: n.origin.length > 0,
+        command: "%s",
+        content: `${u}${n.origin.join(":")}${e}`
       }
-    ].filter((r) => r.include), a = c.map((r) => r.command).join(" "), l = c.map((r) => r.content);
-    this.console.error(a, ...l);
-  }
-  // ISO-8601 timestamp with milliseconds.
-  getTimestamp(e) {
-    const i = e.getHours().toString().padStart(2, "0"), c = e.getMinutes().toString().padStart(2, "0"), a = e.getSeconds().toString().padStart(2, "0"), l = e.getMilliseconds().toString().padStart(3, "0");
-    return `[${i}:${c}:${a}.${l}]`;
-  }
+    ].filter((c) => c.include), $ = l.map((c) => c.command).join(" "), d = l.map((c) => c.content);
+    r.error($, ...d);
+  };
+}
+function b(t) {
+  const r = t.getHours().toString().padStart(2, "0"), i = t.getMinutes().toString().padStart(2, "0"), n = t.getSeconds().toString().padStart(2, "0"), m = t.getMilliseconds().toString().padStart(3, "0");
+  return `[${r}:${i}:${n}.${m}]`;
 }
-const d = {
-  [s.Debug]: `${m.blue}DEBUG${n.reset}`,
-  [s.Info]: `${m.green}INFO${n.reset} `,
-  [s.Warn]: `${m.yellow}WARN${n.reset} `,
-  [s.Error]: `${m.red}ERROR${n.reset}`
+const h = {
+  [s.Debug]: `${f}DEBUG${e}`,
+  [s.Info]: `${p}INFO${e} `,
+  [s.Warn]: `${S}WARN${e} `,
+  [s.Error]: `${g}ERROR${e}`
 };
 export {
-  u as AnsiTerminalBackend,
-  u as default
+  v as createAnsiTerminalBackend
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@holz/ansi-terminal-backend",
-  "version": "0.2.0",
+  "version": "0.5.0",
   "description": "An ANSI terminal backend for Holz",
   "type": "module",
   "main": "./dist/holz-ansi-terminal-backend.cjs",
@@ -37,11 +37,14 @@
     "test:unit": "vitest --color --passWithNoTests",
     "test:types": "tsc"
   },
+  "peerDependencies": {
+    "@holz/core": "^0.5.0"
+  },
   "devDependencies": {
-    "@holz/core": "0.2.0",
+    "@holz/core": "^0.5.0",
     "@types/node": "^18.14.0",
-    "@vitest/coverage-c8": "0.28.5",
-    "typescript": "4.9.5",
+    "@vitest/coverage-c8": "^0.28.5",
+    "typescript": "^4.9.5",
     "vite": "^4.0.0",
     "vitest": "^0.28.5"
   }

package/src/__tests__/ansi-terminal-backend.test.ts

@@ -1,24 +1,42 @@
-import { format } from 'util';
+import { Writable } from 'node:stream';
+import { Console } from 'node:console';
 import { createLogger } from '@holz/core';
-import type { MinimalConsole } from '../ansi-terminal-backend';
-import AnsiTerminalBackend from '../ansi-terminal-backend';
+import { createAnsiTerminalBackend } from '../ansi-terminal-backend';
 
 const CURRENT_TIME = new Date('2020-06-15T03:05:07.010Z');
 
-class MockConsole implements MinimalConsole {
-  log(...strings: Array<unknown>) {
-    this.stdout(format(...strings));
-  }
+describe('ANSI terminal backend', () => {
+  function createStream() {
+    let output = '';
+    const stream = new Writable({
+      write(chunk, _encoding, callback) {
+        output += String(chunk);
+        callback();
+      },
+    });
 
-  error(...strings: Array<unknown>) {
-    this.stderr(format(...strings));
+    return {
+      getOutput: () => output,
+      stream,
+    };
   }
 
-  stdout = vi.fn();
-  stderr = vi.fn();
-}
+  // Named "terminal" to avoid conflict with `global.console`.
+  function createTerminal() {
+    const stdout = createStream();
+    const stderr = createStream();
+    const terminal = new Console({
+      stdout: stdout.stream,
+      stderr: stderr.stream,
+    });
+
+    return {
+      stdout,
+      stderr,
+      terminal,
+    };
+  }
 
-describe('ANSI terminal backend', () => {
   beforeEach(() => {
     vi.useFakeTimers({
       now: CURRENT_TIME,
@@ -30,20 +48,18 @@ describe('ANSI terminal backend', () => {
   });
 
   it('prints the message to the terminal', () => {
-    const terminal = new MockConsole();
-    const backend = new AnsiTerminalBackend({ console: terminal });
+    const { terminal, stderr } = createTerminal();
+    const backend = createAnsiTerminalBackend({ console: terminal });
 
     const logger = createLogger(backend);
     logger.info('hello world');
 
-    expect(terminal.stderr).toHaveBeenCalledWith(
-      expect.stringContaining('hello world')
-    );
+    expect(stderr.getOutput()).toContain('hello world');
   });
 
   it('includes the log level', () => {
-    const terminal = new MockConsole();
-    const backend = new AnsiTerminalBackend({ console: terminal });
+    const { terminal, stderr } = createTerminal();
+    const backend = createAnsiTerminalBackend({ console: terminal });
 
     const logger = createLogger(backend);
     logger.debug('shout');
@@ -51,68 +67,56 @@ describe('ANSI terminal backend', () => {
     logger.warn('hmmmm');
     logger.error('oh no');
 
-    expect(terminal.stderr).toHaveBeenCalledWith(
-      expect.stringContaining('DEBUG')
-    );
-
-    expect(terminal.stderr).toHaveBeenCalledWith(
-      expect.stringContaining('INFO')
-    );
-
-    expect(terminal.stderr).toHaveBeenCalledWith(
-      expect.stringContaining('WARN')
-    );
-
-    expect(terminal.stderr).toHaveBeenCalledWith(
-      expect.stringContaining('ERROR')
-    );
+    expect(stderr.getOutput()).toContain('DEBUG');
+    expect(stderr.getOutput()).toContain('INFO');
+    expect(stderr.getOutput()).toContain('WARN');
+    expect(stderr.getOutput()).toContain('ERROR');
   });
 
   it('includes the log namespace', () => {
-    const terminal = new MockConsole();
-    const backend = new AnsiTerminalBackend({ console: terminal });
+    const { terminal, stderr } = createTerminal();
+    const backend = createAnsiTerminalBackend({ console: terminal });
     const logger = createLogger(backend)
       .namespace('my-lib')
       .namespace('MyClass');
 
     logger.debug('initialized');
 
-    expect(terminal.stderr).toHaveBeenCalledWith(
-      expect.stringContaining('my-lib:MyClass')
-    );
+    expect(stderr.getOutput()).toContain('my-lib:MyClass');
   });
 
   it('includes the log context', () => {
-    const terminal = new MockConsole();
-    const backend = new AnsiTerminalBackend({ console: terminal });
+    const { terminal, stderr } = createTerminal();
+    const backend = createAnsiTerminalBackend({ console: terminal });
     const logger = createLogger(backend);
 
     logger.info('creating session', { sessionId: 3109 });
 
     // Hard to test without replicating the implementation.
-    expect(terminal.stderr).toHaveBeenCalledWith(
-      expect.stringContaining('sessionId')
-    );
-
-    expect(terminal.stderr).toHaveBeenCalledWith(
-      expect.stringContaining('3109')
-    );
+    expect(stderr.getOutput()).toContain('sessionId');
+    expect(stderr.getOutput()).toContain('3109');
   });
 
   it('does not include the log context if it is empty', () => {
-    const terminal = new MockConsole();
-    const backend = new AnsiTerminalBackend({ console: terminal });
+    const { terminal, stderr } = createTerminal();
+    const backend = createAnsiTerminalBackend({ console: terminal });
     const logger = createLogger(backend);
 
     logger.warn('activating death ray', {});
 
     // Hard to test without replicating the implementation.
-    expect(terminal.stderr).not.toHaveBeenCalledWith(
-      expect.stringContaining('{')
-    );
+    expect(stderr.getOutput()).not.toContain('{');
+    expect(stderr.getOutput()).not.toContain('}');
+  });
+
+  it('indents multiline strings', () => {
+    const { terminal, stderr } = createTerminal();
+    const backend = createAnsiTerminalBackend({ console: terminal });
+    const logger = createLogger(backend);
+
+    logger.info('This is a multiline string.\nIt has two lines.');
 
-    expect(terminal.stderr).not.toHaveBeenCalledWith(
-      expect.stringContaining('}')
-    );
+    expect(stderr.getOutput()).toContain('This is a multiline string.');
+    expect(stderr.getOutput()).toContain('  It has two lines.');
   });
 });

package/src/ansi-codes.ts

@@ -3,25 +3,19 @@ function ansiCode(code: string) {
 }
 
 /**
- * Unix only. This will break for win32 terminals and may spew garbage on
- * terminals without 4-bit color support.
- *
- * TODO: Strip colors on non-interactive TTYs.
+ * Assumes 3-bit color support for an ANSI terminal. This should work on most
+ * modern terminals, including on Windows.
  */
 
-export const color = {
-  black: ansiCode('30m'),
-  red: ansiCode('31m'),
-  green: ansiCode('32m'),
-  yellow: ansiCode('33m'),
-  blue: ansiCode('34m'),
-  magenta: ansiCode('35m'),
-  cyan: ansiCode('36m'),
-  white: ansiCode('37m'),
-};
+export const reset = ansiCode('0m');
+export const bold = ansiCode('1m');
+export const dim = ansiCode('2m');
 
-export const code = {
-  reset: ansiCode('0m'),
-  bold: ansiCode('1m'),
-  dim: ansiCode('2m'),
-};
+export const black = ansiCode('30m');
+export const red = ansiCode('31m');
+export const green = ansiCode('32m');
+export const yellow = ansiCode('33m');
+export const blue = ansiCode('34m');
+export const magenta = ansiCode('35m');
+export const cyan = ansiCode('36m');
+export const white = ansiCode('37m');

package/src/ansi-terminal-backend.ts

@@ -1,6 +1,6 @@
 import type { Log, LogProcessor } from '@holz/core';
 import { LogLevel } from '@holz/core';
-import { color, code } from './ansi-codes';
+import * as ansi from './ansi-codes';
 
 /**
  * A backend that prints logs to a 3-bit ansi terminal. This should work on
@@ -11,20 +11,18 @@ import { color, code } from './ansi-codes';
  * ques, the printed text is much less understandable. It is better to check
  * when constructing the logger instead.
  */
-export default class AnsiTerminalBackend implements LogProcessor {
-  private console: MinimalConsole;
+export function createAnsiTerminalBackend(options: Options = {}): LogProcessor {
+  const output = options.console ?? console;
+  const labelSizeInWhitespace = ' '.repeat(LogLevel.Error.length);
 
-  constructor(options: Options = {}) {
-    this.console = options.console ?? console;
-  }
-
-  processLog(log: Log) {
-    const timestamp = this.getTimestamp(new Date());
+  return (log: Log) => {
+    const timestamp = formatAsTimestamp(new Date());
+    const timestampPrefix = `${ansi.reset}${ansi.dim}${timestamp}${ansi.reset}`;
     const segments = [
       {
         include: true,
         command: '%s',
-        content: `${code.reset}${code.dim}${timestamp}${code.reset}`,
+        content: timestampPrefix,
       },
       {
         include: true,
@@ -34,52 +32,55 @@ export default class AnsiTerminalBackend implements LogProcessor {
       {
         include: true,
         command: '%s',
-        content: log.message,
-      },
-      {
-        include: log.origin.length > 0,
-        command: '%s',
-        content: `${code.dim}${log.origin.join(':')}${code.reset}`,
+        content: log.message.replace(
+          /(\r?\n)/g,
+          `$1${timestampPrefix} ${labelSizeInWhitespace} `
+        ),
       },
       {
         include: Object.keys(log.context).length > 0,
         command: '%O',
         content: log.context,
       },
+      {
+        include: log.origin.length > 0,
+        command: '%s',
+        content: `${ansi.dim}${log.origin.join(':')}${ansi.reset}`,
+      },
     ].filter((segment) => segment.include);
 
     const format = segments.map((segment) => segment.command).join(' ');
     const values = segments.map((segment) => segment.content);
 
     // CLIs typically print interactive messages to stdout and logs to stderr.
-    this.console.error(format, ...values);
-  }
+    output.error(format, ...values);
+  };
+}
 
-  // ISO-8601 timestamp with milliseconds.
-  private getTimestamp(date: Date) {
-    const hours = date.getHours().toString().padStart(2, '0');
-    const minutes = date.getMinutes().toString().padStart(2, '0');
-    const seconds = date.getSeconds().toString().padStart(2, '0');
-    const milliseconds = date.getMilliseconds().toString().padStart(3, '0');
+// ISO-8601 timestamp with milliseconds.
+function formatAsTimestamp(date: Date) {
+  const hours = date.getHours().toString().padStart(2, '0');
+  const minutes = date.getMinutes().toString().padStart(2, '0');
+  const seconds = date.getSeconds().toString().padStart(2, '0');
+  const milliseconds = date.getMilliseconds().toString().padStart(3, '0');
 
-    return `[${hours}:${minutes}:${seconds}.${milliseconds}]`;
-  }
+  return `[${hours}:${minutes}:${seconds}.${milliseconds}]`;
 }
 
 // Trailing whitespace is important for alignment.
 const logLevelLabel: Record<LogLevel, string> = {
-  [LogLevel.Debug]: `${color.blue}DEBUG${code.reset}`,
-  [LogLevel.Info]: `${color.green}INFO${code.reset} `,
-  [LogLevel.Warn]: `${color.yellow}WARN${code.reset} `,
-  [LogLevel.Error]: `${color.red}ERROR${code.reset}`,
+  [LogLevel.Debug]: `${ansi.blue}DEBUG${ansi.reset}`,
+  [LogLevel.Info]: `${ansi.green}INFO${ansi.reset} `,
+  [LogLevel.Warn]: `${ansi.yellow}WARN${ansi.reset} `,
+  [LogLevel.Error]: `${ansi.red}ERROR${ansi.reset}`,
 };
 
 interface Options {
-  console?: MinimalConsole;
+  /**
+   * Defaults the global `console`, but in NodeJS you can create a console
+   * over any writable stream. It could be a file or a network socket.
+   *
+   * @see https://nodejs.org/api/console.html#new-consoleoptions
+   */
+  console?: Console;
 }
-
-/**
- * A subset of the Console interface. Must support printf-style interpolation.
- * @see https://console.spec.whatwg.org/#formatting-specifiers
- */
-export type MinimalConsole = Pick<Console, 'log' | 'error'>;

package/src/index.ts

@@ -1,4 +1 @@
-export {
-  default,
-  default as AnsiTerminalBackend,
-} from './ansi-terminal-backend';
+export { createAnsiTerminalBackend } from './ansi-terminal-backend';