@reliverse/relinka 1.3.7 → 1.3.8

package/bin/{relinka-impl → core-impl}/deprecated/utils/tree.d.ts

@@ -1,41 +1,41 @@
-import { type ColorName } from "./deprecatedColors.js";
-export type TreeItemObject = {
-    /**
-     * Text of the item
-     */
-    text: string;
-    /**
-     * Children of the item
-     */
-    children?: TreeItem[];
-    /**
-     * Color of the item
-     */
-    color?: ColorName;
-};
-export type TreeItem = string | TreeItemObject;
-export type TreeOptions = {
-    /**
-     * Color of the tree
-     */
-    color?: ColorName;
-    /**
-     * Prefix of the tree
-     *
-     * @default "  "
-     */
-    prefix?: string;
-};
-/**
- * Formats a hierarchical list of items into a string representing a tree structure.
- * Each item in the tree can be a simple string or an object defining the text of the item,
- * optional children, and color. The tree structure can be customized with options
- * Specify the overall color and the prefix used for indentation and tree lines.
- *
- * @param {TreeItem[]} items - An array of items to include in the tree. Each item can be
- * either a string or an object with `text', `children' and `color' properties.
- * @param {TreeOptions} [options] - Optional settings to customize the appearance of the tree, including
- * the color of the tree text and the prefix for branches. See {@link TreeOptions}.
- * @returns {string} The formatted tree as a string, ready for printing to the console or elsewhere.
- */
-export declare function formatTree(items: TreeItem[], options?: TreeOptions): string;
+import { type ColorName } from "./deprecatedColors.js";
+export type TreeItemObject = {
+    /**
+     * Text of the item
+     */
+    text: string;
+    /**
+     * Children of the item
+     */
+    children?: TreeItem[];
+    /**
+     * Color of the item
+     */
+    color?: ColorName;
+};
+export type TreeItem = string | TreeItemObject;
+export type TreeOptions = {
+    /**
+     * Color of the tree
+     */
+    color?: ColorName;
+    /**
+     * Prefix of the tree
+     *
+     * @default "  "
+     */
+    prefix?: string;
+};
+/**
+ * Formats a hierarchical list of items into a string representing a tree structure.
+ * Each item in the tree can be a simple string or an object defining the text of the item,
+ * optional children, and color. The tree structure can be customized with options
+ * Specify the overall color and the prefix used for indentation and tree lines.
+ *
+ * @param {TreeItem[]} items - An array of items to include in the tree. Each item can be
+ * either a string or an object with `text', `children' and `color' properties.
+ * @param {TreeOptions} [options] - Optional settings to customize the appearance of the tree, including
+ * the color of the tree text and the prefix for branches. See {@link TreeOptions}.
+ * @returns {string} The formatted tree as a string, ready for printing to the console or elsewhere.
+ */
+export declare function formatTree(items: TreeItem[], options?: TreeOptions): string;

package/bin/{relinka-impl → core-impl}/impl-mod.d.ts

@@ -1,19 +1,19 @@
-import type { RelinkaConfig, LogLevel } from "../relinka-types.js";
-/**
- * Promise that resolves once c12 loads and merges the config.
- */
-export declare const relinkaConfig: Promise<RelinkaConfig>;
-/**
- * Logs a message synchronously using the current config.
- * Skips debug-level logs unless `debug` is true in the config.
- */
-export declare function relinka(type: LogLevel, message: string, ...args: unknown[]): void;
-/**
- * Logs a message asynchronously, waiting for the config to be fully loaded.
- * Also handles file writing and log cleanup if enabled.
- */
-export declare function relinkaAsync(type: LogLevel, message: string, ...args: unknown[]): Promise<void>;
-/**
- * Type helper for user config files.
- */
-export declare function defineConfig(config: Partial<RelinkaConfig>): Partial<RelinkaConfig>;
+import type { RelinkaConfig, LogLevel } from "../core-types.js";
+/**
+ * Promise that resolves once c12 loads and merges the config.
+ */
+export declare const relinkaConfig: Promise<RelinkaConfig>;
+/**
+ * Logs a message synchronously using the current config.
+ * Skips debug-level logs unless `debug` is true in the config.
+ */
+export declare function relinka(type: LogLevel | "clear", message: string, ...args: unknown[]): void;
+/**
+ * Logs a message asynchronously, waiting for the config to be fully loaded.
+ * Also handles file writing and log cleanup if enabled.
+ */
+export declare function relinkaAsync(type: LogLevel, message: string, ...args: unknown[]): Promise<void>;
+/**
+ * Type helper for user config files.
+ */
+export declare function defineConfig(config: Partial<RelinkaConfig>): Partial<RelinkaConfig>;

package/bin/{relinka-impl → core-impl}/impl-mod.js

@@ -263,6 +263,10 @@ async function appendToLogFile(config, absoluteLogFilePath, logMessage) {
   }
 }
 export function relinka(type, message, ...args) {
+  if (type === "clear") {
+    console.clear();
+    return;
+  }
   if (message === "") {
     console.log();
     return;

package/bin/{relinka-types.d.ts → core-types.d.ts}

@@ -1,194 +1,193 @@
-/// <reference types="node" />
-/** Configuration for special directory handling. */
-export type RelinkaSpecialDirsConfig = {
-    distDirNames?: string[];
-    useParentConfigInDist?: boolean;
-};
-/** Configuration for directory-related settings. */
-export type RelinkaDirsConfig = {
-    dailyLogs?: boolean;
-    logDir?: string;
-    maxLogFiles?: number;
-    specialDirs?: RelinkaSpecialDirsConfig;
-};
-/**
- * Configuration options for the Relinka logger.
- * All properties are optional to allow for partial configuration.
- * Defaults will be applied during initialization.
- */
-export type RelinkaConfig = {
-    debug?: boolean;
-    dirs?: RelinkaDirsConfig;
-    disableColors?: boolean;
-    logFilePath?: string;
-    saveLogsToFile?: boolean;
-    withTimestamp?: boolean;
-};
-/** Represents information about a log file for cleanup purposes. */
-export type LogFileInfo = {
-    path: string;
-    mtime: number;
-};
-/** Log level types used by the logger. */
-export type LogLevel = "error" | "info" | "success" | "verbose" | "warn";
-/**
- * Defines the level of logs as specific numbers or special number types.
- *
- * @type {0 | 1 | 2 | 3 | 4 | 5 | (number & {})} LogLevelDeprecated - Represents the log level.
- * @default 0 - Represents the default log level.
- */
-export type LogLevelDeprecated = 0 | 1 | 2 | 3 | 4 | 5 | (number & {});
-/**
- * Lists the types of log messages supported by the system.
- *
- * @type {"silent" | "fatal" | "error" | "warn" | "log" | "info" | "success" | "fail" | "ready" | "start" | "box" | "debug" | "trace" | "verbose"} LogTypeDeprecated - Represents the specific type of log message.
- */
-export type LogTypeDeprecated = "silent" | "fatal" | "error" | "warn" | "log" | "info" | "success" | "fail" | "ready" | "start" | "box" | "debug" | "trace" | "verbose";
-export type RelinkaOptionsDeprecated = {
-    /**
-     * An array of RelinkaReporterDeprecated instances used to handle and output log messages.
-     */
-    reporters: RelinkaReporterDeprecated[];
-    /**
-     * A record mapping LogTypeDeprecated to InputLogObject, defining the log configuration for each log type.
-     * See {@link LogTypeDeprecated} and {@link InputLogObject}.
-     */
-    types: Record<LogTypeDeprecated, InputLogObject>;
-    /**
-     * The minimum log level to output. See {@link LogLevelDeprecated}.
-     */
-    level: LogLevelDeprecated;
-    /**
-     * Default properties applied to all log messages unless overridden. See {@link InputLogObject}.
-     */
-    defaults: InputLogObject;
-    /**
-     * The maximum number of times a log message can be repeated within a given timeframe.
-     */
-    throttle: number;
-    /**
-     * The minimum time in milliseconds that must elapse before a throttled log message can be logged again.
-     */
-    throttleMin: number;
-    /**
-     * The Node.js writable stream for standard output. See {@link NodeJS.WriteStream}.
-     * @optional
-     */
-    stdout?: NodeJS.WriteStream;
-    /**
-     * The Node.js writeable stream for standard error output. See {@link NodeJS.WriteStream}.
-     * @optional
-     */
-    stderr?: NodeJS.WriteStream;
-    /**
-     * A function that allows you to mock log messages for testing purposes.
-     * @optional
-     */
-    mockFn?: (type: LogTypeDeprecated, defaults: InputLogObject) => (...args: any) => void;
-    /**
-     * Configuration options for formatting log messages. See {@link FormatOptions}.
-     */
-    formatOptions: FormatOptions;
-};
-/**
- * @see https://nodejs.org/api/util.html#util_util_inspect_object_showhidden_depth_colors
- */
-export type FormatOptions = {
-    /**
-     * The maximum number of columns to output, affects formatting.
-     * @optional
-     */
-    columns?: number;
-    /**
-     * Whether to include timestamp information in log messages.
-     * @optional
-     */
-    date?: boolean;
-    /**
-     * Whether to use colors in the output.
-     * @optional
-     */
-    colors?: boolean;
-    /**
-     * Specifies whether or not the output should be compact. Accepts a boolean or numeric level of compactness.
-     * @optional
-     */
-    compact?: boolean | number;
-    /**
-     * Allows additional custom formatting options.
-     */
-    [key: string]: unknown;
-};
-export type InputLogObject = {
-    /**
-     * The logging level of the message. See {@link LogLevelDeprecated}.
-     * @optional
-     */
-    level?: LogLevelDeprecated;
-    /**
-     * A string tag to categorize or identify the log message.
-     * @optional
-     */
-    tag?: string;
-    /**
-     * The type of log message, which affects how it's processed and displayed. See {@link LogTypeDeprecated}.
-     * @optional
-     */
-    type?: LogTypeDeprecated;
-    /**
-     * The main log message text.
-     * @optional
-     */
-    message?: string;
-    /**
-     * Additional text or texts to be logged with the message.
-     * @optional
-     */
-    additional?: string | string[];
-    /**
-     * Additional arguments to be logged with the message.
-     * @optional
-     */
-    args?: any[];
-    /**
-     * The date and time when the log message was created.
-     * @optional
-     */
-    date?: Date;
-};
-export type LogObject = {
-    /**
-     * The logging level of the message, overridden if required. See {@link LogLevelDeprecated}.
-     */
-    level: LogLevelDeprecated;
-    /**
-     * The type of log message, overridden if required. See {@link LogTypeDeprecated}.
-     */
-    type: LogTypeDeprecated;
-    /**
-     * A string tag to categorize or identify the log message, overridden if necessary.
-     */
-    tag: string;
-    /**
-     * Additional arguments to be logged with the message, overridden if necessary.
-     */
-    args: any[];
-    /**
-     * The date and time the log message was created, overridden if necessary.
-     */
-    date: Date;
-    /**
-     * Allows additional custom properties to be set on the log object.
-     */
-    [key: string]: unknown;
-} & InputLogObject;
-export type RelinkaReporterDeprecated = {
-    /**
-     * Defines how a log message is processed and displayed by this reporter.
-     * @param logObj The LogObject containing the log information to process. See {@link LogObject}.
-     * @param ctx An object containing context information such as options. See {@link RelinkaOptionsDeprecated}.
-     */
-    log: (logObj: LogObject, ctx: {
-        options: RelinkaOptionsDeprecated;
-    }) => void;
-};
+/** Configuration for special directory handling. */
+export type RelinkaSpecialDirsConfig = {
+    distDirNames?: string[];
+    useParentConfigInDist?: boolean;
+};
+/** Configuration for directory-related settings. */
+export type RelinkaDirsConfig = {
+    dailyLogs?: boolean;
+    logDir?: string;
+    maxLogFiles?: number;
+    specialDirs?: RelinkaSpecialDirsConfig;
+};
+/**
+ * Configuration options for the Relinka logger.
+ * All properties are optional to allow for partial configuration.
+ * Defaults will be applied during initialization.
+ */
+export type RelinkaConfig = {
+    debug?: boolean;
+    dirs?: RelinkaDirsConfig;
+    disableColors?: boolean;
+    logFilePath?: string;
+    saveLogsToFile?: boolean;
+    withTimestamp?: boolean;
+};
+/** Represents information about a log file for cleanup purposes. */
+export type LogFileInfo = {
+    path: string;
+    mtime: number;
+};
+/** Log level types used by the logger. */
+export type LogLevel = "error" | "info" | "success" | "verbose" | "warn";
+/**
+ * Defines the level of logs as specific numbers or special number types.
+ *
+ * @type {0 | 1 | 2 | 3 | 4 | 5 | (number & {})} LogLevelDeprecated - Represents the log level.
+ * @default 0 - Represents the default log level.
+ */
+export type LogLevelDeprecated = 0 | 1 | 2 | 3 | 4 | 5 | (number & {});
+/**
+ * Lists the types of log messages supported by the system.
+ *
+ * @type {"silent" | "fatal" | "error" | "warn" | "log" | "info" | "success" | "fail" | "ready" | "start" | "box" | "debug" | "trace" | "verbose"} LogTypeDeprecated - Represents the specific type of log message.
+ */
+export type LogTypeDeprecated = "silent" | "fatal" | "error" | "warn" | "log" | "info" | "success" | "fail" | "ready" | "start" | "box" | "debug" | "trace" | "verbose";
+export type RelinkaOptionsDeprecated = {
+    /**
+     * An array of RelinkaReporterDeprecated instances used to handle and output log messages.
+     */
+    reporters: RelinkaReporterDeprecated[];
+    /**
+     * A record mapping LogTypeDeprecated to InputLogObject, defining the log configuration for each log type.
+     * See {@link LogTypeDeprecated} and {@link InputLogObject}.
+     */
+    types: Record<LogTypeDeprecated, InputLogObject>;
+    /**
+     * The minimum log level to output. See {@link LogLevelDeprecated}.
+     */
+    level: LogLevelDeprecated;
+    /**
+     * Default properties applied to all log messages unless overridden. See {@link InputLogObject}.
+     */
+    defaults: InputLogObject;
+    /**
+     * The maximum number of times a log message can be repeated within a given timeframe.
+     */
+    throttle: number;
+    /**
+     * The minimum time in milliseconds that must elapse before a throttled log message can be logged again.
+     */
+    throttleMin: number;
+    /**
+     * The Node.js writable stream for standard output. See {@link NodeJS.WriteStream}.
+     * @optional
+     */
+    stdout?: NodeJS.WriteStream;
+    /**
+     * The Node.js writeable stream for standard error output. See {@link NodeJS.WriteStream}.
+     * @optional
+     */
+    stderr?: NodeJS.WriteStream;
+    /**
+     * A function that allows you to mock log messages for testing purposes.
+     * @optional
+     */
+    mockFn?: (type: LogTypeDeprecated, defaults: InputLogObject) => (...args: any) => void;
+    /**
+     * Configuration options for formatting log messages. See {@link FormatOptions}.
+     */
+    formatOptions: FormatOptions;
+};
+/**
+ * @see https://nodejs.org/api/util.html#util_util_inspect_object_showhidden_depth_colors
+ */
+export type FormatOptions = {
+    /**
+     * The maximum number of columns to output, affects formatting.
+     * @optional
+     */
+    columns?: number;
+    /**
+     * Whether to include timestamp information in log messages.
+     * @optional
+     */
+    date?: boolean;
+    /**
+     * Whether to use colors in the output.
+     * @optional
+     */
+    colors?: boolean;
+    /**
+     * Specifies whether or not the output should be compact. Accepts a boolean or numeric level of compactness.
+     * @optional
+     */
+    compact?: boolean | number;
+    /**
+     * Allows additional custom formatting options.
+     */
+    [key: string]: unknown;
+};
+export type InputLogObject = {
+    /**
+     * The logging level of the message. See {@link LogLevelDeprecated}.
+     * @optional
+     */
+    level?: LogLevelDeprecated;
+    /**
+     * A string tag to categorize or identify the log message.
+     * @optional
+     */
+    tag?: string;
+    /**
+     * The type of log message, which affects how it's processed and displayed. See {@link LogTypeDeprecated}.
+     * @optional
+     */
+    type?: LogTypeDeprecated;
+    /**
+     * The main log message text.
+     * @optional
+     */
+    message?: string;
+    /**
+     * Additional text or texts to be logged with the message.
+     * @optional
+     */
+    additional?: string | string[];
+    /**
+     * Additional arguments to be logged with the message.
+     * @optional
+     */
+    args?: any[];
+    /**
+     * The date and time when the log message was created.
+     * @optional
+     */
+    date?: Date;
+};
+export type LogObject = {
+    /**
+     * The logging level of the message, overridden if required. See {@link LogLevelDeprecated}.
+     */
+    level: LogLevelDeprecated;
+    /**
+     * The type of log message, overridden if required. See {@link LogTypeDeprecated}.
+     */
+    type: LogTypeDeprecated;
+    /**
+     * A string tag to categorize or identify the log message, overridden if necessary.
+     */
+    tag: string;
+    /**
+     * Additional arguments to be logged with the message, overridden if necessary.
+     */
+    args: any[];
+    /**
+     * The date and time the log message was created, overridden if necessary.
+     */
+    date: Date;
+    /**
+     * Allows additional custom properties to be set on the log object.
+     */
+    [key: string]: unknown;
+} & InputLogObject;
+export type RelinkaReporterDeprecated = {
+    /**
+     * Defines how a log message is processed and displayed by this reporter.
+     * @param logObj The LogObject containing the log information to process. See {@link LogObject}.
+     * @param ctx An object containing context information such as options. See {@link RelinkaOptionsDeprecated}.
+     */
+    log: (logObj: LogObject, ctx: {
+        options: RelinkaOptionsDeprecated;
+    }) => void;
+};

package/bin/main.d.ts

@@ -1,22 +1,22 @@
-export { LogLevelsDeprecated, LogTypesDeprecated, } from "./relinka-impl/deprecated/components/levels/levels.js";
-export { createRelinkaBaseDeprecated, relinkaBasicDeprecated, } from "./relinka-impl/deprecated/components/modes/basic.js";
-export { createRelinkaBrowserDeprecatedDeprecated, relinkaBrowserDeprecated, } from "./relinka-impl/deprecated/components/modes/browser.js";
-export { relinkaDeprecated } from "./relinka-impl/deprecated/components/relinka-deprecated/logger.js";
-export { createRelinkaSharedDeprecated, relinkaInstanceDeprecated, } from "./relinka-impl/deprecated/components/relinka-deprecated/mod.js";
-export type { LogFn, RelinkaInstanceDeprecated, } from "./relinka-impl/deprecated/components/relinka-deprecated/relinka.js";
-export { RelinkaInterface, createRelinkaDeprecated, } from "./relinka-impl/deprecated/components/relinka-deprecated/relinka.js";
-export { BasicReporter } from "./relinka-impl/deprecated/components/reporters/basic.js";
-export { BrowserReporter } from "./relinka-impl/deprecated/components/reporters/browser.js";
-export { TYPE_COLOR_MAP, LEVEL_COLOR_MAP, FancyReporter, } from "./relinka-impl/deprecated/components/reporters/fancy.js";
-export type { BoxBorderStyle, BoxStyle, BoxOpts, } from "./relinka-impl/deprecated/utils/box.js";
-export { box } from "./relinka-impl/deprecated/utils/box.js";
-export type { ColorName, ColorFunction, } from "./relinka-impl/deprecated/utils/deprecatedColors.js";
-export { colors, getColor, colorize, } from "./relinka-impl/deprecated/utils/deprecatedColors.js";
-export { parseStack } from "./relinka-impl/deprecated/utils/error.js";
-export { compileFormat, formatString, } from "./relinka-impl/deprecated/utils/format.js";
-export { isPlainObject, isLogObj, } from "./relinka-impl/deprecated/utils/log.js";
-export { writeStream } from "./relinka-impl/deprecated/utils/stream.js";
-export { stripAnsi, centerAlign, rightAlign, leftAlign, align, } from "./relinka-impl/deprecated/utils/string.js";
-export type { TreeItemObject, TreeItem, TreeOptions, } from "./relinka-impl/deprecated/utils/tree.js";
-export { formatTree } from "./relinka-impl/deprecated/utils/tree.js";
-export { relinkaConfig, relinka, relinkaAsync, defineConfig, } from "./relinka-impl/impl-mod.js";
+export { LogLevelsDeprecated, LogTypesDeprecated, } from "./core-impl/deprecated/components/levels/levels.js";
+export { createRelinkaBaseDeprecated, relinkaBasicDeprecated, } from "./core-impl/deprecated/components/modes/basic.js";
+export { createRelinkaBrowserDeprecatedDeprecated, relinkaBrowserDeprecated, } from "./core-impl/deprecated/components/modes/browser.js";
+export { relinkaDeprecated } from "./core-impl/deprecated/components/relinka-deprecated/logger.js";
+export { createRelinkaSharedDeprecated, relinkaInstanceDeprecated, } from "./core-impl/deprecated/components/relinka-deprecated/mod.js";
+export type { LogFn, RelinkaInstanceDeprecated, } from "./core-impl/deprecated/components/relinka-deprecated/relinka.js";
+export { RelinkaInterface, createRelinkaDeprecated, } from "./core-impl/deprecated/components/relinka-deprecated/relinka.js";
+export { BasicReporter } from "./core-impl/deprecated/components/reporters/basic.js";
+export { BrowserReporter } from "./core-impl/deprecated/components/reporters/browser.js";
+export { TYPE_COLOR_MAP, LEVEL_COLOR_MAP, FancyReporter, } from "./core-impl/deprecated/components/reporters/fancy.js";
+export type { BoxBorderStyle, BoxStyle, BoxOpts, } from "./core-impl/deprecated/utils/box.js";
+export { box } from "./core-impl/deprecated/utils/box.js";
+export type { ColorName, ColorFunction, } from "./core-impl/deprecated/utils/deprecatedColors.js";
+export { colors, getColor, colorize, } from "./core-impl/deprecated/utils/deprecatedColors.js";
+export { parseStack } from "./core-impl/deprecated/utils/error.js";
+export { compileFormat, formatString, } from "./core-impl/deprecated/utils/format.js";
+export { isPlainObject, isLogObj, } from "./core-impl/deprecated/utils/log.js";
+export { writeStream } from "./core-impl/deprecated/utils/stream.js";
+export { stripAnsi, centerAlign, rightAlign, leftAlign, align, } from "./core-impl/deprecated/utils/string.js";
+export type { TreeItemObject, TreeItem, TreeOptions, } from "./core-impl/deprecated/utils/tree.js";
+export { formatTree } from "./core-impl/deprecated/utils/tree.js";
+export { relinkaConfig, relinka, relinkaAsync, defineConfig, } from "./core-impl/impl-mod.js";