console-toolkit/src/output/show.js

Toolkit to produce a fancy console output (boxes, tables, charts, colors).

import process from 'node:process';
import {matchCsiNoGroups} from '../strings.js';
import Box from '../box.js';

export const log = (s, {endOfLineCommand = '\x1B[m', colorDepth = 24} = {}) => {
  s = Box.make(s);
  if (colorDepth < 4) {
    matchCsiNoGroups.lastIndex = 0;
    s.box.forEach(row => console.log((row + endOfLineCommand).replace(matchCsiNoGroups, '')));
    return;
  }
  s.box.forEach(row => console.log(row + endOfLineCommand));
};

export const out = (s, {stream = process.stdout, endOfLineCommand = '\x1B[m', colorDepth} = {}) => {
  s = Box.make(s);
  if (typeof colorDepth != 'number' || isNaN(colorDepth)) colorDepth = stream.isTTY ? stream.getColorDepth() : 1;
  if (colorDepth < 4) {
    matchCsiNoGroups.lastIndex = 0;
    s.box.forEach(row => stream.write((row + endOfLineCommand).replace(matchCsiNoGroups, '') + '\n'));
    return;
  }
  s.box.forEach(row => stream.write(row + endOfLineCommand + '\n'));
};

export class Out {
  constructor(stream) {
    this.stream = stream;
    this.colorDepth = stream.isTTY ? stream.getColorDepth() : 1;
  }
  out(s, {endOfLineCommand = '\x1B[m', colorDepth} = {}) {
    if (typeof colorDepth != 'number' || isNaN(colorDepth)) colorDepth = this.colorDepth;
    return out(s, {stream: this.stream, endOfLineCommand, colorDepth});
  }
}

export const debug = string =>
  console.log(
    string.replace(/[\x00-\x1F]/g, m => '\\x' + m[0].charCodeAt(0).toString(16).padStart(2, '0').toUpperCase())
  );