@datainkio/lumberjack

Styled logging for both:

• Node.js terminals (uses chalk if installed)
• Browser DevTools console (uses %c + CSS)

Logging is disabled by default. You must explicitly enable it.

Install

npm install @datainkio/lumberjack

This is a private scoped package. You’ll need npm auth configured for the @datainkio scope.

Optional: terminal colors (Node.js)

chalk is an optional peer dependency. If you want colored terminal output:

npm install chalk

Usage

Default singleton logger

import lumberjack from "@datainkio/lumberjack";

// enable output
lumberjack.enabled = true;

lumberjack.trace("Hello", { a: 1 }, "brief", "default");
lumberjack.trace("Heads up", { priority: "high" }, "brief", "headsup");
lumberjack.trace("Success", { id: 123 }, "brief", "success");
lumberjack.trace("Error", { code: 500 }, "brief", "error");

Import the class + style helpers

import { Lumberjack, LumberjackStyles } from "@datainkio/lumberjack";

Lumberjack.configure({ enabled: true });
Lumberjack.trace("Using the static API", { ok: true }, "brief", LumberjackStyles.HEADSUP);

Subpath imports

import Lumberjack from "@datainkio/lumberjack/Lumberjack";
import LumberjackStyle from "@datainkio/lumberjack/LumberjackStyle";
import LumberjackStyles from "@datainkio/lumberjack/LumberjackStyles";

const purple = new LumberjackStyle("#9333EA", "🎨", "bold", 12);

Lumberjack.configure({ enabled: true });
Lumberjack.trace("Custom style", { theme: "purple" }, "brief", purple);
Lumberjack.trace("Built-in style", { ok: true }, "brief", LumberjackStyles.SUCCESS);

Scoped loggers

import { Lumberjack } from "@datainkio/lumberjack";

const api = Lumberjack.createScoped("API", { prefix: "🌐", color: "#60A5FA" });
api.trace("Request started", { url: "/health" }, "brief", "headsup");

Modes and styles

• Modes: "brief" (default), "verbose", "silent"
• Style names: "default", "headsup", "success", "error"

Development

• Build published artifacts: npm run build (copies src/ → dist/)
• Sync docs vendor bundle: npm run docs:vendor (copies dist/ → docs/assets/js/vendors/lumberjack/)
• Syntax-check dist output: npm run lint