Papyrus-Pretty

A formatter for Papyrus that makes your logs pretty.

How to use

Basic usage:

import { Papyrus } from "https://deno.land/x/papyrus/mod.ts";
import { PapyrusPretty } from "https://deno.land/x/papyrus-pretty/mod.ts";

const logger = new Papyrus({
  formatter: new PapyrusPretty
});

logger.trace("This is a trace");
logger.debug("This is a debug");
logger.info("This is an info");
logger.warn("This is a warning");
logger.error("This is an error");

Or with options:

import { Papyrus } from "https://deno.land/x/papyrus/mod.ts";
import { PapyrusPretty } from "https://deno.land/x/papyrus-pretty/mod.ts";

const logger = new Papyrus({
  formatter: new PapyrusPretty({
    // options...
  })
});

logger.trace("This is a trace");
logger.debug("This is a debug");
logger.info("This is an info");
logger.warn("This is a warning");
logger.error("This is an error");

Table of contents

• Table of contents
• Using bindings
• Using payloads
• Options
  • PPrettyOptions
  • ColorOptions
• Contributions

Using bindings

Papyrus-Pretty can print your logger’s bindings but there is a caveat: mergeBindings must be set to false. Here is an example:

const bindings = {
  arch: Deno.build.arch,
  os: Deno.build.os,
  pid: Deno.pid,
}

const logger = new Papyrus({
  bindings,
  mergeBindings: false,
  formatter: new PapyrusPretty
});

logger.info("This is an info");

Using payloads

Papyrus-Pretty can also print your logger’s payloads but, you guessed-it, there is once again a caveat: mergePayload must be set to false. Here is an example:

const logger = new Papyrus({
  mergePayload: false,
  formatter: new PapyrusPretty
});

const payload = {
  x: 0.12,
  y: 0.71,
  z: 0.35,
}

logger.info("This is an info", payload);

Options

PPrettyOptions

Papyrus-Pretty can be configured through an object that implements the interface PPrettyOptions. All properties are optional.

interface PPrettyOptions {
  colors?: boolean | ColorOptions;
  ignore?: string[];
  time?: boolean;
  timeFormat?: string;
}

ColorOptions

A ColorOptions configuration object must be provided when creating a child logger.

interface ColorOptions {
  debug?: ColorFunction;
  error?: ColorFunction;
  info?: ColorFunction;
  keys?: ColorFunction;
  stack?: ColorFunction;
  time?: ColorFunction;
  trace?: ColorFunction;
  warn?: ColorFunction;
}

ColorFunction

A ColorFunction is a function that takes a string and returns a modified string. We name it ColorFunction because it corresponds to the signature of the functions from https://deno.land/std/fmt/colors.ts which Papyrus-Pretty is using behind the scene.

type ColorFunction = (str: string) => string;

Contributions

PRs are welcome!