storybook 10.1.0-alpha.9 → 10.1.0-beta.0

package/dist/node-logger/index.d.ts

@@ -1,8 +1,32 @@
 /// <reference types="node" />
+import { Readable, Writable } from 'node:stream';
 import { EventEmitter } from 'events';
 import { Buffer } from 'node:buffer';
 import { ChildProcess } from 'node:child_process';
-import { Readable, Writable } from 'node:stream';
+
+interface CommonOptions {
+    input?: Readable;
+    output?: Writable;
+    signal?: AbortSignal;
+}
+
+type BoxAlignment = 'left' | 'center' | 'right';
+interface BoxOptions extends CommonOptions {
+    contentAlign?: BoxAlignment;
+    titleAlign?: BoxAlignment;
+    width?: number | 'auto';
+    titlePadding?: number;
+    contentPadding?: number;
+    rounded?: boolean;
+    includePrefix?: boolean;
+    formatBorder?: (text: string) => string;
+}
+
+interface LogMessageOptions extends CommonOptions {
+    symbol?: string;
+    spacing?: number;
+    secondarySymbol?: string;
+}
 
 declare namespace npmlog {
     // TODO: newStream, newGroup, setGaugeTemplate and setGaugeTemplateSet need to be added
@@ -144,6 +168,11 @@ interface TaskLogInstance {
         showLog?: boolean;
     }) => void;
     error: (message: string) => void;
+    group: (title: string) => {
+        message: (text: string, options?: any) => void;
+        success: (message: string) => void;
+        error: (message: string) => void;
+    };
 }
 interface SpinnerOptions {
     /** The id of the task, to be used by the log tracker. */
@@ -371,24 +400,23 @@ ExecaChildPromise<StdoutStderrType> &
 Promise<ExecaReturnValue<StdoutStderrType>>;
 
 declare const prompt: {
-    executeTask: (childProcessFactories: (() => ExecaChildProcess) | (() => ExecaChildProcess)[], { id, intro, error, success, limitLines, }: {
-        id: string;
+    executeTask: (childProcessFactories: ((signal?: AbortSignal) => ExecaChildProcess) | ((signal?: AbortSignal) => ExecaChildProcess)[], { intro, error, success, abortable, }: {
         intro: string;
         error: string;
         success: string;
-        limitLines?: number;
+        abortable?: boolean;
     }) => Promise<void>;
-    executeTaskWithSpinner: (childProcessFactories: (() => ExecaChildProcess) | (() => ExecaChildProcess)[], { id, intro, error, success }: {
+    executeTaskWithSpinner: (childProcessFactories: ((signal?: AbortSignal) => ExecaChildProcess) | ((signal?: AbortSignal) => ExecaChildProcess)[], { id, intro, error, success, abortable, }: {
         id: string;
         intro: string;
         error: string;
         success: string;
+        abortable?: boolean;
     }) => Promise<void>;
-    setPromptLibrary: (library: "clack" | "prompts") => void;
-    getPromptLibrary: () => "clack" | "prompts";
+    setPromptLibrary: (library: "clack") => void;
+    getPromptLibrary: () => "clack";
     getPromptProvider: () => PromptProvider;
     isClackEnabled: () => boolean;
-    isPromptsEnabled: () => boolean;
     getPreferredStdio: () => "inherit" | "pipe";
     text: (options: TextPromptOptions, promptOptions?: PromptOptions) => Promise<string>;
     confirm: (options: ConfirmPromptOptions, promptOptions?: PromptOptions) => Promise<boolean>;
@@ -411,13 +439,10 @@ interface LogEntry {
  */
 declare class LogTracker {
     #private;
-    constructor();
     /** Enables writing logs to file. */
     enableLogWriting(): void;
     /** Returns whether logs should be written to file. */
     get shouldWriteLogsToFile(): boolean;
-    /** Returns the configured log file path. */
-    get logFilePath(): string;
     /** Returns a copy of all stored logs. */
     get logs(): LogEntry[];
     /**
@@ -437,7 +462,7 @@ declare class LogTracker {
      * @returns The path where logs were written, by default is debug-storybook.log in current working
      *   directory
      */
-    writeToFile(filePath?: string): Promise<string>;
+    writeToFile(filePath: string | boolean | undefined): Promise<string>;
 }
 declare const logTracker: LogTracker;
 
@@ -450,8 +475,156 @@ declare const CLI_COLORS: {
     info: Formatter;
     debug: Formatter;
     cta: Formatter;
+    muted: Formatter;
+    storybook: (text: string) => string;
 };
 
+interface ConsoleLoggerOptions {
+    prefix: string;
+    color: 'bgBlack' | 'bgRed' | 'bgGreen' | 'bgYellow' | 'bgBlue' | 'bgMagenta' | 'bgCyan' | 'bgWhite' | 'bgBlackBright' | 'bgRedBright' | 'bgGreenBright' | 'bgYellowBright' | 'bgBlueBright' | 'bgMagentaBright' | 'bgCyanBright' | 'bgWhiteBright';
+}
+declare class ConsoleLogger implements Console {
+    Console: typeof ConsoleLogger;
+    protected timers: Map<string, number>;
+    protected counters: Map<string, number>;
+    protected lastStatusLine: string | null;
+    protected statusLineCount: number;
+    protected get prefix(): string;
+    protected get color(): (text: string) => string;
+    protected formatMessage(...data: any[]): string;
+    assert(condition?: boolean, ...data: any[]): void;
+    /**
+     * The **`console.clear()`** static method clears the console if possible.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/clear_static)
+     */
+    clear(): void;
+    /**
+     * The **`console.count()`** static method logs the number of times that this particular call to
+     * `count()` has been called.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/count_static)
+     */
+    count(label?: string): void;
+    /**
+     * The **`console.countReset()`** static method resets counter used with console/count_static.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/countReset_static)
+     */
+    countReset(label?: string): void;
+    /**
+     * The **`console.debug()`** static method outputs a message to the console at the 'debug' log
+     * level.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/debug_static)
+     */
+    debug(...data: any[]): void;
+    /**
+     * The **`console.dir()`** static method displays a list of the properties of the specified
+     * JavaScript object.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/dir_static)
+     */
+    dir(item?: any, options?: any): void;
+    /**
+     * The **`console.dirxml()`** static method displays an interactive tree of the descendant
+     * elements of the specified XML/HTML element.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/dirxml_static)
+     */
+    dirxml(...data: any[]): void;
+    /**
+     * The **`console.error()`** static method outputs a message to the console at the 'error' log
+     * level.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/error_static)
+     */
+    error(...data: any[]): void;
+    /**
+     * The **`console.group()`** static method creates a new inline group in the Web console log,
+     * causing any subsequent console messages to be indented by an additional level, until
+     * console/groupEnd_static is called.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/group_static)
+     */
+    group(...data: any[]): void;
+    /**
+     * The **`console.groupCollapsed()`** static method creates a new inline group in the console.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/groupCollapsed_static)
+     */
+    groupCollapsed(...data: any[]): void;
+    /**
+     * The **`console.groupEnd()`** static method exits the current inline group in the console.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/groupEnd_static)
+     */
+    groupEnd(): void;
+    /**
+     * The **`console.info()`** static method outputs a message to the console at the 'info' log
+     * level.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/info_static)
+     */
+    info(...data: any[]): void;
+    /**
+     * The **`console.log()`** static method outputs a message to the console.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/log_static)
+     */
+    log(...data: any[]): void;
+    /**
+     * The **`console.table()`** static method displays tabular data as a table.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/table_static)
+     */
+    table(tabularData?: any, properties?: string[]): void;
+    /**
+     * The **`console.time()`** static method starts a timer you can use to track how long an
+     * operation takes.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/time_static)
+     */
+    time(label?: string): void;
+    /**
+     * The **`console.timeEnd()`** static method stops a timer that was previously started by calling
+     * console/time_static.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/timeEnd_static)
+     */
+    timeEnd(label?: string): void;
+    /**
+     * The **`console.timeLog()`** static method logs the current value of a timer that was previously
+     * started by calling console/time_static.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/timeLog_static)
+     */
+    timeLog(label?: string, ...data: any[]): void;
+    timeStamp(label?: string): void;
+    /**
+     * The **`console.trace()`** static method outputs a stack trace to the console.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/trace_static)
+     */
+    trace(...data: any[]): void;
+    /**
+     * The **`console.warn()`** static method outputs a warning message to the console at the
+     * 'warning' log level.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/warn_static)
+     */
+    warn(...data: any[]): void;
+    profile(label?: string): void;
+    profileEnd(label?: string): void;
+}
+declare class StyledConsoleLogger extends ConsoleLogger {
+    private _prefix;
+    private _color;
+    constructor(options: ConsoleLoggerOptions);
+    protected get prefix(): string;
+    protected get color(): Formatter;
+}
+
 /** @deprecated Use CLI_COLORS instead */
 declare const colors: {
     pink: (text: string) => string;
@@ -464,9 +637,8 @@ declare const colors: {
 };
 declare const logger: {
     verbose: (message: string) => void;
-    info: (message: string) => void;
-    plain: (message: string) => void;
     line: (count?: number) => void;
+    /** For non-critical issues or warnings */
     warn: (message: string) => void;
     trace: ({ message, time }: {
         message: string;
@@ -477,16 +649,12 @@ declare const logger: {
     setLogLevel: (level: LogLevel) => void;
     getLogLevel: () => LogLevel;
     shouldLog: (level: LogLevel) => boolean;
-    debug: (...args: any[]) => void;
-    log: (...args: any[]) => void;
-    logBox: (message: string, options?: {
-        borderStyle?: "round" | "none";
-        padding?: number;
+    debug: (message: any) => void;
+    log: (message?: string | string[] | undefined, args_1?: LogMessageOptions | undefined) => void;
+    info: (message: string, opts?: LogMessageOptions | undefined) => void;
+    logBox: (message: string, { title, ...options }?: {
         title?: string;
-        titleAlignment?: "left" | "center" | "right";
-        borderColor?: string;
-        backgroundColor?: string;
-    }) => void;
+    } & BoxOptions) => void;
     intro: (message: string) => void;
     outro: (message: string) => void;
     step: (message: string) => void;
@@ -507,4 +675,4 @@ declare const once: {
 };
 declare const deprecate: (message: string) => void;
 
-export { CLI_COLORS, type SpinnerInstance, type TaskLogInstance, colors, createHyperlink, deprecate, npmlog as instance, logTracker, logger, once, prompt, protectUrls };
+export { CLI_COLORS, ConsoleLogger, type SpinnerInstance, StyledConsoleLogger, type TaskLogInstance, colors, createHyperlink, deprecate, npmlog as instance, logTracker, logger, once, prompt, protectUrls };