@holz/ansi-terminal-backend 0.8.0-rc.3 → 0.8.2-rc.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Jesse Gibson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@holz/ansi-terminal-backend",
-  "version": "0.8.0-rc.3",
+  "version": "0.8.2-rc.0",
   "description": "An ANSI terminal backend for Holz",
   "type": "module",
   "repository": {
@@ -22,8 +22,7 @@
   "license": "MIT",
   "sideEffects": false,
   "files": [
-    "dist",
-    "src"
+    "dist"
   ],
   "keywords": [
     "holz-backend",
@@ -36,10 +35,10 @@
     "test:types": "tsc"
   },
   "peerDependencies": {
-    "@holz/core": "^0.8.0-rc.3"
+    "@holz/core": "^0.8.0"
   },
   "devDependencies": {
-    "@holz/core": "^0.8.0-rc.3",
+    "@holz/core": "^0.8.2-rc.0",
     "@types/node": "^22.0.0",
     "@vitest/coverage-v8": "^3.0.8",
     "typescript": "^5.8.2",
@@ -48,5 +47,5 @@
     "vite-tsconfig-paths": "^5.1.4",
     "vitest": "^3.0.8"
   },
-  "stableVersion": "0.7.0"
-}
+  "gitHead": "59a13334498d9c3f0952235ed6cb59e493558824"
+}

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

@@ -1,126 +0,0 @@
-import { Writable } from 'node:stream';
-import { Console } from 'node:console';
-import { createLogger } from '@holz/core';
-import { createAnsiTerminalBackend } from '../ansi-terminal-backend';
-
-const CURRENT_TIME = new Date('2020-06-15T03:05:07.010Z');
-
-describe('ANSI terminal backend', () => {
-  const createStream = () => {
-    let output = '';
-    const stream = new Writable({
-      write(chunk, _encoding, callback) {
-        output += String(chunk);
-        callback();
-      },
-    });
-
-    return {
-      getOutput: () => output,
-      stream,
-    };
-  };
-
-  // Named "terminal" to avoid conflict with `global.console`.
-  const createTerminal = () => {
-    const stdout = createStream();
-    const stderr = createStream();
-    const terminal = new Console({
-      stdout: stdout.stream,
-      stderr: stderr.stream,
-    });
-
-    return {
-      stdout,
-      stderr,
-      terminal,
-    };
-  };
-
-  beforeEach(() => {
-    vi.useFakeTimers({
-      now: CURRENT_TIME,
-    });
-  });
-
-  afterEach(() => {
-    vi.useRealTimers();
-  });
-
-  it('prints the message to the terminal', () => {
-    const { terminal, stderr } = createTerminal();
-    const backend = createAnsiTerminalBackend({ console: terminal });
-
-    const logger = createLogger(backend);
-    logger.info('hello world');
-
-    expect(stderr.getOutput()).toContain('hello world');
-  });
-
-  it('includes the log level', () => {
-    const { terminal, stderr } = createTerminal();
-    const backend = createAnsiTerminalBackend({ console: terminal });
-
-    const logger = createLogger(backend);
-    logger.trace('scream');
-    logger.debug('shout');
-    logger.info('normal');
-    logger.warn('hmmmm');
-    logger.error('oh no');
-    logger.fatal('goodbye');
-
-    expect(stderr.getOutput()).toContain('TRACE');
-    expect(stderr.getOutput()).toContain('DEBUG');
-    expect(stderr.getOutput()).toContain('INFO');
-    expect(stderr.getOutput()).toContain('WARN');
-    expect(stderr.getOutput()).toContain('ERROR');
-    expect(stderr.getOutput()).toContain('FATAL');
-  });
-
-  it('includes the log namespace', () => {
-    const { terminal, stderr } = createTerminal();
-    const backend = createAnsiTerminalBackend({ console: terminal });
-    const logger = createLogger(backend)
-      .namespace('my-lib')
-      .namespace('MyClass');
-
-    logger.debug('initialized');
-
-    expect(stderr.getOutput()).toContain('my-lib:MyClass');
-  });
-
-  it('includes the log context', () => {
-    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(stderr.getOutput()).toContain('sessionId');
-    expect(stderr.getOutput()).toContain('3109');
-  });
-
-  it('does not include the log context if it is empty', () => {
-    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(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(stderr.getOutput()).toContain('This is a multiline string.');
-    expect(stderr.getOutput()).toContain('  It has two lines.');
-  });
-});

package/src/ansi-codes.ts

@@ -1,20 +0,0 @@
-const ansiCode = (code: string) => `\x1b[${code}`;
-
-/**
- * Assumes 3-bit color support for an ANSI terminal. This should work on most
- * modern terminals, including on Windows.
- */
-
-export const reset = ansiCode('0m');
-export const bold = ansiCode('1m');
-export const 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');
-export const brightWhite = ansiCode('97m');

package/src/ansi-terminal-backend.ts

@@ -1,90 +0,0 @@
-import { level, type LogLevel, type Log, type LogProcessor } from '@holz/core';
-import * as ansi from './ansi-codes';
-
-/**
- * A backend that prints logs to a 3-bit ansi terminal. This should work on
- * most Unix systems and Windows >= 10.
- *
- * NOTE: This is not smart enough to detect if the output is a TTY or if it
- * supports colors, nor is this the appropriate place to check. Without color
- * ques, the printed text is much less understandable. It is better to check
- * when constructing the logger instead.
- */
-export const createAnsiTerminalBackend = (
-  options: Options = {},
-): LogProcessor => {
-  const output = options.console ?? console;
-  const labelSizeInWhitespace = ' '.repeat(5); // char length of longest level type
-
-  return (log: Log) => {
-    const timestamp = formatAsTimestamp(new Date(log.timestamp));
-    const timestampPrefix = `${ansi.reset}${ansi.dim}${timestamp}${ansi.reset}`;
-    const segments = [
-      {
-        include: true,
-        command: '%s',
-        content: timestampPrefix,
-      },
-      {
-        include: true,
-        command: '%s',
-        content: logLevelLabel[log.level],
-      },
-      {
-        include: true,
-        command: '%s',
-        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.
-    output.error(format, ...values);
-  };
-};
-
-// This is an interactive TTY, so we can assume someone is watching. They
-// probably know what day it is. Focus on the time.
-const 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}]`;
-};
-
-// Trailing whitespace is important for alignment.
-const logLevelLabel: Record<LogLevel, string> = {
-  [level.trace]: `${ansi.brightWhite}TRACE${ansi.reset}`,
-  [level.debug]: `${ansi.blue}DEBUG${ansi.reset}`,
-  [level.info]: `${ansi.green}INFO${ansi.reset} `,
-  [level.warn]: `${ansi.yellow}WARN${ansi.reset} `,
-  [level.error]: `${ansi.red}ERROR${ansi.reset}`,
-  [level.fatal]: `${ansi.bold}${ansi.red}FATAL${ansi.reset}`,
-};
-
-interface Options {
-  /**
-   * 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;
-}

package/src/index.ts

@@ -1 +0,0 @@
-export { createAnsiTerminalBackend } from './ansi-terminal-backend';