@logtape/file 0.9.0-dev.1

package/esm/logtape/formatter.js

@@ -0,0 +1,261 @@
+import util from "./nodeUtil.js";
+/**
+ * The severity level abbreviations.
+ */
+const levelAbbreviations = {
+    "debug": "DBG",
+    "info": "INF",
+    "warning": "WRN",
+    "error": "ERR",
+    "fatal": "FTL",
+};
+/**
+ * A platform-specific inspect function.  In Deno, this is {@link Deno.inspect},
+ * and in Node.js/Bun it is `util.inspect()`.  If neither is available, it
+ * falls back to {@link JSON.stringify}.
+ *
+ * @param value The value to inspect.
+ * @param options The options for inspecting the value.
+ *                If `colors` is `true`, the output will be ANSI-colored.
+ * @returns The string representation of the value.
+ */
+const inspect = 
+// @ts-ignore: Deno global
+// dnt-shim-ignore
+"Deno" in globalThis && "inspect" in globalThis.Deno &&
+    // @ts-ignore: Deno global
+    // dnt-shim-ignore
+    typeof globalThis.Deno.inspect === "function"
+    ? (v, opts) => 
+    // @ts-ignore: Deno global
+    // dnt-shim-ignore
+    globalThis.Deno.inspect(v, {
+        strAbbreviateSize: Infinity,
+        iterableLimit: Infinity,
+        ...opts,
+    })
+    // @ts-ignore: Node.js global
+    // dnt-shim-ignore
+    : util != null && "inspect" in util && typeof util.inspect === "function"
+        ? (v, opts) => 
+        // @ts-ignore: Node.js global
+        // dnt-shim-ignore
+        util.inspect(v, {
+            maxArrayLength: Infinity,
+            maxStringLength: Infinity,
+            ...opts,
+        })
+        : (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:
+ *
+ * ```
+ * 2023-11-14 22:13:20.000 +00:00 [INF] category·subcategory: Hello, world!
+ * ```
+ *
+ * @param record The log record to format.
+ * @returns The formatted log record.
+ */
+export const defaultTextFormatter = getTextFormatter();
+const RESET = "\x1b[0m";
+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.
+ *
+ * ![A preview of ansiColorFormatter.](https://i.imgur.com/I8LlBUf.png)
+ *
+ * @param record The log record to format.
+ * @returns The formatted log record.
+ * @since 0.5.0
+ */
+export const ansiColorFormatter = getAnsiColorFormatter();
+/**
+ * The styles for the log level in the console.
+ */
+const logLevelStyles = {
+    "debug": "background-color: gray; color: white;",
+    "info": "background-color: white; color: black;",
+    "warning": "background-color: orange; color: black;",
+    "error": "background-color: red; color: white;",
+    "fatal": "background-color: maroon; color: white;",
+};
+/**
+ * The default console formatter.
+ *
+ * @param record The log record to format.
+ * @returns The formatted log record, as an array of arguments for
+ *          {@link console.log}.
+ */
+export function defaultConsoleFormatter(record) {
+    let msg = "";
+    const values = [];
+    for (let i = 0; i < record.message.length; i++) {
+        if (i % 2 === 0)
+            msg += record.message[i];
+        else {
+            msg += "%o";
+            values.push(record.message[i]);
+        }
+    }
+    const date = new Date(record.timestamp);
+    const time = `${date.getUTCHours().toString().padStart(2, "0")}:${date.getUTCMinutes().toString().padStart(2, "0")}:${date.getUTCSeconds().toString().padStart(2, "0")}.${date.getUTCMilliseconds().toString().padStart(3, "0")}`;
+    return [
+        `%c${time} %c${levelAbbreviations[record.level]}%c %c${record.category.join("\xb7")} %c${msg}`,
+        "color: gray;",
+        logLevelStyles[record.level],
+        "background-color: default;",
+        "color: gray;",
+        "color: default;",
+        ...values,
+    ];
+}

package/esm/logtape/level.js

@@ -0,0 +1,59 @@
+const logLevels = ["debug", "info", "warning", "error", "fatal"];
+/**
+ * Parses a log level from a string.
+ *
+ * @param level The log level as a string.  This is case-insensitive.
+ * @returns The log level.
+ * @throws {TypeError} If the log level is invalid.
+ */
+export function parseLogLevel(level) {
+    level = level.toLowerCase();
+    switch (level) {
+        case "debug":
+        case "info":
+        case "warning":
+        case "error":
+        case "fatal":
+            return level;
+        default:
+            throw new TypeError(`Invalid log level: ${level}.`);
+    }
+}
+/**
+ * Checks if a string is a valid log level.  This function can be used as
+ * as a type guard to narrow the type of a string to a {@link LogLevel}.
+ *
+ * @param level The log level as a string.  This is case-sensitive.
+ * @returns `true` if the string is a valid log level.
+ */
+export function isLogLevel(level) {
+    switch (level) {
+        case "debug":
+        case "info":
+        case "warning":
+        case "error":
+        case "fatal":
+            return true;
+        default:
+            return false;
+    }
+}
+/**
+ * Compares two log levels.
+ * @param a The first log level.
+ * @param b The second log level.
+ * @returns A negative number if `a` is less than `b`, a positive number if `a`
+ *          is greater than `b`, or zero if they are equal.
+ * @since 0.8.0
+ */
+export function compareLogLevel(a, b) {
+    const aIndex = logLevels.indexOf(a);
+    if (aIndex < 0) {
+        throw new TypeError(`Invalid log level: ${JSON.stringify(a)}.`);
+    }
+    const bIndex = logLevels.indexOf(b);
+    if (bIndex < 0) {
+        throw new TypeError(`Invalid log level: ${JSON.stringify(b)}.`);
+    }
+    return aIndex - bIndex;
+}