@visulima/pail 3.1.0 → 3.2.1

package/dist/reporter/simple/simple-reporter.server.js

@@ -1,11 +1,189 @@
-var q=Object.defineProperty;var x=(a,e)=>q(a,"name",{value:e,configurable:!0});import{createRequire as F}from"node:module";import G,{red as T,greenBright as z,cyan as H,green as W,grey as o,bold as R,white as J,bgGrey as K,underline as I}from"@visulima/colorize";import{u as N,n as Q,a as k,G as _}from"../../packem_shared/format-label-CpyyTBom.js";import{O as U,o as d,i as X,B as Z}from"../../packem_shared/index-CysYvHXs.js";import{E as ee}from"../../packem_shared/constants-DKfCaSUR.js";import{A as te,s as re}from"../../packem_shared/abstract-pretty-reporter-CUtSm20r.js";import{s as se}from"../../packem_shared/get-longest-label-B0NrI-o2.js";import{n as ie}from"../../packem_shared/write-stream-CD8XFv1L.js";const pe=F(import.meta.url),V=typeof globalThis<"u"&&typeof globalThis.process<"u"?globalThis.process:process,{stdout:Y,stderr:D}=V;var oe=Object.defineProperty,B=x((a,e)=>oe(a,"name",{value:e,configurable:!0}),"b");const j=B(a=>!/[\\/]pail[\\/]dist/.test(a),"pailFileFilter");class ge extends te{static{x(this,"SimpleReporter")}static{B(this,"SimpleReporter")}#t;#r;#s;#o=!1;#i;#e;constructor(e={}){const{error:n,inspect:p,...i}=e;super({uppercase:{label:!0,...i.uppercase},...i}),this.#i={...N,indent:void 0,...p},this.#e={...n,color:{fileLine:W,hint:H,marker:T,message:T,method:z,title:T}},this.#t=Y,this.#r=D}setStdout(e){this.#t=e}setStderr(e){this.#r=e}setInteractiveManager(e){this.#s=e}setIsInteractive(e){this.#o=e}log(e){const n=this.formatMessage(e),p=e.type.level,i=["error","trace","warn"].includes(p)?"stderr":"stdout",h=i==="stderr"?this.#r:this.#t;this.#o&&this.#s!==void 0&&h.isTTY?this.#s.update(i,n.split(`
-`),0):ie(`${n}
-`,h)}formatMessage(e){const{columns:n}=U();let p=n;typeof this.styles.messageLength=="number"&&(p=this.styles.messageLength);const{badge:i,context:h,date:c,error:S,file:u,groups:m,label:g,message:f,prefix:y,repeated:v,scope:$,suffix:b,traceError:w,type:L}=e,{color:E}=this.loggerTypes[L.name],M=E?G[E]:J,l=m.map(()=>"    ").join(""),t=[];if(m.length>0&&t.push(`${l+o(`[${m.at(-1)}]`)} `),c&&t.push(`${o(this.styles.dateFormatter(typeof c=="string"?new Date(c):c))} `),i)t.push(R(M(i)));else{const r=re(this.loggerTypes);r.length>0&&t.push(o(" ".repeat(r.length)))}const A=se(this.loggerTypes),C=d(A);if(g){const r=d(g),s=Math.max(0,C-r);t.push(`${R(M(Q(g,this.styles)))} `," ".repeat(s))}else t.push(" ".repeat(C+1));v&&t.push(`${K.white(`[${v}x]`)} `),Array.isArray($)&&$.length>0&&t.push(`${o(`[${$.join(" > ")}]`)} `),y&&t.push(`${o(`[${this.styles.underline.prefix?I(y):y}]`)} `);const O=d(t.join(""));if(f!==ee){const r=typeof f=="string"?f:k(f,this.#i);t.push(l+X(r,{trim:!1,width:p-3,wrapMode:Z.STRICT_WIDTH}))}if(h){let r=!1;t.push(...h.map(s=>{if(s instanceof Error)return r=!0,`
+import { createRequire as __cjs_createRequire } from "node:module";
 
-${_(s,{...this.#e,filterStacktrace:j,prefix:l})}`;if(typeof s=="object")return` ${k(s,this.#i)}`;const P=(r?`
+const __cjs_require = __cjs_createRequire(import.meta.url);
 
-`:" ")+s;return r=!1,P}))}if(S&&t.push(_(S,{...this.#e,filterStacktrace:j,prefix:l})),w&&t.push(`
+const __cjs_getProcess = typeof globalThis !== "undefined" && typeof globalThis.process !== "undefined" ? globalThis.process : process;
 
-${_(w,{...this.#e,filterStacktrace:j,hideErrorCauseCodeView:!0,hideErrorCodeView:!0,hideErrorErrorsCodeView:!0,hideMessage:!0,prefix:l})}`),b&&t.push(` ${l}${o(this.styles.underline.suffix?I(b):b)}`),u){const r=u.name+(u.line?`:${u.line}`:""),s=Math.max(0,O-d("Caller: "));t.push(`
-`,o("Caller: ")," ".repeat(s),r,`
-`)}return t.join("")}}export{ge as SimpleReporter};
+const {
+  stdout,
+  stderr
+} = __cjs_getProcess;
+import colorize, { red, greenBright, cyan, green, grey, bold, white, bgGrey, underline } from '@visulima/colorize';
+import { d as defaultInspectorConfig, f as formatLabel, i as inspect, r as renderError } from '../../packem_shared/format-label-Btft2KGP.js';
+import { t as terminalSize, g as getStringWidth, w as wordWrap, W as WrapMode } from '../../packem_shared/index-DqKWykfa.js';
+import { E as EMPTY_SYMBOL } from '../../packem_shared/constants-DfDr4MHC.js';
+import { A as AbstractPrettyReporter, g as getLongestBadge } from '../../packem_shared/abstract-pretty-reporter-DMPDCslJ.js';
+import { g as getLongestLabel } from '../../packem_shared/get-longest-label-C9PWeyKq.js';
+import { w as writeStream } from '../../packem_shared/write-stream-BG8fhcs3.js';
+
+const pailFileFilter = (line) => !/[\\/]pail[\\/]dist/.test(line);
+class SimpleReporter extends AbstractPrettyReporter {
+  #stdout;
+  #stderr;
+  #interactiveManager;
+  #interactive = false;
+  #inspectOptions;
+  #errorOptions;
+  constructor(options = {}) {
+    const { error: errorOptions, inspect: inspectOptions, ...rest } = options;
+    super({
+      uppercase: {
+        label: true,
+        ...rest.uppercase
+      },
+      ...rest
+    });
+    this.#inspectOptions = { ...defaultInspectorConfig, indent: void 0, ...inspectOptions };
+    this.#errorOptions = {
+      ...errorOptions,
+      color: {
+        fileLine: green,
+        hint: cyan,
+        marker: red,
+        message: red,
+        method: greenBright,
+        title: red
+      }
+    };
+    this.#stdout = stdout;
+    this.#stderr = stderr;
+  }
+  setStdout(stdout_) {
+    this.#stdout = stdout_;
+  }
+  setStderr(stderr_) {
+    this.#stderr = stderr_;
+  }
+  setInteractiveManager(manager) {
+    this.#interactiveManager = manager;
+  }
+  setIsInteractive(interactive) {
+    this.#interactive = interactive;
+  }
+  log(meta) {
+    const message = this.formatMessage(meta);
+    const logLevel = meta.type.level;
+    const streamType = ["error", "trace", "warn"].includes(logLevel) ? "stderr" : "stdout";
+    const stream = streamType === "stderr" ? this.#stderr : this.#stdout;
+    if (this.#interactive && this.#interactiveManager !== void 0 && stream.isTTY) {
+      this.#interactiveManager.update(streamType, message.split("\n"), 0);
+    } else {
+      writeStream(`${message}
+`, stream);
+    }
+  }
+  // eslint-disable-next-line sonarjs/cognitive-complexity
+  formatMessage(data) {
+    const { columns } = terminalSize();
+    let size = columns;
+    if (typeof this.styles.messageLength === "number") {
+      size = this.styles.messageLength;
+    }
+    const { badge, context, date, error, file, groups, label, message, prefix, repeated, scope, suffix, traceError, type } = data;
+    const { color } = this.loggerTypes[type.name];
+    const colorized = color ? colorize[color] : white;
+    const groupSpaces = groups.map(() => "    ").join("");
+    const items = [];
+    if (groups.length > 0) {
+      items.push(`${groupSpaces + grey(`[${groups.at(-1)}]`)} `);
+    }
+    if (date) {
+      items.push(`${grey(this.styles.dateFormatter(typeof date === "string" ? new Date(date) : date))} `);
+    }
+    if (badge) {
+      items.push(bold(colorized(badge)));
+    } else {
+      const longestBadge = getLongestBadge(this.loggerTypes);
+      if (longestBadge.length > 0) {
+        items.push(grey(" ".repeat(longestBadge.length)));
+      }
+    }
+    const longestLabel = getLongestLabel(this.loggerTypes);
+    const longestWidth = getStringWidth(longestLabel);
+    if (label) {
+      const labelWidth = getStringWidth(label);
+      const pad = Math.max(0, longestWidth - labelWidth);
+      items.push(`${bold(colorized(formatLabel(label, this.styles)))} `, " ".repeat(pad));
+    } else {
+      items.push(" ".repeat(longestWidth + 1));
+    }
+    if (repeated) {
+      items.push(`${bgGrey.white(`[${repeated}x]`)} `);
+    }
+    if (Array.isArray(scope) && scope.length > 0) {
+      items.push(`${grey(`[${scope.join(" > ")}]`)} `);
+    }
+    if (prefix) {
+      items.push(`${grey(`[${this.styles.underline.prefix ? underline(prefix) : prefix}]`)} `);
+    }
+    const titleSize = getStringWidth(items.join(""));
+    if (message !== EMPTY_SYMBOL) {
+      const formattedMessage = typeof message === "string" ? message : inspect(message, this.#inspectOptions);
+      items.push(
+        groupSpaces + wordWrap(formattedMessage, {
+          trim: false,
+          width: size - 3,
+          wrapMode: WrapMode.STRICT_WIDTH
+        })
+      );
+    }
+    if (context) {
+      let hasError = false;
+      items.push(
+        ...context.map((value) => {
+          if (value instanceof Error) {
+            hasError = true;
+            return `
+
+${renderError(value, {
+              ...this.#errorOptions,
+              filterStacktrace: pailFileFilter,
+              prefix: groupSpaces
+            })}`;
+          }
+          if (typeof value === "object") {
+            return ` ${inspect(value, this.#inspectOptions)}`;
+          }
+          const newValue = (hasError ? "\n\n" : " ") + value;
+          hasError = false;
+          return newValue;
+        })
+      );
+    }
+    if (error) {
+      items.push(
+        renderError(error, {
+          ...this.#errorOptions,
+          filterStacktrace: pailFileFilter,
+          prefix: groupSpaces
+        })
+      );
+    }
+    if (traceError) {
+      items.push(
+        `
+
+${renderError(traceError, {
+          ...this.#errorOptions,
+          filterStacktrace: pailFileFilter,
+          hideErrorCauseCodeView: true,
+          hideErrorCodeView: true,
+          hideErrorErrorsCodeView: true,
+          hideMessage: true,
+          prefix: groupSpaces
+        })}`
+      );
+    }
+    if (suffix) {
+      items.push(` ${groupSpaces}${grey(this.styles.underline.suffix ? underline(suffix) : suffix)}`);
+    }
+    if (file) {
+      const fileMessage = file.name + (file.line ? `:${file.line}` : "");
+      const callerPad = Math.max(0, titleSize - getStringWidth("Caller: "));
+      items.push("\n", grey("Caller: "), " ".repeat(callerPad), fileMessage, "\n");
+    }
+    return items.join("");
+  }
+}
+
+export { SimpleReporter };

package/dist/reporter/utils/default-inspector-config.d.ts

@@ -0,0 +1,3 @@
+import type { Options } from "@visulima/inspector";
+declare const defaultInspectorConfig: Partial<Options>;
+export default defaultInspectorConfig;

package/dist/reporter/utils/format-label.d.ts

@@ -0,0 +1,3 @@
+import type { PrettyStyleOptions } from "../pretty/abstract-pretty-reporter.d.ts";
+declare const formatLabel: (label: string, styles: PrettyStyleOptions) => string;
+export default formatLabel;

package/dist/spinner.d.ts

@@ -1,154 +1,220 @@
-import { InteractiveManager } from './interactive/index.js';
-
-// TODO: Load the spinner names from the JSON file.
-type SpinnerName =
-	| 'dots'
-	| 'dots2'
-	| 'dots3'
-	| 'dots4'
-	| 'dots5'
-	| 'dots6'
-	| 'dots7'
-	| 'dots8'
-	| 'dots9'
-	| 'dots10'
-	| 'dots11'
-	| 'dots12'
-	| 'dots13'
-	| 'dots14'
-	| 'dots8Bit'
-	| 'dotsCircle'
-	| 'sand'
-	| 'line'
-	| 'line2'
-	| 'rollingLine'
-	| 'pipe'
-	| 'simpleDots'
-	| 'simpleDotsScrolling'
-	| 'star'
-	| 'star2'
-	| 'flip'
-	| 'hamburger'
-	| 'growVertical'
-	| 'growHorizontal'
-	| 'balloon'
-	| 'balloon2'
-	| 'noise'
-	| 'bounce'
-	| 'boxBounce'
-	| 'boxBounce2'
-	| 'binary'
-	| 'triangle'
-	| 'arc'
-	| 'circle'
-	| 'squareCorners'
-	| 'circleQuarters'
-	| 'circleHalves'
-	| 'squish'
-	| 'toggle'
-	| 'toggle2'
-	| 'toggle3'
-	| 'toggle4'
-	| 'toggle5'
-	| 'toggle6'
-	| 'toggle7'
-	| 'toggle8'
-	| 'toggle9'
-	| 'toggle10'
-	| 'toggle11'
-	| 'toggle12'
-	| 'toggle13'
-	| 'arrow'
-	| 'arrow2'
-	| 'arrow3'
-	| 'bouncingBar'
-	| 'bouncingBall'
-	| 'smiley'
-	| 'monkey'
-	| 'hearts'
-	| 'clock'
-	| 'earth'
-	| 'material'
-	| 'moon'
-	| 'runner'
-	| 'pong'
-	| 'shark'
-	| 'dqpb'
-	| 'weather'
-	| 'christmas'
-	| 'grenade'
-	| 'point'
-	| 'layer'
-	| 'betaWave'
-	| 'fingerDance'
-	| 'fistBump'
-	| 'soccerHeader'
-	| 'mindblown'
-	| 'speaker'
-	| 'orangePulse'
-	| 'bluePulse'
-	| 'orangeBluePulse'
-	| 'timeTravel'
-	| 'aesthetic'
-	| 'dwarfFortress';
-
-interface SpinnerStyle {
+import type { SpinnerName } from "cli-spinners";
+import type InteractiveManager from "./interactive/interactive-manager.d.ts";
+/**
+ * Spinner style configuration using colorize.
+ */
+export interface SpinnerStyle {
+    /** Background color name (e.g., "bgRed", "bgBlue") */
     bgColor?: string;
+    /** Background color as hex (e.g., "#FF0000") */
     bgHex?: `#${string}`;
+    /** Background color as RGB (e.g., [255, 0, 0]) */
     bgRgb?: [number, number, number];
+    /** Apply bold style */
     bold?: boolean;
+    /** Foreground color name (e.g., "red", "blue", "green") */
     color?: string;
+    /** Apply dim/faint style */
     dim?: boolean;
+    /** Foreground color as hex (e.g., "#FF0000") */
     hex?: `#${string}`;
+    /** Apply inverse style (swap fg/bg) */
     inverse?: boolean;
+    /** Apply italic style */
     italic?: boolean;
+    /** Apply overline style */
     overline?: boolean;
+    /** Foreground color as RGB (e.g., [255, 0, 0]) */
     rgb?: [number, number, number];
+    /** Apply strikethrough style */
     strikethrough?: boolean;
+    /** Apply underline style */
     underline?: boolean;
 }
-interface SpinnerIcons {
+/**
+ * Spinner completion icons.
+ */
+export interface SpinnerIcons {
+    /** Icon to show on failure (default: "✖") */
     error?: string;
+    /** Icon to show on info (default: "ℹ") */
     info?: string;
+    /** Icon to show on success (default: "✓") */
     success?: string;
+    /** Icon to show on warning (default: "⚠") */
     warning?: string;
 }
-interface SpinnerOptions {
+/**
+ * Spinner style options.
+ */
+export interface SpinnerOptions {
+    /** Custom icons for completion states */
     icons?: SpinnerIcons;
+    /** Name of the spinner from cli-spinners */
     name?: SpinnerName;
+    /** Prefix text to show before the spinner */
     prefixText?: string;
+    /** Style configuration for the spinner */
     style?: SpinnerStyle;
+    /** Whether to output spinner (default: true) */
     verbose?: boolean;
 }
-interface SpinnerStartOptions {
+/**
+ * Options for starting a spinner.
+ */
+export interface SpinnerStartOptions {
+    /** Prefix text to show before the spinner */
     prefixText?: string;
 }
-declare class Spinner {
+/**
+ * Spinner class for creating loading indicators in terminal applications.
+ *
+ * Provides an easy-to-use interface for displaying spinners with various styles
+ * from the cli-spinners library. Works seamlessly with interactive terminal features.
+ * @example
+ * ```typescript
+ * const spinner = new Spinner({ name: "dots" });
+ * spinner.start("Loading...");
+ * // ... do work ...
+ * spinner.succeed("Done!");
+ * ```
+ */
+export declare class Spinner {
     #private;
+    /**
+     * Creates a new Spinner instance.
+     * @param options Configuration options for the spinner
+     * @param interactiveManager Optional interactive manager for terminal control
+     */
     constructor(options?: SpinnerOptions, interactiveManager?: InteractiveManager);
+    /**
+     * Current elapsed time in milliseconds.
+     */
     get elapsedTime(): number;
+    /**
+     * Get or set the spinner text.
+     */
     get getText(): string;
     set text(value: string);
+    /**
+     * Get or set the prefix text.
+     */
     get getPrefixText(): string;
     set prefixText(value: string);
+    /**
+     * Whether the spinner is currently active.
+     */
     get isRunning(): boolean;
+    /**
+     * Set the interactive manager for interactive mode.
+     * @internal
+     */
+    setInteractiveManager(manager?: InteractiveManager): void;
+    /**
+     * Set the multi spinner reference.
+     * @internal
+     */
+    setMultiSpinner(multiSpinner?: MultiSpinner): void;
+    /**
+     * Start the spinner with optional text.
+     * @param text Optional text to display
+     * @param options
+     * @param options.prefixText Optional prefix text to display
+     * @returns The spinner instance for chaining
+     */
     start(text?: string, options?: SpinnerStartOptions): this;
+    /**
+     * Stop the spinner with a success message.
+     * @param text Optional success text
+     */
     succeed(text?: string): void;
+    /**
+     * Stop the spinner with a failure message.
+     * @param text Optional failure text
+     */
     failed(text?: string): void;
+    /**
+     * Stop the spinner with a warning message.
+     * @param text Optional warning text
+     */
     warn(text?: string): void;
+    /**
+     * Stop the spinner with an info message.
+     * @param text Optional info text
+     */
     info(text?: string): void;
+    /**
+     * Pause the spinner without stopping it.
+     */
     pause(): void;
+    /**
+     * Resume the spinner if it was paused.
+     */
     resume(): void;
+    /**
+     * Get current frame output.
+     * @internal
+     */
+    getFrameOutput(): string;
 }
-declare class MultiSpinner {
+/**
+ * Multi-Spinner class for managing multiple spinners concurrently.
+ *
+ * Allows displaying and updating multiple spinners simultaneously with
+ * consistent formatting and management.
+ * @example
+ * ```typescript
+ * const multiSpinner = new MultiSpinner({ name: "dots" });
+ *
+ * const spinner1 = multiSpinner.create("Task 1");
+ * const spinner2 = multiSpinner.create("Task 2");
+ *
+ * spinner1.start();
+ * spinner2.start();
+ *
+ * // ... do work ...
+ *
+ * spinner1.succeed();
+ * spinner2.succeed();
+ * multiSpinner.stop();
+ * ```
+ */
+export declare class MultiSpinner {
     #private;
     constructor(options?: SpinnerOptions, interactiveManager?: InteractiveManager);
+    /**
+     * Set the interactive manager for interactive mode.
+     * @internal
+     */
+    setInteractiveManager(manager?: InteractiveManager): void;
+    /**
+     * Create a new spinner instance.
+     * @param text Initial text for the spinner
+     * @param options
+     * @param options.prefixText Optional prefix text to display
+     * @param options.style Optional style for the spinner
+     * @param options.verbose Whether to output spinner (default: true)
+     * @returns A new Spinner instance
+     */
     create(text?: string, options?: SpinnerOptions): Spinner;
+    /**
+     * Remove a spinner from the multi-spinner manager.
+     * @param spinner The spinner to remove
+     * @returns True if the spinner was removed, false otherwise
+     */
     remove(spinner: Spinner): boolean;
+    /**
+     * Stop all spinners.
+     */
     stop(): void;
+    /**
+     * Clear all spinners without stopping them.
+     */
     clear(): void;
+    /**
+     * Render all spinners.
+     * @internal
+     */
+    renderAll(): void;
 }
-type SpinnerType<T extends string = string, L extends string = string> = Record<T, L> & Spinner;
-
-export { MultiSpinner, Spinner };
-export type { SpinnerIcons, SpinnerOptions, SpinnerStartOptions, SpinnerStyle, SpinnerType };
+export type SpinnerType<T extends string = string, L extends string = string> = Record<T, L> & Spinner;