@holz/console-backend 0.7.0 → 0.8.0-rc.2

package/dist/holz-console-backend.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const a=1e3,c=60*a,u=60*c,l=24*u,f=(s,r=s)=>{const e=s.getTime()-r.getTime(),t=Math.abs(e),n=e<0?"":"+";return t>=l?`${n}${Math.round(e/l)}d`:t>=u?`${n}${Math.round(e/u)}h`:t>=c?`${n}${Math.round(e/c)}m`:t>=a?`${n}${Math.round(e/a)}s`:`${n}${e}ms`};function $(s={}){const r=s.console??console;let e;return t=>{const n=new Date,i=[{include:!0,format:"%s",values:[t.message]},{include:Object.keys(t.context).length>0,format:"%o",values:[t.context]},{include:!0,format:"%c%s",values:["color: gray",f(n,e)]},{include:t.origin.length>0,format:"%c%s",values:["color: rgba(128, 128, 128, 0.6); font-style: italic",t.origin.join(":")]}].filter(o=>o.include),m=i.map(o=>o.format).join(" "),d=i.flatMap(o=>o.values);r[t.level](m,...d),e=n}}exports.createConsoleBackend=$;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const r={fatal:60,error:50,warn:40,info:30,debug:20,trace:10},c=1e3,i=60*c,u=60*i,f=24*u,g=(a,s=a)=>{const t=a.getTime()-s.getTime(),e=Math.abs(t),n=t<0?"":"+";return e>=f?`${n}${Math.round(t/f)}d`:e>=u?`${n}${Math.round(t/u)}h`:e>=i?`${n}${Math.round(t/i)}m`:e>=c?`${n}${Math.round(t/c)}s`:`${n}${t}ms`},$=(a={})=>{const s=a.console??console;let t;return e=>{const n=new Date(e.timestamp),l=[{include:!0,format:"%s",values:[e.message]},{include:Object.keys(e.context).length>0,format:"%o",values:[e.context]},{include:!0,format:"%c%s",values:["color: gray",g(n,t)]},{include:e.origin.length>0,format:"%c%s",values:["color: rgba(128, 128, 128, 0.6); font-style: italic",e.origin.join(":")]}].filter(o=>o.include),m=l.map(o=>o.format).join(" "),d=l.flatMap(o=>o.values);s[h[e.level]](m,...d),t=n}},h={[r.trace]:"trace",[r.debug]:"debug",[r.info]:"info",[r.warn]:"warn",[r.error]:"error",[r.fatal]:"error"};exports.createConsoleBackend=$;

package/dist/holz-console-backend.d.ts

@@ -4,13 +4,16 @@ import { LogProcessor } from '@holz/core';
  * A backend that pretty-prints logs to a browser console, or any
  * remote-attached console.
  */
-export declare function createConsoleBackend(options?: Options): LogProcessor;
+export declare const createConsoleBackend: (options?: Options) => LogProcessor;
 
 /**
  * A subset of the Console interface. Must support printf-style interpolation.
  * @see https://console.spec.whatwg.org/#formatting-specifiers
+ *
+ * Note that `fatal` has no corresponding equivalent. It will be downgraded to
+ * `error` when printed.
  */
-declare type MinimalConsole = Pick<Console, 'debug' | 'info' | 'warn' | 'error'>;
+declare type MinimalConsole = Pick<Console, 'trace' | 'debug' | 'info' | 'warn' | 'error'>;
 
 declare interface Options {
     console?: MinimalConsole;

package/dist/holz-console-backend.js

@@ -1,12 +1,24 @@
-const i = (s, r = s) => {
-  const e = s.getTime() - r.getTime(), t = Math.abs(e), n = e < 0 ? "" : "+";
-  return t >= 864e5 ? `${n}${Math.round(e / 864e5)}d` : t >= 36e5 ? `${n}${Math.round(e / 36e5)}h` : t >= 6e4 ? `${n}${Math.round(e / 6e4)}m` : t >= 1e3 ? `${n}${Math.round(e / 1e3)}s` : `${n}${e}ms`;
-};
-function l(s = {}) {
-  const r = s.console ?? console;
+const r = {
+  /** A critical failure happened and the program must exit. */
+  fatal: 60,
+  /** Something failed, but we can keep going. */
+  error: 50,
+  /** Cause for concern, but we can keep going. */
+  warn: 40,
+  /** High-level progress updates. */
+  info: 30,
+  /** Verbose update about events or control flow (usually hidden). */
+  debug: 20,
+  /** Extremely detailed progress updates (usually hidden). */
+  trace: 10
+}, c = 1e3, i = 60 * c, u = 60 * i, f = 24 * u, $ = (a, s = a) => {
+  const e = a.getTime() - s.getTime(), t = Math.abs(e), n = e < 0 ? "" : "+";
+  return t >= f ? `${n}${Math.round(e / f)}d` : t >= u ? `${n}${Math.round(e / u)}h` : t >= i ? `${n}${Math.round(e / i)}m` : t >= c ? `${n}${Math.round(e / c)}s` : `${n}${e}ms`;
+}, g = (a = {}) => {
+  const s = a.console ?? console;
   let e;
   return (t) => {
-    const n = /* @__PURE__ */ new Date(), c = [
+    const n = new Date(t.timestamp), l = [
       {
         include: !0,
         format: "%s",
@@ -21,7 +33,7 @@ function l(s = {}) {
       {
         include: !0,
         format: "%c%s",
-        values: ["color: gray", i(n, e)]
+        values: ["color: gray", $(n, e)]
       },
       {
         include: t.origin.length > 0,
@@ -31,10 +43,17 @@ function l(s = {}) {
           t.origin.join(":")
         ]
       }
-    ].filter((o) => o.include), a = c.map((o) => o.format).join(" "), u = c.flatMap((o) => o.values);
-    r[t.level](a, ...u), e = n;
+    ].filter((o) => o.include), m = l.map((o) => o.format).join(" "), d = l.flatMap((o) => o.values);
+    s[h[t.level]](m, ...d), e = n;
   };
-}
+}, h = {
+  [r.trace]: "trace",
+  [r.debug]: "debug",
+  [r.info]: "info",
+  [r.warn]: "warn",
+  [r.error]: "error",
+  [r.fatal]: "error"
+};
 export {
-  l as createConsoleBackend
+  g as createConsoleBackend
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@holz/console-backend",
-  "version": "0.7.0",
+  "version": "0.8.0-rc.2",
   "description": "A console backend for Holz",
   "type": "module",
   "repository": {
@@ -37,16 +37,17 @@
     "test:types": "tsc"
   },
   "peerDependencies": {
-    "@holz/core": "0.7.0"
+    "@holz/core": "^0.8.0-rc.2"
   },
   "devDependencies": {
-    "@holz/core": "^0.7.0",
+    "@holz/core": "^0.8.0-rc.2",
     "@types/node": "^22.0.0",
     "@vitest/coverage-v8": "^3.0.8",
-    "typescript": "^5.0.0",
+    "typescript": "^5.8.2",
     "vite": "^6.0.0",
     "vite-plugin-dts": "^4.5.3",
     "vite-tsconfig-paths": "^5.1.4",
     "vitest": "^3.0.8"
-  }
+  },
+  "stableVersion": "0.7.0"
 }

package/src/__tests__/__snapshots__/console-backend.test.ts.snap

@@ -28,6 +28,20 @@ exports[`Console backend > avoids changing error messages 1`] = `
 ]
 `;
 
+exports[`Console backend > avoids changing fatal messages 1`] = `
+[
+  "%s %o %c%s %c%s",
+  "a fatal error",
+  {
+    "id": 1234,
+  },
+  "color: gray",
+  "+0ms",
+  "color: rgba(128, 128, 128, 0.6); font-style: italic",
+  "ns-1:ns-2",
+]
+`;
+
 exports[`Console backend > avoids changing info messages 1`] = `
 [
   "%s %o %c%s %c%s",
@@ -42,6 +56,20 @@ exports[`Console backend > avoids changing info messages 1`] = `
 ]
 `;
 
+exports[`Console backend > avoids changing trace messages 1`] = `
+[
+  "%s %o %c%s %c%s",
+  "noise",
+  {
+    "id": 1234,
+  },
+  "color: gray",
+  "+0ms",
+  "color: rgba(128, 128, 128, 0.6); font-style: italic",
+  "ns-1:ns-2",
+]
+`;
+
 exports[`Console backend > avoids changing warn messages 1`] = `
 [
   "%s %o %c%s %c%s",

package/src/__tests__/console-backend.test.ts

@@ -8,6 +8,7 @@ class MockConsole implements MinimalConsole {
     this.print(format(level, ...strings));
   };
 
+  trace = vi.fn(this.fmt);
   debug = vi.fn(this.fmt);
   info = vi.fn(this.fmt);
   warn = vi.fn(this.fmt);
@@ -97,6 +98,7 @@ describe('Console backend', () => {
   // Snapshot the exact output of each log level. This mostly prevents
   // regressions while doing innocent refactors.
   it.each([
+    ['trace' as const, 'noise', ['ns-1', 'ns-2'], 'trace' as const],
     ['debug' as const, 'just spam', ['ns-1', 'ns-2'], 'debug' as const],
     ['info' as const, 'a little info', ['ns-1', 'ns-2'], 'info' as const],
     ['warn' as const, 'a warning', ['ns-1', 'ns-2'], 'warn' as const],
@@ -106,6 +108,7 @@ describe('Console backend', () => {
       ['ns-1', 'ns-2'],
       'error' as const,
     ],
+    ['fatal' as const, 'a fatal error', ['ns-1', 'ns-2'], 'error' as const],
   ])('avoids changing %s messages', (method, message, namespace, pipe) => {
     const output = new MockConsole();
     const backend = createConsoleBackend({ console: output });

package/src/console-backend.ts

@@ -1,16 +1,16 @@
-import type { Log, LogProcessor } from '@holz/core';
+import { level, type LogLevel, type Log, type LogProcessor } from '@holz/core';
 import { timeDelta } from './time-delta';
 
 /**
  * A backend that pretty-prints logs to a browser console, or any
  * remote-attached console.
  */
-export function createConsoleBackend(options: Options = {}): LogProcessor {
+export const createConsoleBackend = (options: Options = {}): LogProcessor => {
   const output = options.console ?? console;
   let lastTimestamp: Date;
 
   return (log: Log) => {
-    const now = new Date();
+    const time = new Date(log.timestamp);
 
     const segments = [
       {
@@ -26,7 +26,7 @@ export function createConsoleBackend(options: Options = {}): LogProcessor {
       {
         include: true,
         format: '%c%s',
-        values: ['color: gray', timeDelta(now, lastTimestamp)],
+        values: ['color: gray', timeDelta(time, lastTimestamp)],
       },
       {
         include: log.origin.length > 0,
@@ -42,12 +42,21 @@ export function createConsoleBackend(options: Options = {}): LogProcessor {
     const values = segments.flatMap<unknown>((segment) => segment.values);
 
     // Browsers have UIs for filtering by log level. Leverage that.
-    output[log.level](format, ...values);
+    output[sink[log.level]](format, ...values);
 
     // Track the time spent between logs.
-    lastTimestamp = now;
+    lastTimestamp = time;
   };
-}
+};
+
+const sink: Record<LogLevel, keyof MinimalConsole> = {
+  [level.trace]: 'trace',
+  [level.debug]: 'debug',
+  [level.info]: 'info',
+  [level.warn]: 'warn',
+  [level.error]: 'error',
+  [level.fatal]: 'error',
+};
 
 interface Options {
   console?: MinimalConsole;
@@ -56,5 +65,11 @@ interface Options {
 /**
  * A subset of the Console interface. Must support printf-style interpolation.
  * @see https://console.spec.whatwg.org/#formatting-specifiers
+ *
+ * Note that `fatal` has no corresponding equivalent. It will be downgraded to
+ * `error` when printed.
  */
-export type MinimalConsole = Pick<Console, 'debug' | 'info' | 'warn' | 'error'>;
+export type MinimalConsole = Pick<
+  Console,
+  'trace' | 'debug' | 'info' | 'warn' | 'error'
+>;