@storm-software/config-tools/dist/logger/console.d.ts

A package containing various utilities to support custom workspace configurations and environment management for Storm Software projects, including configuration file handling, environment variable management, and logging utilities.

import { StormWorkspaceConfig } from '@storm-software/config';
import { LogLevel } from '../types.js';
import { getChalk } from './chalk.js';

/**
 * Get the log function for a log level
 *
 * @param logLevel - The log level
 * @param config - The Storm configuration
 * @returns The log function
 */
declare const getLogFn: (logLevel?: number | LogLevel, config?: Partial<StormWorkspaceConfig>, _chalk?: ReturnType<typeof getChalk>) => ((message?: any) => void);
/**
 * Write a message to the console at the `fatal` log level
 *
 * @param message - The message to write
 * @param config - The Storm configuration
 */
declare const writeFatal: (message?: any, config?: Partial<StormWorkspaceConfig>) => void;
/**
 * Write a message to the console at the `error` log level
 *
 * @param message - The message to write
 * @param config - The Storm configuration
 */
declare const writeError: (message?: any, config?: Partial<StormWorkspaceConfig>) => void;
/**
 * Write a message to the console at the `warning` log level
 *
 * @param message - The message to write
 * @param config - The Storm configuration
 */
declare const writeWarning: (message?: any, config?: Partial<StormWorkspaceConfig>) => void;
/**
 * Write a message to the console at the `info` log level
 *
 * @param message - The message to write
 * @param config - The Storm configuration
 */
declare const writeInfo: (message?: any, config?: Partial<StormWorkspaceConfig>) => void;
/**
 * Write a message to the console at the `success` log level
 *
 * @param message - The message to write
 * @param config - The Storm configuration
 */
declare const writeSuccess: (message?: any, config?: Partial<StormWorkspaceConfig>) => void;
/**
 * Write a message to the console at the `performance` log level
 *
 * @param message - The message to write
 * @param config - The Storm configuration
 */
declare const writePerformance: (message?: any, config?: Partial<StormWorkspaceConfig>) => void;
/**
 * Write a message to the console at the `debug` log level
 *
 * @param message - The message to write
 * @param config - The Storm configuration
 */
declare const writeDebug: (message?: any, config?: Partial<StormWorkspaceConfig>) => void;
/**
 * Write a message to the console at the `trace` log level
 *
 * @param message - The message to write
 * @param config - The Storm configuration
 */
declare const writeTrace: (message?: any, config?: Partial<StormWorkspaceConfig>) => void;
/**
 * Write a message to the console at the `all` log level
 *
 * @param message - The message to write
 * @param config - The Storm configuration
 */
declare const writeSystem: (message?: any, config?: Partial<StormWorkspaceConfig>) => void;
/**
 * Get a stopwatch function
 *
 * @param name - The name of the process
 * @returns The stopwatch function
 */
declare const getStopwatch: (name: string) => () => void;
type FormatLogMessageOptions = {
    prefix?: string;
    skip?: string[];
};
declare const formatLogMessage: (message?: any, options?: FormatLogMessageOptions, depth?: number) => string;
/**
 * Get the brand icon for the console
 *
 * @param config - The Storm configuration
 * @param _chalk - The chalk instance
 * @returns The brand icon
 */
declare const brandIcon: (config?: Partial<StormWorkspaceConfig>, _chalk?: ReturnType<typeof getChalk>) => string | undefined;

export { type FormatLogMessageOptions, brandIcon, formatLogMessage, getLogFn, getStopwatch, writeDebug, writeError, writeFatal, writeInfo, writePerformance, writeSuccess, writeSystem, writeTrace, writeWarning };