Pretty log messages with color, format, and cursor manipulation.

npm install @t-ski/pretty-log

Example Log

Example Source

prettyLog.BOLD.fg.WHITE.bg.color(128, 128, 255)(
  ` ${prettyLog.UNDERLINE("Example")} `
)

Pretty Log has a simple API: Provide an arbitrary chain of style expressions that are finally applied to a target string.

import prettyLog from "t-ski/pretty-log";

prettyLog.[<style-expression>]+(targetString: string): string;

Pretty log styled strings are nestable, i.e. can be embedded within styled strings themselves.

prettyLog.<fg|bg>.<Color>
// OR
prettyLog.<fg|bg>.color(r: number, g: number, b: number)
prettyLog.<fg|bg>.color(hex: string)

Color styles must be prepended by a color channel. fg indicates the foreground color channel, whereas bg is for the complementary background color channel.

prettyLog.bg.RED.fg.color(245, 245, 245)("Example");

prettyLog.<Format>

Whether and how styles are displayed depends on the console application.

prettyLog.BOLD.UNDERLINE("Example");

prettyLog.<Cursor>
// OR
prettyLog.cursor(x: number, y: number)

prettyLog.CLEAR(".".repeat((++iteration % 3) + 1));

Assigning frequently used style chains to reusable macro variables might be helpful:

const CODE = prettyLog.BOLD.fg.ORANGE;
console.log(CODE(".method()"));

function badge(message) {
  console.log(
    prettyLog.BOLD.fg.WHITE.bg.color(128, 128, 255)(
      ` ${prettyLog.UNDERLINE(message.toUpperCase())} `
    )
  );
}
badge("Results");

_{© Thassilo Martin Schiepanski}