@sapphire/plugin-logger 3.0.8-next.eccc557.0 → 4.0.0-next.8540da8.0

package/dist/cjs/index.cjs

@@ -0,0 +1,37 @@
+'use strict';
+
+var Logger_cjs = require('./lib/Logger.cjs');
+var LoggerLevel_cjs = require('./lib/LoggerLevel.cjs');
+var LoggerStyle_cjs = require('./lib/LoggerStyle.cjs');
+var LoggerTimestamp_cjs = require('./lib/LoggerTimestamp.cjs');
+
+// src/index.ts
+var version = "4.0.0-next.8540da8.0";
+
+exports.version = version;
+Object.keys(Logger_cjs).forEach(function (k) {
+  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return Logger_cjs[k]; }
+  });
+});
+Object.keys(LoggerLevel_cjs).forEach(function (k) {
+  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return LoggerLevel_cjs[k]; }
+  });
+});
+Object.keys(LoggerStyle_cjs).forEach(function (k) {
+  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return LoggerStyle_cjs[k]; }
+  });
+});
+Object.keys(LoggerTimestamp_cjs).forEach(function (k) {
+  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return LoggerTimestamp_cjs[k]; }
+  });
+});
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=index.cjs.map

package/dist/cjs/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/index.ts"],"names":[],"mappings":";AAEA,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AAaP,IAAM,UAAkB","sourcesContent":["import type { LoggerOptions } from './lib/Logger';\n\nexport * from './lib/Logger';\nexport * from './lib/LoggerLevel';\nexport * from './lib/LoggerStyle';\nexport * from './lib/LoggerTimestamp';\n\ndeclare module '@sapphire/framework' {\n\texport interface ClientLoggerOptions extends LoggerOptions {}\n}\n\n/**\n * The [@sapphire/plugin-logger](https://github.com/sapphiredev/plugins/blob/main/packages/logger) version that you are currently using.\n * An example use of this is showing it of in a bot information command.\n *\n * Note to Sapphire developers: This needs to explicitly be `string` so it is not typed as the string that gets replaced by esbuild\n */\n// eslint-disable-next-line @typescript-eslint/no-inferrable-types\nexport const version: string = '4.0.0-next.8540da8.0';\n"]}

package/dist/cjs/index.d.ts

@@ -0,0 +1,383 @@
+import { Logger as Logger$1, LogLevel } from '@sapphire/framework';
+import * as Colorette from 'colorette';
+import { Timestamp } from '@sapphire/timestamp';
+
+/**
+ * Logger utility that applies a style to a string.
+ * @since 1.0.0
+ */
+declare class LoggerStyle {
+    readonly style: Colorette.Color;
+    constructor(resolvable?: LoggerStyleResolvable);
+    /**
+     * Applies the style to a string.
+     * @since 1.0.0
+     * @param string The value to apply the style to.
+     */
+    run(string: string | number): string;
+}
+/**
+ * The options for {@link LoggerStyle}.
+ * @since 1.0.0
+ */
+interface LoggerStyleOptions {
+    /**
+     * The text effects, e.g. `italic`, `strikethrough`, etc.
+     * @since 1.0.0
+     */
+    effects?: LoggerStyleEffect[];
+    /**
+     * The text color, e.g. `red` or `yellow`.
+     * @since 1.0.0
+     */
+    text?: LoggerStyleText;
+    /**
+     * The background color, e.g. `magenta` or `red`.
+     * @since 1.0.0
+     */
+    background?: LoggerStyleBackground;
+}
+/**
+ * The value accepted by {@link LoggerStyle}'s constructor. Read `colorette`'s documentation for more information.
+ * @since 1.0.0
+ * @seealso https://www.npmjs.com/package/colorette
+ */
+type LoggerStyleResolvable = Colorette.Color | LoggerStyleOptions;
+/**
+ * The text styles.
+ * @since 1.0.0
+ */
+declare enum LoggerStyleEffect {
+    Reset = "reset",
+    Bold = "bold",
+    Dim = "dim",
+    Italic = "italic",
+    Underline = "underline",
+    Inverse = "inverse",
+    Hidden = "hidden",
+    Strikethrough = "strikethrough"
+}
+/**
+ * The text colors.
+ * @since 1.0.0
+ */
+declare enum LoggerStyleText {
+    Black = "black",
+    Red = "red",
+    Green = "green",
+    Yellow = "yellow",
+    Blue = "blue",
+    Magenta = "magenta",
+    Cyan = "cyan",
+    White = "white",
+    Gray = "gray",
+    BlackBright = "blackBright",
+    RedBright = "redBright",
+    GreenBright = "greenBright",
+    YellowBright = "yellowBright",
+    BlueBright = "blueBright",
+    MagentaBright = "magentaBright",
+    CyanBright = "cyanBright",
+    WhiteBright = "whiteBright"
+}
+/**
+ * The background colors.
+ * @since 1.0.0
+ */
+declare enum LoggerStyleBackground {
+    Black = "bgBlack",
+    Red = "bgRed",
+    Green = "bgGreen",
+    Yellow = "bgYellow",
+    Blue = "bgBlue",
+    Magenta = "bgMagenta",
+    Cyan = "bgCyan",
+    White = "bgWhite",
+    BlackBright = "bgBlackBright",
+    RedBright = "bgRedBright",
+    GreenBright = "bgGreenBright",
+    YellowBright = "bgYellowBright",
+    BlueBright = "bgBlueBright",
+    MagentaBright = "bgMagentaBright",
+    CyanBright = "bgCyanBright",
+    WhiteBright = "bgWhiteBright"
+}
+
+/**
+ * Logger utility that formats a timestamp.
+ * @since 1.0.0
+ */
+declare class LoggerTimestamp {
+    /**
+     * The timestamp used to format the current date.
+     * @since 1.0.0
+     */
+    timestamp: Timestamp;
+    /**
+     * Whether or not the logger will show a timestamp in UTC.
+     * @since 1.0.0
+     */
+    utc: boolean;
+    /**
+     * The logger style to apply the color to the timestamp.
+     * @since 1.0.0
+     */
+    color: LoggerStyle | null;
+    /**
+     * The final formatter.
+     * @since 1.0.0
+     */
+    formatter: LoggerTimestampFormatter;
+    constructor(options?: LoggerTimestampOptions);
+    /**
+     * Formats the current time.
+     * @since 1.0.0
+     */
+    run(): string;
+}
+/**
+ * The options for {@link LoggerTimestamp}.
+ * @since 1.0.0
+ */
+interface LoggerTimestampOptions {
+    /**
+     * The {@link Timestamp} pattern.
+     * @since 1.0.0
+     * @default 'YYYY-MM-DD HH:mm:ss'
+     * @example
+     * ```typescript
+     * 'YYYY-MM-DD HH:mm:ss'
+     * // 2020-12-23 22:01:10
+     * ```
+     */
+    pattern?: string;
+    /**
+     * Whether or not the date should be UTC.
+     * @since 1.0.0
+     * @default false
+     */
+    utc?: boolean;
+    /**
+     * The color to use.
+     * @since 1.0.0
+     * @default colorette.reset
+     */
+    color?: LoggerStyleResolvable | null;
+    /**
+     * The formatter. See {@link LoggerTimestampFormatter} for more information.
+     * @since 1.0.0
+     * @default (value) => `${value} - `
+     */
+    formatter?: LoggerTimestampFormatter;
+}
+/**
+ * The formatter used for {@link LoggerTimestampOptions}. This will be run **after** applying the color to the formatter.
+ * @since 1.0.0
+ */
+interface LoggerTimestampFormatter {
+    /**
+     * @param timestamp The output of {@link LoggerStyle.run} on {@link Timestamp.display}/{@link Timestamp.displayUTC}.
+     * @since 1.0.0
+     */
+    (timestamp: string): string;
+}
+
+/**
+ * Logger utility that stores and applies a full style into the message.
+ * @since 1.0.0
+ */
+declare class LoggerLevel {
+    /**
+     * The timestamp formatter.
+     * @since 1.0.0
+     */
+    timestamp: LoggerTimestamp | null;
+    /**
+     * The infix, added between the timestamp and the message.
+     * @since 1.0.0
+     */
+    infix: string;
+    /**
+     * The style formatter for the message.
+     * @since 1.0.0
+     */
+    message: LoggerStyle | null;
+    constructor(options?: LoggerLevelOptions);
+    run(content: string): string;
+}
+/**
+ * The options for {@link LoggerLevel}.
+ * @since 1.0.0
+ */
+interface LoggerLevelOptions {
+    /**
+     * The timestamp options. Set to `null` to disable timestamp parsing.
+     * @since 1.0.0
+     * @default {}
+     */
+    timestamp?: LoggerTimestampOptions | null;
+    /**
+     * The infix to be included between the timestamp and the message.
+     * @since 1.0.0
+     * @default ''
+     */
+    infix?: string;
+    /**
+     * The style options for the message.
+     * @since 1.0.0
+     * @default colorette.clear
+     */
+    message?: LoggerStyleResolvable | null;
+}
+
+/**
+ * The logger class.
+ * @since 1.0.0
+ */
+declare class Logger extends Logger$1 {
+    /**
+     * The console this writes to.
+     * @since 1.0.0
+     */
+    readonly console: Console;
+    /**
+     * The formats supported by the logger.
+     * @since 1.0.0
+     */
+    readonly formats: Map<LogLevel, LoggerLevel>;
+    /**
+     * The string `write` will join values by.
+     * @since 1.0.0
+     */
+    readonly join: string;
+    /**
+     * The inspect depth when logging objects.
+     * @since 1.0.0
+     */
+    readonly depth: number;
+    constructor(options?: LoggerOptions);
+    /**
+     * Writes the log message given a level and the value(s).
+     * @param level The log level.
+     * @param values The values to log.
+     */
+    write(level: LogLevel, ...values: readonly unknown[]): void;
+    /**
+     * Pre-processes an array of values.
+     * @since 1.0.0
+     * @param values The values to pre-process.
+     */
+    protected preprocess(values: readonly unknown[]): string;
+    private get levels();
+    /**
+     * Gets whether or not colorette is enabled.
+     * @since 1.0.0
+     */
+    static get stylize(): boolean;
+    private static createFormatMap;
+    private static ensureDefaultLevel;
+}
+/**
+ * The logger options.
+ * @since 1.0.0
+ */
+interface LoggerOptions {
+    /**
+     * A writable stream for the output logs.
+     * @since 1.0.0
+     * @default process.stdout
+     */
+    stdout?: NodeJS.WritableStream;
+    /**
+     * A writable stream for the error logs.
+     * @since 1.0.0
+     * @default process.stderr
+     */
+    stderr?: NodeJS.WritableStream;
+    /**
+     * The default options used to fill all the possible values for {@link LoggerOptions.format}.
+     * @since 1.0.0
+     * @default options.format.none ?? {}
+     */
+    defaultFormat?: LoggerLevelOptions;
+    /**
+     * The options for each log level. LogLevel.None serves to set the default for all keys, where only
+     * {@link LoggerTimestampOptions.timestamp} and {@link LoggerLevelOptions.prefix} would be overridden.
+     * @since 1.0.0
+     * @default {}
+     */
+    format?: LoggerFormatOptions;
+    /**
+     * The minimum log level.
+     * @since 1.0.0
+     * @default LogLevel.Info
+     */
+    level?: LogLevel;
+    /**
+     * The string that joins different messages.
+     * @since 1.0.0
+     * @default ' '
+     */
+    join?: string;
+    /**
+     * The inspect depth when logging objects.
+     * @since 1.0.0
+     * @default 0
+     */
+    depth?: number;
+}
+/**
+ * The logger format options.
+ * @since 1.0.0
+ */
+interface LoggerFormatOptions {
+    /**
+     * The logger options for the lowest log level, used when calling {@link ILogger.trace}.
+     * @since 1.0.0
+     */
+    trace?: LoggerLevelOptions;
+    /**
+     * The logger options for the debug level, used when calling {@link ILogger.debug}.
+     * @since 1.0.0
+     */
+    debug?: LoggerLevelOptions;
+    /**
+     * The logger options for the info level, used when calling {@link ILogger.info}.
+     * @since 1.0.0
+     */
+    info?: LoggerLevelOptions;
+    /**
+     * The logger options for the warning level, used when calling {@link ILogger.warn}.
+     * @since 1.0.0
+     */
+    warn?: LoggerLevelOptions;
+    /**
+     * The logger options for the error level, used when calling {@link ILogger.error}.
+     * @since 1.0.0
+     */
+    error?: LoggerLevelOptions;
+    /**
+     * The logger options for the critical level, used when calling {@link ILogger.fatal}.
+     * @since 1.0.0
+     */
+    fatal?: LoggerLevelOptions;
+    /**
+     * The logger options for an unknown or uncategorised level.
+     * @since 1.0.0
+     */
+    none?: LoggerLevelOptions;
+}
+
+declare module '@sapphire/framework' {
+    interface ClientLoggerOptions extends LoggerOptions {
+    }
+}
+/**
+ * The [@sapphire/plugin-logger](https://github.com/sapphiredev/plugins/blob/main/packages/logger) version that you are currently using.
+ * An example use of this is showing it of in a bot information command.
+ *
+ * Note to Sapphire developers: This needs to explicitly be `string` so it is not typed as the string that gets replaced by esbuild
+ */
+declare const version: string;
+
+export { Logger, type LoggerFormatOptions, LoggerLevel, type LoggerLevelOptions, type LoggerOptions, LoggerStyle, LoggerStyleBackground, LoggerStyleEffect, type LoggerStyleOptions, type LoggerStyleResolvable, LoggerStyleText, LoggerTimestamp, type LoggerTimestampFormatter, type LoggerTimestampOptions, version };

package/dist/cjs/lib/Logger.cjs

@@ -0,0 +1,101 @@
+'use strict';
+
+var framework = require('@sapphire/framework');
+var colorette = require('colorette');
+var console = require('console');
+var util = require('util');
+var LoggerLevel_cjs = require('./LoggerLevel.cjs');
+
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+var _Logger = class _Logger extends framework.Logger {
+  constructor(options = {}) {
+    super(options.level ?? framework.LogLevel.Info);
+    /**
+     * The console this writes to.
+     * @since 1.0.0
+     */
+    __publicField(this, "console");
+    /**
+     * The formats supported by the logger.
+     * @since 1.0.0
+     */
+    __publicField(this, "formats");
+    /**
+     * The string `write` will join values by.
+     * @since 1.0.0
+     */
+    __publicField(this, "join");
+    /**
+     * The inspect depth when logging objects.
+     * @since 1.0.0
+     */
+    __publicField(this, "depth");
+    this.console = new console.Console(options.stdout ?? process.stdout, options.stderr ?? process.stderr);
+    this.formats = _Logger.createFormatMap(options.format, options.defaultFormat);
+    this.join = options.join ?? " ";
+    this.depth = options.depth ?? 0;
+  }
+  /**
+   * Writes the log message given a level and the value(s).
+   * @param level The log level.
+   * @param values The values to log.
+   */
+  write(level, ...values) {
+    if (level < this.level)
+      return;
+    const method = this.levels.get(level) ?? "log";
+    const formatter = this.formats.get(level) ?? this.formats.get(framework.LogLevel.None);
+    this.console[method](formatter.run(this.preprocess(values)));
+  }
+  /**
+   * Pre-processes an array of values.
+   * @since 1.0.0
+   * @param values The values to pre-process.
+   */
+  preprocess(values) {
+    const inspectOptions = { colors: colorette.isColorSupported, depth: this.depth };
+    return values.map((value) => typeof value === "string" ? value : util.inspect(value, inspectOptions)).join(this.join);
+  }
+  get levels() {
+    return Reflect.get(framework.Logger, "levels");
+  }
+  /**
+   * Gets whether or not colorette is enabled.
+   * @since 1.0.0
+   */
+  static get stylize() {
+    return colorette.isColorSupported;
+  }
+  static createFormatMap(options = {}, defaults = options.none ?? {}) {
+    return /* @__PURE__ */ new Map([
+      [framework.LogLevel.Trace, _Logger.ensureDefaultLevel(options.trace, defaults, colorette.gray, "TRACE")],
+      [framework.LogLevel.Debug, _Logger.ensureDefaultLevel(options.debug, defaults, colorette.magenta, "DEBUG")],
+      [framework.LogLevel.Info, _Logger.ensureDefaultLevel(options.info, defaults, colorette.cyan, "INFO")],
+      [framework.LogLevel.Warn, _Logger.ensureDefaultLevel(options.warn, defaults, colorette.yellow, "WARN")],
+      [framework.LogLevel.Error, _Logger.ensureDefaultLevel(options.error, defaults, colorette.red, "ERROR")],
+      [framework.LogLevel.Fatal, _Logger.ensureDefaultLevel(options.fatal, defaults, colorette.bgRed, "FATAL")],
+      [framework.LogLevel.None, _Logger.ensureDefaultLevel(options.none, defaults, colorette.white, "")]
+    ]);
+  }
+  static ensureDefaultLevel(options, defaults, color, name) {
+    if (options)
+      return new LoggerLevel_cjs.LoggerLevel(options);
+    return new LoggerLevel_cjs.LoggerLevel({
+      ...defaults,
+      timestamp: defaults.timestamp === null ? null : { ...defaults.timestamp ?? {}, color },
+      infix: name.length ? `${color(name.padEnd(5, " "))} - ` : ""
+    });
+  }
+};
+__name(_Logger, "Logger");
+var Logger = _Logger;
+
+exports.Logger = Logger;
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=Logger.cjs.map

package/dist/cjs/lib/Logger.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/lib/Logger.ts"],"names":[],"mappings":";;;;;;;;;AAAA,SAAS,UAAU,eAAe,gBAAiC;AACnE,SAAS,OAAO,MAAM,MAAM,kBAAkB,SAAS,KAAK,OAAO,cAA0B;AAC7F,SAAS,eAAe;AACxB,SAAS,eAAoC;AAC7C,SAAS,mBAA4C;AAM9C,IAAM,UAAN,MAAM,gBAAe,cAAc;AAAA,EAyBlC,YAAY,UAAyB,CAAC,GAAG;AAC/C,UAAM,QAAQ,SAAS,SAAS,IAAI;AArBrC;AAAA;AAAA;AAAA;AAAA,wBAAgB;AAMhB;AAAA;AAAA;AAAA;AAAA,wBAAgB;AAMhB;AAAA;AAAA;AAAA;AAAA,wBAAgB;AAMhB;AAAA;AAAA;AAAA;AAAA,wBAAgB;AAKf,SAAK,UAAU,IAAI,QAAQ,QAAQ,UAAU,QAAQ,QAAQ,QAAQ,UAAU,QAAQ,MAAM;AAC7F,SAAK,UAAU,QAAO,gBAAgB,QAAQ,QAAQ,QAAQ,aAAa;AAC3E,SAAK,OAAO,QAAQ,QAAQ;AAC5B,SAAK,QAAQ,QAAQ,SAAS;AAAA,EAC/B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOgB,MAAM,UAAoB,QAAkC;AAC3E,QAAI,QAAQ,KAAK;AAAO;AAExB,UAAM,SAAS,KAAK,OAAO,IAAI,KAAK,KAAK;AACzC,UAAM,YAAY,KAAK,QAAQ,IAAI,KAAK,KAAK,KAAK,QAAQ,IAAI,SAAS,IAAI;AAE3E,SAAK,QAAQ,MAAM,EAAE,UAAU,IAAI,KAAK,WAAW,MAAM,CAAC,CAAC;AAAA,EAC5D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOU,WAAW,QAA4B;AAChD,UAAM,iBAAiC,EAAE,QAAQ,kBAAkB,OAAO,KAAK,MAAM;AACrF,WAAO,OAAO,IAAI,CAAC,UAAW,OAAO,UAAU,WAAW,QAAQ,QAAQ,OAAO,cAAc,CAAE,EAAE,KAAK,KAAK,IAAI;AAAA,EAClH;AAAA,EAEA,IAAY,SAAS;AACpB,WAAO,QAAQ,IAAI,eAAe,QAAQ;AAAA,EAC3C;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,WAAkB,UAAU;AAC3B,WAAO;AAAA,EACR;AAAA,EAEA,OAAe,gBAAgB,UAA+B,CAAC,GAAG,WAA+B,QAAQ,QAAQ,CAAC,GAAG;AACpH,WAAO,oBAAI,IAA2B;AAAA,MACrC,CAAC,SAAS,OAAO,QAAO,mBAAmB,QAAQ,OAAO,UAAU,MAAM,OAAO,CAAC;AAAA,MAClF,CAAC,SAAS,OAAO,QAAO,mBAAmB,QAAQ,OAAO,UAAU,SAAS,OAAO,CAAC;AAAA,MACrF,CAAC,SAAS,MAAM,QAAO,mBAAmB,QAAQ,MAAM,UAAU,MAAM,MAAM,CAAC;AAAA,MAC/E,CAAC,SAAS,MAAM,QAAO,mBAAmB,QAAQ,MAAM,UAAU,QAAQ,MAAM,CAAC;AAAA,MACjF,CAAC,SAAS,OAAO,QAAO,mBAAmB,QAAQ,OAAO,UAAU,KAAK,OAAO,CAAC;AAAA,MACjF,CAAC,SAAS,OAAO,QAAO,mBAAmB,QAAQ,OAAO,UAAU,OAAO,OAAO,CAAC;AAAA,MACnF,CAAC,SAAS,MAAM,QAAO,mBAAmB,QAAQ,MAAM,UAAU,OAAO,EAAE,CAAC;AAAA,IAC7E,CAAC;AAAA,EACF;AAAA,EAEA,OAAe,mBAAmB,SAAyC,UAA8B,OAAc,MAAc;AACpI,QAAI;AAAS,aAAO,IAAI,YAAY,OAAO;AAC3C,WAAO,IAAI,YAAY;AAAA,MACtB,GAAG;AAAA,MACH,WAAW,SAAS,cAAc,OAAO,OAAO,EAAE,GAAI,SAAS,aAAa,CAAC,GAAI,MAAM;AAAA,MACvF,OAAO,KAAK,SAAS,GAAG,MAAM,KAAK,OAAO,GAAG,GAAG,CAAC,CAAC,QAAQ;AAAA,IAC3D,CAAC;AAAA,EACF;AACD;AA1F0C;AAAnC,IAAM,SAAN","sourcesContent":["import { Logger as BuiltinLogger, LogLevel, type LogMethods } from '@sapphire/framework';\nimport { bgRed, cyan, gray, isColorSupported, magenta, red, white, yellow, type Color } from 'colorette';\nimport { Console } from 'console';\nimport { inspect, type InspectOptions } from 'util';\nimport { LoggerLevel, type LoggerLevelOptions } from './LoggerLevel';\n\n/**\n * The logger class.\n * @since 1.0.0\n */\nexport class Logger extends BuiltinLogger {\n\t/**\n\t * The console this writes to.\n\t * @since 1.0.0\n\t */\n\tpublic readonly console: Console;\n\n\t/**\n\t * The formats supported by the logger.\n\t * @since 1.0.0\n\t */\n\tpublic readonly formats: Map<LogLevel, LoggerLevel>;\n\n\t/**\n\t * The string `write` will join values by.\n\t * @since 1.0.0\n\t */\n\tpublic readonly join: string;\n\n\t/**\n\t * The inspect depth when logging objects.\n\t * @since 1.0.0\n\t */\n\tpublic readonly depth: number;\n\n\tpublic constructor(options: LoggerOptions = {}) {\n\t\tsuper(options.level ?? LogLevel.Info);\n\n\t\tthis.console = new Console(options.stdout ?? process.stdout, options.stderr ?? process.stderr);\n\t\tthis.formats = Logger.createFormatMap(options.format, options.defaultFormat);\n\t\tthis.join = options.join ?? ' ';\n\t\tthis.depth = options.depth ?? 0;\n\t}\n\n\t/**\n\t * Writes the log message given a level and the value(s).\n\t * @param level The log level.\n\t * @param values The values to log.\n\t */\n\tpublic override write(level: LogLevel, ...values: readonly unknown[]): void {\n\t\tif (level < this.level) return;\n\n\t\tconst method = this.levels.get(level) ?? 'log';\n\t\tconst formatter = this.formats.get(level) ?? this.formats.get(LogLevel.None)!;\n\n\t\tthis.console[method](formatter.run(this.preprocess(values)));\n\t}\n\n\t/**\n\t * Pre-processes an array of values.\n\t * @since 1.0.0\n\t * @param values The values to pre-process.\n\t */\n\tprotected preprocess(values: readonly unknown[]) {\n\t\tconst inspectOptions: InspectOptions = { colors: isColorSupported, depth: this.depth };\n\t\treturn values.map((value) => (typeof value === 'string' ? value : inspect(value, inspectOptions))).join(this.join);\n\t}\n\n\tprivate get levels() {\n\t\treturn Reflect.get(BuiltinLogger, 'levels') as Map<LogLevel, LogMethods>;\n\t}\n\n\t/**\n\t * Gets whether or not colorette is enabled.\n\t * @since 1.0.0\n\t */\n\tpublic static get stylize() {\n\t\treturn isColorSupported;\n\t}\n\n\tprivate static createFormatMap(options: LoggerFormatOptions = {}, defaults: LoggerLevelOptions = options.none ?? {}) {\n\t\treturn new Map<LogLevel, LoggerLevel>([\n\t\t\t[LogLevel.Trace, Logger.ensureDefaultLevel(options.trace, defaults, gray, 'TRACE')],\n\t\t\t[LogLevel.Debug, Logger.ensureDefaultLevel(options.debug, defaults, magenta, 'DEBUG')],\n\t\t\t[LogLevel.Info, Logger.ensureDefaultLevel(options.info, defaults, cyan, 'INFO')],\n\t\t\t[LogLevel.Warn, Logger.ensureDefaultLevel(options.warn, defaults, yellow, 'WARN')],\n\t\t\t[LogLevel.Error, Logger.ensureDefaultLevel(options.error, defaults, red, 'ERROR')],\n\t\t\t[LogLevel.Fatal, Logger.ensureDefaultLevel(options.fatal, defaults, bgRed, 'FATAL')],\n\t\t\t[LogLevel.None, Logger.ensureDefaultLevel(options.none, defaults, white, '')]\n\t\t]);\n\t}\n\n\tprivate static ensureDefaultLevel(options: LoggerLevelOptions | undefined, defaults: LoggerLevelOptions, color: Color, name: string) {\n\t\tif (options) return new LoggerLevel(options);\n\t\treturn new LoggerLevel({\n\t\t\t...defaults,\n\t\t\ttimestamp: defaults.timestamp === null ? null : { ...(defaults.timestamp ?? {}), color },\n\t\t\tinfix: name.length ? `${color(name.padEnd(5, ' '))} - ` : ''\n\t\t});\n\t}\n}\n\n/**\n * The logger options.\n * @since 1.0.0\n */\nexport interface LoggerOptions {\n\t/**\n\t * A writable stream for the output logs.\n\t * @since 1.0.0\n\t * @default process.stdout\n\t */\n\tstdout?: NodeJS.WritableStream;\n\n\t/**\n\t * A writable stream for the error logs.\n\t * @since 1.0.0\n\t * @default process.stderr\n\t */\n\tstderr?: NodeJS.WritableStream;\n\n\t/**\n\t * The default options used to fill all the possible values for {@link LoggerOptions.format}.\n\t * @since 1.0.0\n\t * @default options.format.none ?? {}\n\t */\n\tdefaultFormat?: LoggerLevelOptions;\n\n\t/**\n\t * The options for each log level. LogLevel.None serves to set the default for all keys, where only\n\t * {@link LoggerTimestampOptions.timestamp} and {@link LoggerLevelOptions.prefix} would be overridden.\n\t * @since 1.0.0\n\t * @default {}\n\t */\n\tformat?: LoggerFormatOptions;\n\n\t/**\n\t * The minimum log level.\n\t * @since 1.0.0\n\t * @default LogLevel.Info\n\t */\n\tlevel?: LogLevel;\n\n\t/**\n\t * The string that joins different messages.\n\t * @since 1.0.0\n\t * @default ' '\n\t */\n\tjoin?: string;\n\n\t/**\n\t * The inspect depth when logging objects.\n\t * @since 1.0.0\n\t * @default 0\n\t */\n\tdepth?: number;\n}\n\n/**\n * The logger format options.\n * @since 1.0.0\n */\nexport interface LoggerFormatOptions {\n\t/**\n\t * The logger options for the lowest log level, used when calling {@link ILogger.trace}.\n\t * @since 1.0.0\n\t */\n\ttrace?: LoggerLevelOptions;\n\n\t/**\n\t * The logger options for the debug level, used when calling {@link ILogger.debug}.\n\t * @since 1.0.0\n\t */\n\tdebug?: LoggerLevelOptions;\n\n\t/**\n\t * The logger options for the info level, used when calling {@link ILogger.info}.\n\t * @since 1.0.0\n\t */\n\tinfo?: LoggerLevelOptions;\n\n\t/**\n\t * The logger options for the warning level, used when calling {@link ILogger.warn}.\n\t * @since 1.0.0\n\t */\n\twarn?: LoggerLevelOptions;\n\n\t/**\n\t * The logger options for the error level, used when calling {@link ILogger.error}.\n\t * @since 1.0.0\n\t */\n\terror?: LoggerLevelOptions;\n\n\t/**\n\t * The logger options for the critical level, used when calling {@link ILogger.fatal}.\n\t * @since 1.0.0\n\t */\n\tfatal?: LoggerLevelOptions;\n\n\t/**\n\t * The logger options for an unknown or uncategorised level.\n\t * @since 1.0.0\n\t */\n\tnone?: LoggerLevelOptions;\n}\n"]}

package/dist/cjs/lib/LoggerLevel.cjs

@@ -0,0 +1,48 @@
+'use strict';
+
+var LoggerStyle_cjs = require('./LoggerStyle.cjs');
+var LoggerTimestamp_cjs = require('./LoggerTimestamp.cjs');
+
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+var _LoggerLevel = class _LoggerLevel {
+  constructor(options = {}) {
+    /**
+     * The timestamp formatter.
+     * @since 1.0.0
+     */
+    __publicField(this, "timestamp");
+    /**
+     * The infix, added between the timestamp and the message.
+     * @since 1.0.0
+     */
+    __publicField(this, "infix");
+    /**
+     * The style formatter for the message.
+     * @since 1.0.0
+     */
+    __publicField(this, "message");
+    this.timestamp = options.timestamp === null ? null : new LoggerTimestamp_cjs.LoggerTimestamp(options.timestamp);
+    this.infix = options.infix ?? "";
+    this.message = options.message === null ? null : new LoggerStyle_cjs.LoggerStyle(options.message);
+  }
+  run(content) {
+    const prefix = (this.timestamp?.run() ?? "") + this.infix;
+    if (prefix.length) {
+      const formatter = this.message ? (line) => prefix + this.message.run(line) : (line) => prefix + line;
+      return content.split("\n").map(formatter).join("\n");
+    }
+    return this.message ? this.message.run(content) : content;
+  }
+};
+__name(_LoggerLevel, "LoggerLevel");
+var LoggerLevel = _LoggerLevel;
+
+exports.LoggerLevel = LoggerLevel;
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=LoggerLevel.cjs.map

package/dist/cjs/lib/LoggerLevel.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/lib/LoggerLevel.ts"],"names":[],"mappings":";;;;;;;;;AAAA,SAAS,mBAA+C;AACxD,SAAS,uBAAoD;AAMtD,IAAM,eAAN,MAAM,aAAY;AAAA,EAmBjB,YAAY,UAA8B,CAAC,GAAG;AAdrD;AAAA;AAAA;AAAA;AAAA,wBAAO;AAMP;AAAA;AAAA;AAAA;AAAA,wBAAO;AAMP;AAAA;AAAA;AAAA;AAAA,wBAAO;AAGN,SAAK,YAAY,QAAQ,cAAc,OAAO,OAAO,IAAI,gBAAgB,QAAQ,SAAS;AAC1F,SAAK,QAAQ,QAAQ,SAAS;AAC9B,SAAK,UAAU,QAAQ,YAAY,OAAO,OAAO,IAAI,YAAY,QAAQ,OAAO;AAAA,EACjF;AAAA,EAEO,IAAI,SAAiB;AAC3B,UAAM,UAAU,KAAK,WAAW,IAAI,KAAK,MAAM,KAAK;AAEpD,QAAI,OAAO,QAAQ;AAClB,YAAM,YAAY,KAAK,UACpB,CAAC,SAAiB,SAAS,KAAK,QAAS,IAAI,IAAI,IACjD,CAAC,SAAiB,SAAS;AAC9B,aAAO,QAAQ,MAAM,IAAI,EAAE,IAAI,SAAS,EAAE,KAAK,IAAI;AAAA,IACpD;AAEA,WAAO,KAAK,UAAU,KAAK,QAAQ,IAAI,OAAO,IAAI;AAAA,EACnD;AACD;AArCyB;AAAlB,IAAM,cAAN","sourcesContent":["import { LoggerStyle, type LoggerStyleResolvable } from './LoggerStyle';\nimport { LoggerTimestamp, type LoggerTimestampOptions } from './LoggerTimestamp';\n\n/**\n * Logger utility that stores and applies a full style into the message.\n * @since 1.0.0\n */\nexport class LoggerLevel {\n\t/**\n\t * The timestamp formatter.\n\t * @since 1.0.0\n\t */\n\tpublic timestamp: LoggerTimestamp | null;\n\n\t/**\n\t * The infix, added between the timestamp and the message.\n\t * @since 1.0.0\n\t */\n\tpublic infix: string;\n\n\t/**\n\t * The style formatter for the message.\n\t * @since 1.0.0\n\t */\n\tpublic message: LoggerStyle | null;\n\n\tpublic constructor(options: LoggerLevelOptions = {}) {\n\t\tthis.timestamp = options.timestamp === null ? null : new LoggerTimestamp(options.timestamp);\n\t\tthis.infix = options.infix ?? '';\n\t\tthis.message = options.message === null ? null : new LoggerStyle(options.message);\n\t}\n\n\tpublic run(content: string) {\n\t\tconst prefix = (this.timestamp?.run() ?? '') + this.infix;\n\n\t\tif (prefix.length) {\n\t\t\tconst formatter = this.message //\n\t\t\t\t? (line: string) => prefix + this.message!.run(line)\n\t\t\t\t: (line: string) => prefix + line;\n\t\t\treturn content.split('\\n').map(formatter).join('\\n');\n\t\t}\n\n\t\treturn this.message ? this.message.run(content) : content;\n\t}\n}\n\n/**\n * The options for {@link LoggerLevel}.\n * @since 1.0.0\n */\nexport interface LoggerLevelOptions {\n\t/**\n\t * The timestamp options. Set to `null` to disable timestamp parsing.\n\t * @since 1.0.0\n\t * @default {}\n\t */\n\ttimestamp?: LoggerTimestampOptions | null;\n\n\t/**\n\t * The infix to be included between the timestamp and the message.\n\t * @since 1.0.0\n\t * @default ''\n\t */\n\tinfix?: string;\n\n\t/**\n\t * The style options for the message.\n\t * @since 1.0.0\n\t * @default colorette.clear\n\t */\n\tmessage?: LoggerStyleResolvable | null;\n}\n"]}