@logtape/file 0.9.0-dev.134 → 0.9.1-dev.151

package/script/logtape/config.js

@@ -1,321 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConfigError = void 0;
-exports.configure = configure;
-exports.configureSync = configureSync;
-exports.getConfig = getConfig;
-exports.reset = reset;
-exports.resetSync = resetSync;
-exports.dispose = dispose;
-exports.disposeSync = disposeSync;
-const dntShim = __importStar(require("../_dnt.shims.js"));
-const filter_js_1 = require("./filter.js");
-const logger_js_1 = require("./logger.js");
-const sink_js_1 = require("./sink.js");
-/**
- * The current configuration, if any.  Otherwise, `null`.
- */
-let currentConfig = null;
-/**
- * Strong references to the loggers.
- * This is to prevent the loggers from being garbage collected so that their
- * sinks and filters are not removed.
- */
-const strongRefs = new Set();
-/**
- * Disposables to dispose when resetting the configuration.
- */
-const disposables = new Set();
-/**
- * Async disposables to dispose when resetting the configuration.
- */
-const asyncDisposables = new Set();
-/**
- * Check if a config is for the meta logger.
- */
-function isLoggerConfigMeta(cfg) {
-    return cfg.category.length === 0 ||
-        (cfg.category.length === 1 && cfg.category[0] === "logtape") ||
-        (cfg.category.length === 2 &&
-            cfg.category[0] === "logtape" &&
-            cfg.category[1] === "meta");
-}
-/**
- * Configure the loggers with the specified configuration.
- *
- * Note that if the given sinks or filters are disposable, they will be
- * disposed when the configuration is reset, or when the process exits.
- *
- * @example
- * ```typescript
- * await configure({
- *   sinks: {
- *     console: getConsoleSink(),
- *   },
- *   filters: {
- *     slow: (log) =>
- *       "duration" in log.properties &&
- *       log.properties.duration as number > 1000,
- *   },
- *   loggers: [
- *     {
- *       category: "my-app",
- *       sinks: ["console"],
- *       level: "info",
- *     },
- *     {
- *       category: ["my-app", "sql"],
- *       filters: ["slow"],
- *       level: "debug",
- *     },
- *     {
- *       category: "logtape",
- *       sinks: ["console"],
- *       level: "error",
- *     },
- *   ],
- * });
- * ```
- *
- * @param config The configuration.
- */
-async function configure(config) {
-    if (currentConfig != null && !config.reset) {
-        throw new ConfigError("Already configured; if you want to reset, turn on the reset flag.");
-    }
-    await reset();
-    try {
-        configureInternal(config, true);
-    }
-    catch (e) {
-        if (e instanceof ConfigError)
-            await reset();
-        throw e;
-    }
-}
-/**
- * Configure sync loggers with the specified configuration.
- *
- * Note that if the given sinks or filters are disposable, they will be
- * disposed when the configuration is reset, or when the process exits.
- *
- * Also note that passing async sinks or filters will throw. If
- * necessary use {@link resetSync} or {@link disposeSync}.
- *
- * @example
- * ```typescript
- * configureSync({
- *   sinks: {
- *     console: getConsoleSink(),
- *   },
- *   loggers: [
- *     {
- *       category: "my-app",
- *       sinks: ["console"],
- *       level: "info",
- *     },
- *     {
- *       category: "logtape",
- *       sinks: ["console"],
- *       level: "error",
- *     },
- *   ],
- * });
- * ```
- *
- * @param config The configuration.
- * @since 0.9.0
- */
-function configureSync(config) {
-    if (currentConfig != null && !config.reset) {
-        throw new ConfigError("Already configured; if you want to reset, turn on the reset flag.");
-    }
-    if (asyncDisposables.size > 0) {
-        throw new ConfigError("Previously configured async disposables are still active. " +
-            "Use configure() instead or explicitly dispose them using dispose().");
-    }
-    resetSync();
-    try {
-        configureInternal(config, false);
-    }
-    catch (e) {
-        if (e instanceof ConfigError)
-            resetSync();
-        throw e;
-    }
-}
-function configureInternal(config, allowAsync) {
-    currentConfig = config;
-    let metaConfigured = false;
-    let levelUsed = false;
-    for (const cfg of config.loggers) {
-        if (isLoggerConfigMeta(cfg)) {
-            metaConfigured = true;
-        }
-        const logger = logger_js_1.LoggerImpl.getLogger(cfg.category);
-        for (const sinkId of cfg.sinks ?? []) {
-            const sink = config.sinks[sinkId];
-            if (!sink) {
-                throw new ConfigError(`Sink not found: ${sinkId}.`);
-            }
-            logger.sinks.push(sink);
-        }
-        logger.parentSinks = cfg.parentSinks ?? "inherit";
-        if (cfg.lowestLevel !== undefined) {
-            logger.lowestLevel = cfg.lowestLevel;
-        }
-        if (cfg.level !== undefined) {
-            levelUsed = true;
-            logger.filters.push((0, filter_js_1.toFilter)(cfg.level));
-        }
-        for (const filterId of cfg.filters ?? []) {
-            const filter = config.filters?.[filterId];
-            if (filter === undefined) {
-                throw new ConfigError(`Filter not found: ${filterId}.`);
-            }
-            logger.filters.push((0, filter_js_1.toFilter)(filter));
-        }
-        strongRefs.add(logger);
-    }
-    logger_js_1.LoggerImpl.getLogger().contextLocalStorage = config.contextLocalStorage;
-    for (const sink of Object.values(config.sinks)) {
-        if (Symbol.asyncDispose in sink) {
-            if (allowAsync)
-                asyncDisposables.add(sink);
-            else {
-                throw new ConfigError("Async disposables cannot be used with configureSync().");
-            }
-        }
-        if (Symbol.dispose in sink)
-            disposables.add(sink);
-    }
-    for (const filter of Object.values(config.filters ?? {})) {
-        if (filter == null || typeof filter === "string")
-            continue;
-        if (Symbol.asyncDispose in filter) {
-            if (allowAsync)
-                asyncDisposables.add(filter);
-            else {
-                throw new ConfigError("Async disposables cannot be used with configureSync().");
-            }
-        }
-        if (Symbol.dispose in filter)
-            disposables.add(filter);
-    }
-    if ("process" in dntShim.dntGlobalThis && !("Deno" in dntShim.dntGlobalThis)) {
-        // @ts-ignore: It's fine to use process in Node
-        // deno-lint-ignore no-process-global
-        process.on("exit", allowAsync ? dispose : disposeSync);
-    }
-    else {
-        // @ts-ignore: It's fine to addEventListener() on the browser/Deno
-        addEventListener("unload", allowAsync ? dispose : disposeSync);
-    }
-    const meta = logger_js_1.LoggerImpl.getLogger(["logtape", "meta"]);
-    if (!metaConfigured) {
-        meta.sinks.push((0, sink_js_1.getConsoleSink)());
-    }
-    meta.info("LogTape loggers are configured.  Note that LogTape itself uses the meta " +
-        "logger, which has category {metaLoggerCategory}.  The meta logger " +
-        "purposes to log internal errors such as sink exceptions.  If you " +
-        "are seeing this message, the meta logger is automatically configured.  " +
-        "It's recommended to configure the meta logger with a separate sink " +
-        "so that you can easily notice if logging itself fails or is " +
-        "misconfigured.  To turn off this message, configure the meta logger " +
-        "with higher log levels than {dismissLevel}.  See also " +
-        "<https://logtape.org/manual/categories#meta-logger>.", { metaLoggerCategory: ["logtape", "meta"], dismissLevel: "info" });
-    if (levelUsed) {
-        meta.warn("The level option is deprecated in favor of lowestLevel option.  " +
-            "Please update your configuration.  See also " +
-            "<https://logtape.org/manual/levels#configuring-severity-levels>.");
-    }
-}
-/**
- * Get the current configuration, if any.  Otherwise, `null`.
- * @returns The current configuration, if any.  Otherwise, `null`.
- */
-function getConfig() {
-    return currentConfig;
-}
-/**
- * Reset the configuration.  Mostly for testing purposes.
- */
-async function reset() {
-    await dispose();
-    resetInternal();
-}
-/**
- * Reset the configuration.  Mostly for testing purposes. Will not clear async
- * sinks, only use with sync sinks. Use {@link reset} if you have async sinks.
- * @since 0.9.0
- */
-function resetSync() {
-    disposeSync();
-    resetInternal();
-}
-function resetInternal() {
-    const rootLogger = logger_js_1.LoggerImpl.getLogger([]);
-    rootLogger.resetDescendants();
-    delete rootLogger.contextLocalStorage;
-    strongRefs.clear();
-    currentConfig = null;
-}
-/**
- * Dispose of the disposables.
- */
-async function dispose() {
-    disposeSync();
-    const promises = [];
-    for (const disposable of asyncDisposables) {
-        promises.push(disposable[Symbol.asyncDispose]());
-        asyncDisposables.delete(disposable);
-    }
-    await Promise.all(promises);
-}
-/**
- * Dispose of the sync disposables. Async disposables will be untouched,
- * use {@link dispose} if you have async sinks.
- * @since 0.9.0
- */
-function disposeSync() {
-    for (const disposable of disposables)
-        disposable[Symbol.dispose]();
-    disposables.clear();
-}
-/**
- * A configuration error.
- */
-class ConfigError extends Error {
-    /**
-     * Constructs a new configuration error.
-     * @param message The error message.
-     */
-    constructor(message) {
-        super(message);
-        this.name = "ConfigureError";
-    }
-}
-exports.ConfigError = ConfigError;

package/script/logtape/context.js

@@ -1,26 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.withContext = withContext;
-const logger_js_1 = require("./logger.js");
-/**
- * Runs a callback with the given implicit context.  Every single log record
- * in the callback will have the given context.
- *
- * If no `contextLocalStorage` is configured, this function does nothing and
- * just returns the return value of the callback.  It also logs a warning to
- * the `["logtape", "meta"]` logger in this case.
- * @param context The context to inject.
- * @param callback The callback to run.
- * @returns The return value of the callback.
- * @since 0.7.0
- */
-function withContext(context, callback) {
-    const rootLogger = logger_js_1.LoggerImpl.getLogger();
-    if (rootLogger.contextLocalStorage == null) {
-        logger_js_1.LoggerImpl.getLogger(["logtape", "meta"]).warn("Context-local storage is not configured.  " +
-            "Specify contextLocalStorage option in the configure() function.");
-        return callback();
-    }
-    const parentContext = rootLogger.contextLocalStorage.getStore() ?? {};
-    return rootLogger.contextLocalStorage.run({ ...parentContext, ...context }, callback);
-}

package/script/logtape/filter.js

@@ -1,46 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.toFilter = toFilter;
-exports.getLevelFilter = getLevelFilter;
-/**
- * Converts a {@link FilterLike} value to an actual {@link Filter}.
- *
- * @param filter The filter-like value to convert.
- * @returns The actual filter.
- */
-function toFilter(filter) {
-    if (typeof filter === "function")
-        return filter;
-    return getLevelFilter(filter);
-}
-/**
- * Returns a filter that accepts log records with the specified level.
- *
- * @param level The level to filter by.  If `null`, the filter will reject all
- *              records.
- * @returns The filter.
- */
-function getLevelFilter(level) {
-    if (level == null)
-        return () => false;
-    if (level === "fatal") {
-        return (record) => record.level === "fatal";
-    }
-    else if (level === "error") {
-        return (record) => record.level === "fatal" || record.level === "error";
-    }
-    else if (level === "warning") {
-        return (record) => record.level === "fatal" ||
-            record.level === "error" ||
-            record.level === "warning";
-    }
-    else if (level === "info") {
-        return (record) => record.level === "fatal" ||
-            record.level === "error" ||
-            record.level === "warning" ||
-            record.level === "info";
-    }
-    else if (level === "debug")
-        return () => true;
-    throw new TypeError(`Invalid log level: ${level}.`);
-}

package/script/logtape/formatter.js

@@ -1,270 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ansiColorFormatter = exports.defaultTextFormatter = void 0;
-exports.getTextFormatter = getTextFormatter;
-exports.getAnsiColorFormatter = getAnsiColorFormatter;
-exports.defaultConsoleFormatter = defaultConsoleFormatter;
-const nodeUtil_js_1 = __importDefault(require("./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
-    : nodeUtil_js_1.default != null && "inspect" in nodeUtil_js_1.default && typeof nodeUtil_js_1.default.inspect === "function"
-        ? (v, opts) => 
-        // @ts-ignore: Node.js global
-        // dnt-shim-ignore
-        nodeUtil_js_1.default.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
- */
-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.
- */
-exports.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
- */
-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
- */
-exports.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}.
- */
-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,
-    ];
-}