@logtape/logtape 0.5.1 → 0.6.0-dev.73

package/esm/formatter.js

@@ -36,6 +36,81 @@ const inspect =
         // dnt-shim-ignore
         ? util.inspect.bind(util)
         : (v) => JSON.stringify(v);
+/**
+ * Get a text formatter with the specified options.  Although it's flexible
+ * enough to create a custom formatter, if you want more control, you can
+ * create a custom formatter that satisfies the {@link TextFormatter} type
+ * instead.
+ *
+ * For more information on the options, see {@link TextFormatterOptions}.
+ *
+ * By default, the formatter formats log records as follows:
+ *
+ * ```
+ * 2023-11-14 22:13:20.000 +00:00 [INF] category·subcategory: Hello, world!
+ * ```
+ * @param options The options for the text formatter.
+ * @returns The text formatter.
+ * @since 0.6.0
+ */
+export function getTextFormatter(options = {}) {
+    const timestampRenderer = options.timestamp == null || options.timestamp === "date-time-timezone"
+        ? (ts) => new Date(ts).toISOString().replace("T", " ").replace("Z", " +00:00")
+        : options.timestamp === "date-time-tz"
+            ? (ts) => new Date(ts).toISOString().replace("T", " ").replace("Z", " +00")
+            : options.timestamp === "date-time"
+                ? (ts) => new Date(ts).toISOString().replace("T", " ").replace("Z", "")
+                : options.timestamp === "time-timezone"
+                    ? (ts) => new Date(ts).toISOString().replace(/.*T/, "").replace("Z", " +00:00")
+                    : options.timestamp === "time-tz"
+                        ? (ts) => new Date(ts).toISOString().replace(/.*T/, "").replace("Z", " +00")
+                        : options.timestamp === "time"
+                            ? (ts) => new Date(ts).toISOString().replace(/.*T/, "").replace("Z", "")
+                            : options.timestamp === "date"
+                                ? (ts) => new Date(ts).toISOString().replace(/T.*/, "")
+                                : options.timestamp === "rfc3339"
+                                    ? (ts) => new Date(ts).toISOString()
+                                    : options.timestamp;
+    const categorySeparator = options.category ?? "·";
+    const valueRenderer = options.value ?? inspect;
+    const levelRenderer = options.level == null || options.level === "ABBR"
+        ? (level) => levelAbbreviations[level]
+        : options.level === "abbr"
+            ? (level) => levelAbbreviations[level].toLowerCase()
+            : options.level === "FULL"
+                ? (level) => level.toUpperCase()
+                : options.level === "full"
+                    ? (level) => level
+                    : options.level === "L"
+                        ? (level) => level.charAt(0).toUpperCase()
+                        : options.level === "l"
+                            ? (level) => level.charAt(0)
+                            : options.level;
+    const formatter = options.format ??
+        (({ timestamp, level, category, message }) => `${timestamp} [${level}] ${category}: ${message}`);
+    return (record) => {
+        let message = "";
+        for (let i = 0; i < record.message.length; i++) {
+            if (i % 2 === 0)
+                message += record.message[i];
+            else
+                message += valueRenderer(record.message[i]);
+        }
+        const timestamp = timestampRenderer(record.timestamp);
+        const level = levelRenderer(record.level);
+        const category = typeof categorySeparator === "function"
+            ? categorySeparator(record.category)
+            : record.category.join(categorySeparator);
+        const values = {
+            timestamp,
+            level,
+            category,
+            message,
+            record,
+        };
+        return `${formatter(values)}\n`;
+    };
+}
 /**
  * The default text formatter.  This formatter formats log records as follows:
  *
@@ -46,28 +121,84 @@ const inspect =
  * @param record The log record to format.
  * @returns The formatted log record.
  */
-export function defaultTextFormatter(record) {
-    const ts = new Date(record.timestamp);
-    let msg = "";
-    for (let i = 0; i < record.message.length; i++) {
-        if (i % 2 === 0)
-            msg += record.message[i];
-        else
-            msg += inspect(record.message[i]);
-    }
-    const category = record.category.join("\xb7");
-    return `${ts.toISOString().replace("T", " ").replace("Z", " +00:00")} [${levelAbbreviations[record.level]}] ${category}: ${msg}\n`;
-}
+export const defaultTextFormatter = getTextFormatter();
 const RESET = "\x1b[0m";
-const BOLD = "\x1b[1m";
-const DIM = "\x1b[2m";
-const levelColors = {
-    debug: "\x1b[34m", // Blue
-    info: "\x1b[32m", // Green
-    warning: "\x1b[33m", // Yellow
-    error: "\x1b[31m", // Red
-    fatal: "\x1b[35m", // Magenta
+const ansiColors = {
+    black: "\x1b[30m",
+    red: "\x1b[31m",
+    green: "\x1b[32m",
+    yellow: "\x1b[33m",
+    blue: "\x1b[34m",
+    magenta: "\x1b[35m",
+    cyan: "\x1b[36m",
+    white: "\x1b[37m",
+};
+const ansiStyles = {
+    bold: "\x1b[1m",
+    dim: "\x1b[2m",
+    italic: "\x1b[3m",
+    underline: "\x1b[4m",
+    strikethrough: "\x1b[9m",
+};
+const defaultLevelColors = {
+    debug: "blue",
+    info: "green",
+    warning: "yellow",
+    error: "red",
+    fatal: "magenta",
 };
+/**
+ * Get an ANSI color formatter with the specified options.
+ *
+ * ![A preview of an ANSI color formatter.](https://i.imgur.com/I8LlBUf.png)
+ * @param option The options for the ANSI color formatter.
+ * @returns The ANSI color formatter.
+ * @since 0.6.0
+ */
+export function getAnsiColorFormatter(options = {}) {
+    const format = options.format;
+    const timestampStyle = typeof options.timestampStyle === "undefined"
+        ? "dim"
+        : options.timestampStyle;
+    const timestampColor = options.timestampColor ?? null;
+    const timestampPrefix = `${timestampStyle == null ? "" : ansiStyles[timestampStyle]}${timestampColor == null ? "" : ansiColors[timestampColor]}`;
+    const timestampSuffix = timestampStyle == null && timestampColor == null
+        ? ""
+        : RESET;
+    const levelStyle = typeof options.levelStyle === "undefined"
+        ? "bold"
+        : options.levelStyle;
+    const levelColors = options.levelColors ?? defaultLevelColors;
+    const categoryStyle = typeof options.categoryStyle === "undefined"
+        ? "dim"
+        : options.categoryStyle;
+    const categoryColor = options.categoryColor ?? null;
+    const categoryPrefix = `${categoryStyle == null ? "" : ansiStyles[categoryStyle]}${categoryColor == null ? "" : ansiColors[categoryColor]}`;
+    const categorySuffix = categoryStyle == null && categoryColor == null
+        ? ""
+        : RESET;
+    return getTextFormatter({
+        timestamp: "date-time-tz",
+        value(value) {
+            return inspect(value, { colors: true });
+        },
+        ...options,
+        format({ timestamp, level, category, message, record }) {
+            const levelColor = levelColors[record.level];
+            timestamp = `${timestampPrefix}${timestamp}${timestampSuffix}`;
+            level = `${levelStyle == null ? "" : ansiStyles[levelStyle]}${levelColor == null ? "" : ansiColors[levelColor]}${level}${levelStyle == null && levelColor == null ? "" : RESET}`;
+            return format == null
+                ? `${timestamp} ${level} ${categoryPrefix}${category}:${categorySuffix} ${message}`
+                : format({
+                    timestamp,
+                    level,
+                    category: `${categoryPrefix}${category}${categorySuffix}`,
+                    message,
+                    record,
+                });
+        },
+    });
+}
 /**
  * A text formatter that uses ANSI colors to format log records.
  *
@@ -77,25 +208,7 @@ const levelColors = {
  * @returns The formatted log record.
  * @since 0.5.0
  */
-export const ansiColorFormatter = (record) => {
-    const ts = new Date(record.timestamp);
-    const timeString = ts.toISOString().replace("T", " ").replace("Z", " +00");
-    const category = record.category.join("·");
-    const levelColor = levelColors[record.level];
-    const levelAbbr = levelAbbreviations[record.level];
-    let message = "";
-    for (let i = 0; i < record.message.length; i++) {
-        if (i % 2 === 0) {
-            message += record.message[i];
-        }
-        else {
-            message += inspect(record.message[i], { colors: true });
-        }
-    }
-    return `${DIM}${timeString}${RESET} ` +
-        `${BOLD}${levelColor}${levelAbbr}${RESET} ` +
-        `${DIM}${category}:${RESET} ${message}\n`;
-};
+export const ansiColorFormatter = getAnsiColorFormatter();
 /**
  * The styles for the log level in the console.
  */

package/esm/mod.js

@@ -1,7 +1,7 @@
 export { ConfigError, configure, dispose, getConfig, reset, } from "./config.js";
 export { getFileSink, getRotatingFileSink } from "./filesink.node.js";
 export { getLevelFilter, toFilter, } from "./filter.js";
-export { ansiColorFormatter, defaultConsoleFormatter, defaultTextFormatter, } from "./formatter.js";
+export { ansiColorFormatter, defaultConsoleFormatter, defaultTextFormatter, getAnsiColorFormatter, getTextFormatter, } from "./formatter.js";
 export { isLogLevel, parseLogLevel } from "./level.js";
 export { getLogger } from "./logger.js";
 export { getConsoleSink, getStreamSink, withFilter, } from "./sink.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logtape/logtape",
-  "version": "0.5.1",
+  "version": "0.6.0-dev.73+f2d69483",
   "description": "Simple logging library with zero dependencies for Deno/Node.js/Bun/browsers",
   "keywords": [
     "logging",

package/script/formatter.js

@@ -3,8 +3,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ansiColorFormatter = void 0;
-exports.defaultTextFormatter = defaultTextFormatter;
+exports.ansiColorFormatter = exports.defaultTextFormatter = void 0;
+exports.getTextFormatter = getTextFormatter;
+exports.getAnsiColorFormatter = getAnsiColorFormatter;
 exports.defaultConsoleFormatter = defaultConsoleFormatter;
 const node_util_1 = __importDefault(require("node:util"));
 /**
@@ -44,6 +45,81 @@ const inspect =
         // dnt-shim-ignore
         ? node_util_1.default.inspect.bind(node_util_1.default)
         : (v) => JSON.stringify(v);
+/**
+ * Get a text formatter with the specified options.  Although it's flexible
+ * enough to create a custom formatter, if you want more control, you can
+ * create a custom formatter that satisfies the {@link TextFormatter} type
+ * instead.
+ *
+ * For more information on the options, see {@link TextFormatterOptions}.
+ *
+ * By default, the formatter formats log records as follows:
+ *
+ * ```
+ * 2023-11-14 22:13:20.000 +00:00 [INF] category·subcategory: Hello, world!
+ * ```
+ * @param options The options for the text formatter.
+ * @returns The text formatter.
+ * @since 0.6.0
+ */
+function getTextFormatter(options = {}) {
+    const timestampRenderer = options.timestamp == null || options.timestamp === "date-time-timezone"
+        ? (ts) => new Date(ts).toISOString().replace("T", " ").replace("Z", " +00:00")
+        : options.timestamp === "date-time-tz"
+            ? (ts) => new Date(ts).toISOString().replace("T", " ").replace("Z", " +00")
+            : options.timestamp === "date-time"
+                ? (ts) => new Date(ts).toISOString().replace("T", " ").replace("Z", "")
+                : options.timestamp === "time-timezone"
+                    ? (ts) => new Date(ts).toISOString().replace(/.*T/, "").replace("Z", " +00:00")
+                    : options.timestamp === "time-tz"
+                        ? (ts) => new Date(ts).toISOString().replace(/.*T/, "").replace("Z", " +00")
+                        : options.timestamp === "time"
+                            ? (ts) => new Date(ts).toISOString().replace(/.*T/, "").replace("Z", "")
+                            : options.timestamp === "date"
+                                ? (ts) => new Date(ts).toISOString().replace(/T.*/, "")
+                                : options.timestamp === "rfc3339"
+                                    ? (ts) => new Date(ts).toISOString()
+                                    : options.timestamp;
+    const categorySeparator = options.category ?? "·";
+    const valueRenderer = options.value ?? inspect;
+    const levelRenderer = options.level == null || options.level === "ABBR"
+        ? (level) => levelAbbreviations[level]
+        : options.level === "abbr"
+            ? (level) => levelAbbreviations[level].toLowerCase()
+            : options.level === "FULL"
+                ? (level) => level.toUpperCase()
+                : options.level === "full"
+                    ? (level) => level
+                    : options.level === "L"
+                        ? (level) => level.charAt(0).toUpperCase()
+                        : options.level === "l"
+                            ? (level) => level.charAt(0)
+                            : options.level;
+    const formatter = options.format ??
+        (({ timestamp, level, category, message }) => `${timestamp} [${level}] ${category}: ${message}`);
+    return (record) => {
+        let message = "";
+        for (let i = 0; i < record.message.length; i++) {
+            if (i % 2 === 0)
+                message += record.message[i];
+            else
+                message += valueRenderer(record.message[i]);
+        }
+        const timestamp = timestampRenderer(record.timestamp);
+        const level = levelRenderer(record.level);
+        const category = typeof categorySeparator === "function"
+            ? categorySeparator(record.category)
+            : record.category.join(categorySeparator);
+        const values = {
+            timestamp,
+            level,
+            category,
+            message,
+            record,
+        };
+        return `${formatter(values)}\n`;
+    };
+}
 /**
  * The default text formatter.  This formatter formats log records as follows:
  *
@@ -54,28 +130,84 @@ const inspect =
  * @param record The log record to format.
  * @returns The formatted log record.
  */
-function defaultTextFormatter(record) {
-    const ts = new Date(record.timestamp);
-    let msg = "";
-    for (let i = 0; i < record.message.length; i++) {
-        if (i % 2 === 0)
-            msg += record.message[i];
-        else
-            msg += inspect(record.message[i]);
-    }
-    const category = record.category.join("\xb7");
-    return `${ts.toISOString().replace("T", " ").replace("Z", " +00:00")} [${levelAbbreviations[record.level]}] ${category}: ${msg}\n`;
-}
+exports.defaultTextFormatter = getTextFormatter();
 const RESET = "\x1b[0m";
-const BOLD = "\x1b[1m";
-const DIM = "\x1b[2m";
-const levelColors = {
-    debug: "\x1b[34m", // Blue
-    info: "\x1b[32m", // Green
-    warning: "\x1b[33m", // Yellow
-    error: "\x1b[31m", // Red
-    fatal: "\x1b[35m", // Magenta
+const ansiColors = {
+    black: "\x1b[30m",
+    red: "\x1b[31m",
+    green: "\x1b[32m",
+    yellow: "\x1b[33m",
+    blue: "\x1b[34m",
+    magenta: "\x1b[35m",
+    cyan: "\x1b[36m",
+    white: "\x1b[37m",
+};
+const ansiStyles = {
+    bold: "\x1b[1m",
+    dim: "\x1b[2m",
+    italic: "\x1b[3m",
+    underline: "\x1b[4m",
+    strikethrough: "\x1b[9m",
+};
+const defaultLevelColors = {
+    debug: "blue",
+    info: "green",
+    warning: "yellow",
+    error: "red",
+    fatal: "magenta",
 };
+/**
+ * Get an ANSI color formatter with the specified options.
+ *
+ * ![A preview of an ANSI color formatter.](https://i.imgur.com/I8LlBUf.png)
+ * @param option The options for the ANSI color formatter.
+ * @returns The ANSI color formatter.
+ * @since 0.6.0
+ */
+function getAnsiColorFormatter(options = {}) {
+    const format = options.format;
+    const timestampStyle = typeof options.timestampStyle === "undefined"
+        ? "dim"
+        : options.timestampStyle;
+    const timestampColor = options.timestampColor ?? null;
+    const timestampPrefix = `${timestampStyle == null ? "" : ansiStyles[timestampStyle]}${timestampColor == null ? "" : ansiColors[timestampColor]}`;
+    const timestampSuffix = timestampStyle == null && timestampColor == null
+        ? ""
+        : RESET;
+    const levelStyle = typeof options.levelStyle === "undefined"
+        ? "bold"
+        : options.levelStyle;
+    const levelColors = options.levelColors ?? defaultLevelColors;
+    const categoryStyle = typeof options.categoryStyle === "undefined"
+        ? "dim"
+        : options.categoryStyle;
+    const categoryColor = options.categoryColor ?? null;
+    const categoryPrefix = `${categoryStyle == null ? "" : ansiStyles[categoryStyle]}${categoryColor == null ? "" : ansiColors[categoryColor]}`;
+    const categorySuffix = categoryStyle == null && categoryColor == null
+        ? ""
+        : RESET;
+    return getTextFormatter({
+        timestamp: "date-time-tz",
+        value(value) {
+            return inspect(value, { colors: true });
+        },
+        ...options,
+        format({ timestamp, level, category, message, record }) {
+            const levelColor = levelColors[record.level];
+            timestamp = `${timestampPrefix}${timestamp}${timestampSuffix}`;
+            level = `${levelStyle == null ? "" : ansiStyles[levelStyle]}${levelColor == null ? "" : ansiColors[levelColor]}${level}${levelStyle == null && levelColor == null ? "" : RESET}`;
+            return format == null
+                ? `${timestamp} ${level} ${categoryPrefix}${category}:${categorySuffix} ${message}`
+                : format({
+                    timestamp,
+                    level,
+                    category: `${categoryPrefix}${category}${categorySuffix}`,
+                    message,
+                    record,
+                });
+        },
+    });
+}
 /**
  * A text formatter that uses ANSI colors to format log records.
  *
@@ -85,26 +217,7 @@ const levelColors = {
  * @returns The formatted log record.
  * @since 0.5.0
  */
-const ansiColorFormatter = (record) => {
-    const ts = new Date(record.timestamp);
-    const timeString = ts.toISOString().replace("T", " ").replace("Z", " +00");
-    const category = record.category.join("·");
-    const levelColor = levelColors[record.level];
-    const levelAbbr = levelAbbreviations[record.level];
-    let message = "";
-    for (let i = 0; i < record.message.length; i++) {
-        if (i % 2 === 0) {
-            message += record.message[i];
-        }
-        else {
-            message += inspect(record.message[i], { colors: true });
-        }
-    }
-    return `${DIM}${timeString}${RESET} ` +
-        `${BOLD}${levelColor}${levelAbbr}${RESET} ` +
-        `${DIM}${category}:${RESET} ${message}\n`;
-};
-exports.ansiColorFormatter = ansiColorFormatter;
+exports.ansiColorFormatter = getAnsiColorFormatter();
 /**
  * The styles for the log level in the console.
  */

package/script/mod.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.withFilter = exports.getStreamSink = exports.getConsoleSink = exports.getLogger = exports.parseLogLevel = exports.isLogLevel = exports.defaultTextFormatter = exports.defaultConsoleFormatter = exports.ansiColorFormatter = exports.toFilter = exports.getLevelFilter = exports.getRotatingFileSink = exports.getFileSink = exports.reset = exports.getConfig = exports.dispose = exports.configure = exports.ConfigError = void 0;
+exports.withFilter = exports.getStreamSink = exports.getConsoleSink = exports.getLogger = exports.parseLogLevel = exports.isLogLevel = exports.getTextFormatter = exports.getAnsiColorFormatter = exports.defaultTextFormatter = exports.defaultConsoleFormatter = exports.ansiColorFormatter = exports.toFilter = exports.getLevelFilter = exports.getRotatingFileSink = exports.getFileSink = exports.reset = exports.getConfig = exports.dispose = exports.configure = exports.ConfigError = void 0;
 var config_js_1 = require("./config.js");
 Object.defineProperty(exports, "ConfigError", { enumerable: true, get: function () { return config_js_1.ConfigError; } });
 Object.defineProperty(exports, "configure", { enumerable: true, get: function () { return config_js_1.configure; } });
@@ -17,6 +17,8 @@ var formatter_js_1 = require("./formatter.js");
 Object.defineProperty(exports, "ansiColorFormatter", { enumerable: true, get: function () { return formatter_js_1.ansiColorFormatter; } });
 Object.defineProperty(exports, "defaultConsoleFormatter", { enumerable: true, get: function () { return formatter_js_1.defaultConsoleFormatter; } });
 Object.defineProperty(exports, "defaultTextFormatter", { enumerable: true, get: function () { return formatter_js_1.defaultTextFormatter; } });
+Object.defineProperty(exports, "getAnsiColorFormatter", { enumerable: true, get: function () { return formatter_js_1.getAnsiColorFormatter; } });
+Object.defineProperty(exports, "getTextFormatter", { enumerable: true, get: function () { return formatter_js_1.getTextFormatter; } });
 var level_js_1 = require("./level.js");
 Object.defineProperty(exports, "isLogLevel", { enumerable: true, get: function () { return level_js_1.isLogLevel; } });
 Object.defineProperty(exports, "parseLogLevel", { enumerable: true, get: function () { return level_js_1.parseLogLevel; } });

package/types/formatter.d.ts

@@ -1,3 +1,4 @@
+import type { LogLevel } from "./level.js";
 import type { LogRecord } from "./record.js";
 /**
  * A text formatter is a function that accepts a log record and returns
@@ -7,6 +8,129 @@ import type { LogRecord } from "./record.js";
  * @returns The formatted log record.
  */
 export type TextFormatter = (record: LogRecord) => string;
+/**
+ * The formatted values for a log record.
+ * @since 0.6.0
+ */
+export interface FormattedValues {
+    /**
+     * The formatted timestamp.
+     */
+    timestamp: string;
+    /**
+     * The formatted log level.
+     */
+    level: string;
+    /**
+     * The formatted category.
+     */
+    category: string;
+    /**
+     * The formatted message.
+     */
+    message: string;
+    /**
+     * The unformatted log record.
+     */
+    record: LogRecord;
+}
+/**
+ * The various options for the built-in text formatters.
+ * @since 0.6.0
+ */
+export interface TextFormatterOptions {
+    /**
+     * The timestamp format.  This can be one of the following:
+     *
+     * - `"date-time-timezone"`: The date and time with the full timezone offset
+     *   (e.g., `"2023-11-14 22:13:20.000 +00:00"`).
+     * - `"date-time-tz"`: The date and time with the short timezone offset
+     *   (e.g., `"2023-11-14 22:13:20.000 +00"`).
+     * - `"date-time"`: The date and time without the timezone offset
+     *   (e.g., `"2023-11-14 22:13:20.000"`).
+     * - `"time-timezone"`: The time with the full timezone offset but without
+     *   the date (e.g., `"22:13:20.000 +00:00"`).
+     * - `"time-tz"`: The time with the short timezone offset but without the date
+     *   (e.g., `"22:13:20.000 +00"`).
+     * - `"time"`: The time without the date or timezone offset
+     *   (e.g., `"22:13:20.000"`).
+     * - `"date"`: The date without the time or timezone offset
+     *   (e.g., `"2023-11-14"`).
+     * - `"rfc3339"`: The date and time in RFC 3339 format
+     *   (e.g., `"2023-11-14T22:13:20.000Z"`).
+     *
+     * Alternatively, this can be a function that accepts a timestamp and returns
+     * a string.
+     *
+     * The default is `"date-time-timezone"`.
+     */
+    timestamp?: "date-time-timezone" | "date-time-tz" | "date-time" | "time-timezone" | "time-tz" | "time" | "date" | "rfc3339" | ((ts: number) => string);
+    /**
+     * The log level format.  This can be one of the following:
+     *
+     * - `"ABBR"`: The log level abbreviation in uppercase (e.g., `"INF"`).
+     * - `"FULL"`: The full log level name in uppercase (e.g., `"INFO"`).
+     * - `"L"`: The first letter of the log level in uppercase (e.g., `"I"`).
+     * - `"abbr"`: The log level abbreviation in lowercase (e.g., `"inf"`).
+     * - `"full"`: The full log level name in lowercase (e.g., `"info"`).
+     * - `"l"`: The first letter of the log level in lowercase (e.g., `"i"`).
+     *
+     * Alternatively, this can be a function that accepts a log level and returns
+     * a string.
+     *
+     * The default is `"ABBR"`.
+     */
+    level?: "ABBR" | "FULL" | "L" | "abbr" | "full" | "l" | ((level: LogLevel) => string);
+    /**
+     * The separator between category names.  For example, if the separator is
+     * `"·"`, the category `["a", "b", "c"]` will be formatted as `"a·b·c"`.
+     * The default separator is `"·"`.
+     *
+     * If this is a function, it will be called with the category array and
+     * should return a string, which will be used as the category string.
+     */
+    category?: string | ((category: readonly string[]) => string);
+    /**
+     * A function that renders a value to a string.  This function is used to
+     * render the values in the log record.  The default is `util.inspect` in
+     * Node.js/Bun and `Deno.inspect` in Deno.
+     * @param value The value to render.
+     * @returns The string representation of the value.
+     */
+    value?: (value: unknown) => string;
+    /**
+     * A function that formats the log record.  This function is called with the
+     * formatted values and should return a string.  Note that the formatted
+     * *should not* include a newline character at the end.
+     *
+     * By default, this is a function that formats the log record as follows:
+     *
+     * ```
+     * 2023-11-14 22:13:20.000 +00:00 [INF] category·subcategory: Hello, world!
+     * ```
+     * @param values The formatted values.
+     * @returns The formatted log record.
+     */
+    format?: (values: FormattedValues) => string;
+}
+/**
+ * Get a text formatter with the specified options.  Although it's flexible
+ * enough to create a custom formatter, if you want more control, you can
+ * create a custom formatter that satisfies the {@link TextFormatter} type
+ * instead.
+ *
+ * For more information on the options, see {@link TextFormatterOptions}.
+ *
+ * By default, the formatter formats log records as follows:
+ *
+ * ```
+ * 2023-11-14 22:13:20.000 +00:00 [INF] category·subcategory: Hello, world!
+ * ```
+ * @param options The options for the text formatter.
+ * @returns The text formatter.
+ * @since 0.6.0
+ */
+export declare function getTextFormatter(options?: TextFormatterOptions): TextFormatter;
 /**
  * The default text formatter.  This formatter formats log records as follows:
  *
@@ -17,7 +141,88 @@ export type TextFormatter = (record: LogRecord) => string;
  * @param record The log record to format.
  * @returns The formatted log record.
  */
-export declare function defaultTextFormatter(record: LogRecord): string;
+export declare const defaultTextFormatter: TextFormatter;
+/**
+ * The ANSI colors.  These can be used to colorize text in the console.
+ * @since 0.6.0
+ */
+export type AnsiColor = "black" | "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white";
+/**
+ * The ANSI text styles.
+ * @since 0.6.0
+ */
+export type AnsiStyle = "bold" | "dim" | "italic" | "underline" | "strikethrough";
+/**
+ * The various options for the ANSI color formatter.
+ * @since 0.6.0
+ */
+export interface AnsiColorFormatterOptions extends TextFormatterOptions {
+    /**
+     * The timestamp format.  This can be one of the following:
+     *
+     * - `"date-time-timezone"`: The date and time with the full timezone offset
+     *   (e.g., `"2023-11-14 22:13:20.000 +00:00"`).
+     * - `"date-time-tz"`: The date and time with the short timezone offset
+     *   (e.g., `"2023-11-14 22:13:20.000 +00"`).
+     * - `"date-time"`: The date and time without the timezone offset
+     *   (e.g., `"2023-11-14 22:13:20.000"`).
+     * - `"time-timezone"`: The time with the full timezone offset but without
+     *   the date (e.g., `"22:13:20.000 +00:00"`).
+     * - `"time-tz"`: The time with the short timezone offset but without the date
+     *   (e.g., `"22:13:20.000 +00"`).
+     * - `"time"`: The time without the date or timezone offset
+     *   (e.g., `"22:13:20.000"`).
+     * - `"date"`: The date without the time or timezone offset
+     *   (e.g., `"2023-11-14"`).
+     * - `"rfc3339"`: The date and time in RFC 3339 format
+     *   (e.g., `"2023-11-14T22:13:20.000Z"`).
+     *
+     * Alternatively, this can be a function that accepts a timestamp and returns
+     * a string.
+     *
+     * The default is `"date-time-tz"`.
+     */
+    timestamp?: "date-time-timezone" | "date-time-tz" | "date-time" | "time-timezone" | "time-tz" | "time" | "date" | "rfc3339" | ((ts: number) => string);
+    /**
+     * The ANSI style for the timestamp.  `"dim"` is used by default.
+     */
+    timestampStyle?: AnsiStyle | null;
+    /**
+     * The ANSI color for the timestamp.  No color is used by default.
+     */
+    timestampColor?: AnsiColor | null;
+    /**
+     * The ANSI style for the log level.  `"bold"` is used by default.
+     */
+    levelStyle?: AnsiStyle | null;
+    /**
+     * The ANSI colors for the log levels.  The default colors are as follows:
+     *
+     * - `"debug"`: `"blue"`
+     * - `"info"`: `"green"`
+     * - `"warning"`: `"yellow"`
+     * - `"error"`: `"red"`
+     * - `"fatal"`: `"magenta"`
+     */
+    levelColors?: Record<LogLevel, AnsiColor | null>;
+    /**
+     * The ANSI style for the category.  `"dim"` is used by default.
+     */
+    categoryStyle?: AnsiStyle | null;
+    /**
+     * The ANSI color for the category.  No color is used by default.
+     */
+    categoryColor?: AnsiColor | null;
+}
+/**
+ * Get an ANSI color formatter with the specified options.
+ *
+ * ![A preview of an ANSI color formatter.](https://i.imgur.com/I8LlBUf.png)
+ * @param option The options for the ANSI color formatter.
+ * @returns The ANSI color formatter.
+ * @since 0.6.0
+ */
+export declare function getAnsiColorFormatter(options?: AnsiColorFormatterOptions): TextFormatter;
 /**
  * A text formatter that uses ANSI colors to format log records.
  *

package/types/formatter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"formatter.d.ts","sourceRoot":"","sources":["../src/formatter.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,MAAM,EAAE,SAAS,KAAK,MAAM,CAAC;AAyC1D;;;;;;;;;GASG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM,CAW9D;AAcD;;;;;;;;GAQG;AACH,eAAO,MAAM,kBAAkB,EAAE,aAqBhC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,MAAM,EAAE,SAAS,KAAK,SAAS,OAAO,EAAE,CAAC;AAazE;;;;;;GAMG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,SAAS,GAAG,SAAS,OAAO,EAAE,CA2B7E"}
+{"version":3,"file":"formatter.d.ts","sourceRoot":"","sources":["../src/formatter.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,MAAM,EAAE,SAAS,KAAK,MAAM,CAAC;AAyC1D;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,SAAS,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,SAAS,CAAC,EACN,oBAAoB,GACpB,cAAc,GACd,WAAW,GACX,eAAe,GACf,SAAS,GACT,MAAM,GACN,MAAM,GACN,SAAS,GACT,CAAC,CAAC,EAAE,EAAE,MAAM,KAAK,MAAM,CAAC,CAAC;IAE7B;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,EACF,MAAM,GACN,MAAM,GACN,GAAG,GACH,MAAM,GACN,MAAM,GACN,GAAG,GACH,CAAC,CAAC,KAAK,EAAE,QAAQ,KAAK,MAAM,CAAC,CAAC;IAElC;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,KAAK,MAAM,CAAC,CAAC;IAE9D;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,MAAM,CAAC;IAEnC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,eAAe,KAAK,MAAM,CAAC;CAC9C;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,gBAAgB,CAC9B,OAAO,GAAE,oBAAyB,GACjC,aAAa,CA+Df;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,oBAAoB,EAAE,aAAkC,CAAC;AAItE;;;GAGG;AACH,MAAM,MAAM,SAAS,GACjB,OAAO,GACP,KAAK,GACL,OAAO,GACP,QAAQ,GACR,MAAM,GACN,SAAS,GACT,MAAM,GACN,OAAO,CAAC;AAaZ;;;GAGG;AACH,MAAM,MAAM,SAAS,GACjB,MAAM,GACN,KAAK,GACL,QAAQ,GACR,WAAW,GACX,eAAe,CAAC;AAkBpB;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,oBAAoB;IACrE;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,SAAS,CAAC,EACN,oBAAoB,GACpB,cAAc,GACd,WAAW,GACX,eAAe,GACf,SAAS,GACT,MAAM,GACN,MAAM,GACN,SAAS,GACT,CAAC,CAAC,EAAE,EAAE,MAAM,KAAK,MAAM,CAAC,CAAC;IAE7B;;OAEG;IACH,cAAc,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,cAAc,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,UAAU,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IAE9B;;;;;;;;OAQG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,QAAQ,EAAE,SAAS,GAAG,IAAI,CAAC,CAAC;IAEjD;;OAEG;IACH,aAAa,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,aAAa,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;CAClC;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CACnC,OAAO,GAAE,yBAA8B,GACtC,aAAa,CAiDf;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,kBAAkB,EAAE,aAAuC,CAAC;AAEzE;;;;;;;GAOG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,MAAM,EAAE,SAAS,KAAK,SAAS,OAAO,EAAE,CAAC;AAazE;;;;;;GAMG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,SAAS,GAAG,SAAS,OAAO,EAAE,CA2B7E"}

package/types/mod.d.ts

@@ -1,7 +1,7 @@
 export { type Config, ConfigError, configure, dispose, getConfig, type LoggerConfig, reset, } from "./config.js";
 export { getFileSink, getRotatingFileSink } from "./filesink.node.js";
 export { type Filter, type FilterLike, getLevelFilter, toFilter, } from "./filter.js";
-export { ansiColorFormatter, type ConsoleFormatter, defaultConsoleFormatter, defaultTextFormatter, type TextFormatter, } from "./formatter.js";
+export { type AnsiColor, ansiColorFormatter, type AnsiColorFormatterOptions, type AnsiStyle, type ConsoleFormatter, defaultConsoleFormatter, defaultTextFormatter, type FormattedValues, getAnsiColorFormatter, getTextFormatter, type TextFormatter, type TextFormatterOptions, } from "./formatter.js";
 export { isLogLevel, type LogLevel, parseLogLevel } from "./level.js";
 export { getLogger, type Logger } from "./logger.js";
 export type { LogRecord } from "./record.js";

package/types/mod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,MAAM,EACX,WAAW,EACX,SAAS,EACT,OAAO,EACP,SAAS,EACT,KAAK,YAAY,EACjB,KAAK,GACN,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AACtE,OAAO,EACL,KAAK,MAAM,EACX,KAAK,UAAU,EACf,cAAc,EACd,QAAQ,GACT,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,kBAAkB,EAClB,KAAK,gBAAgB,EACrB,uBAAuB,EACvB,oBAAoB,EACpB,KAAK,aAAa,GACnB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,UAAU,EAAE,KAAK,QAAQ,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AACtE,OAAO,EAAE,SAAS,EAAE,KAAK,MAAM,EAAE,MAAM,aAAa,CAAC;AACrD,YAAY,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EACL,KAAK,kBAAkB,EACvB,KAAK,eAAe,EACpB,cAAc,EACd,aAAa,EACb,KAAK,uBAAuB,EAC5B,KAAK,IAAI,EACT,KAAK,iBAAiB,EACtB,UAAU,GACX,MAAM,WAAW,CAAC"}
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,MAAM,EACX,WAAW,EACX,SAAS,EACT,OAAO,EACP,SAAS,EACT,KAAK,YAAY,EACjB,KAAK,GACN,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AACtE,OAAO,EACL,KAAK,MAAM,EACX,KAAK,UAAU,EACf,cAAc,EACd,QAAQ,GACT,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,KAAK,SAAS,EACd,kBAAkB,EAClB,KAAK,yBAAyB,EAC9B,KAAK,SAAS,EACd,KAAK,gBAAgB,EACrB,uBAAuB,EACvB,oBAAoB,EACpB,KAAK,eAAe,EACpB,qBAAqB,EACrB,gBAAgB,EAChB,KAAK,aAAa,EAClB,KAAK,oBAAoB,GAC1B,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,UAAU,EAAE,KAAK,QAAQ,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AACtE,OAAO,EAAE,SAAS,EAAE,KAAK,MAAM,EAAE,MAAM,aAAa,CAAC;AACrD,YAAY,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EACL,KAAK,kBAAkB,EACvB,KAAK,eAAe,EACpB,cAAc,EACd,aAAa,EACb,KAAK,uBAAuB,EAC5B,KAAK,IAAI,EACT,KAAK,iBAAiB,EACtB,UAAU,GACX,MAAM,WAAW,CAAC"}