@visulima/pail 4.0.0-alpha.8 → 4.0.0

package/dist/reporter/simple/simple-reporter.server.d.ts

@@ -1,20 +1,217 @@
-import type { RenderErrorOptions } from "@visulima/error";
-import type { Options as InspectorOptions } from "@visulima/inspector";
-import type InteractiveManager from "../../interactive/interactive-manager.d.ts";
-import type { InteractiveStreamReporter, ReadonlyMeta } from "../../types.d.ts";
-import type { PrettyStyleOptions } from "../pretty/abstract-pretty-reporter.d.ts";
-import { AbstractPrettyReporter } from "../pretty/abstract-pretty-reporter.d.ts";
-export type SimpleReporterOptions = PrettyStyleOptions & {
-    error: Partial<Omit<RenderErrorOptions, "color | prefix | indentation">>;
-    inspect: Partial<InspectorOptions>;
+import { LiteralUnion } from 'type-fest';
+import { InteractiveManager } from '@visulima/interactive-manager';
+import { D as DefaultLogTypes, L as LoggerTypesConfig, f as ReadonlyMeta, d as LoggerTypesAwareReporter, I as InteractiveStreamReporter } from "../../packem_shared/types.d-Cz9S7jZh.js";
+import '@visulima/colorize';
+type ColorizeMethod = (value: string) => string;
+type CodeFrameOptions = {
+  color?: {
+    gutter?: ColorizeMethod;
+    marker?: ColorizeMethod;
+    message?: ColorizeMethod;
+  };
+  linesAbove?: number;
+  linesBelow?: number;
+  message?: string;
+  prefix?: string;
+  showGutter?: boolean;
+  showLineNumbers?: boolean;
+  tabWidth?: number | false;
 };
-export declare class SimpleReporter<T extends string = string, L extends string = string> extends AbstractPrettyReporter<T, L> implements InteractiveStreamReporter<L> {
-    #private;
-    constructor(options?: Partial<SimpleReporterOptions>);
-    setStdout(stdout_: NodeJS.WriteStream): void;
-    setStderr(stderr_: NodeJS.WriteStream): void;
-    setInteractiveManager(manager?: InteractiveManager): void;
-    setIsInteractive(interactive: boolean): void;
-    log(meta: ReadonlyMeta<L>): void;
-    protected formatMessage(data: ReadonlyMeta<L>): string;
+/**
+* The compiled position of a stack frame handed to a {@link SourceMapResolver}.
+*/
+interface SourceMapLocation {
+  column?: number;
+  file: string;
+  line: number;
 }
+/**
+* The resolved original position returned by a {@link SourceMapResolver}. Any omitted field falls
+* back to the compiled value. `source`, when provided, is used directly as the code-frame content
+* (e.g. from an inlined `sourcesContent`) instead of reading the resolved file from disk.
+*/
+interface ResolvedSourceLocation {
+  column?: number;
+  file?: string;
+  line?: number;
+  source?: string;
+}
+/**
+* Pluggable hook that maps a compiled `*.js:line:col` position back to its original source position
+* (e.g. TS/JSX). Return `undefined` (or throw) to leave the frame untouched. Synchronous so it can
+* be used by the synchronous `renderError`; resolve/inline your maps ahead of time.
+*/
+type SourceMapResolver = (location: SourceMapLocation) => ResolvedSourceLocation | undefined;
+type Options$1 = {
+  /**
+  * Read source files for code frames from anywhere on disk, including absolute paths outside
+  * `cwd`. Defaults to `false`, in which case only files resolving inside `cwd` are read — this
+  * prevents local file disclosure when rendering errors whose stack came from untrusted input
+  * (e.g. a deserialized error). Enable only for trusted, locally-thrown errors.
+  * @default false
+  */
+  allowAllFilePaths: boolean;
+  color: CodeFrameOptions["color"] & {
+    fileLine: ColorizeMethod;
+    hint: ColorizeMethod;
+    method: ColorizeMethod;
+    title: ColorizeMethod;
+  };
+  cwd: string;
+  displayShortPath: boolean;
+  filterStacktrace: ((line: string) => boolean) | undefined;
+  framesMaxLimit: number;
+  hideErrorCauseCodeView: boolean;
+  hideErrorCodeView: boolean;
+  hideErrorErrorsCodeView: boolean;
+  hideErrorTitle: boolean;
+  hideMessage: boolean;
+  indentation: number | "	";
+  prefix: string; /** Optional source-map resolver to map compiled frame positions back to original source. */
+  sourceMap?: SourceMapResolver;
+} & Omit<CodeFrameOptions, "message | prefix">;
+interface Options {
+  /**
+  * When `true`, honour custom inspectors: a value's
+  * `Symbol.for("nodejs.util.inspect.custom")` method (Node only),
+  * `Symbol.for("chai/inspect")` method, an `.inspect()` method, or a handler
+  * registered via `registerConstructor` / `registerStringTag`.
+  * @default true
+  */
+  customInspect: boolean;
+  /**
+  * The maximum nesting depth to traverse before collapsing a nested value to
+  * `[Object]` / `[Array]`. A value `&lt;= 0` disables the limit.
+  * @default 5
+  */
+  depth: number;
+  /**
+  * Pretty-print with indentation. `"\t"` indents with tabs, a positive integer
+  * indents with that many spaces, and `undefined` keeps everything on one line.
+  * @default undefined
+  */
+  indent: number | "	" | undefined;
+  /**
+  * The maximum number of array / typed-array / iterable elements to render
+  * before the remainder is replaced with an `… (N more)` marker. Use
+  * `Number.POSITIVE_INFINITY` to show every element.
+  * @default Number.POSITIVE_INFINITY
+  */
+  maxArrayLength: number;
+  /**
+  * When `true`, render large numbers and bigints with `_` digit-group
+  * separators (e.g. `1_000_000`).
+  * @default true
+  */
+  numericSeparator: boolean;
+  /**
+  * The quote character used when rendering string values and complex object
+  * keys.
+  * @default "single"
+  */
+  quoteStyle: "double" | "single";
+  /**
+  * When `true`, also render non-enumerable own properties of plain objects
+  * (mirrors `util.inspect`'s `showHidden`).
+  * @default false
+  */
+  showHidden: boolean;
+  /**
+  * Colourize / decorate a rendered fragment. Receives the raw fragment and a
+  * style hint and must return the (optionally wrapped) string. Defaults to the
+  * identity function.
+  */
+  stylize: (value: string, styleType: LiteralUnion<"bigint" | "boolean" | "date" | "null" | "number" | "regexp" | "special" | "string" | "symbol" | "undefined", string>) => string;
+  /**
+  * The maximum length (in characters) of a single rendered value before it is
+  * truncated with an ellipsis. Use `Number.POSITIVE_INFINITY` to disable
+  * truncation.
+  * @default Number.POSITIVE_INFINITY
+  */
+  truncate: number;
+}
+/**
+* Abstract Pretty Reporter.
+*
+* Base class for pretty-printing reporters that format log messages with colors,
+* styles, and structured layout. Provides common functionality for styling options
+* and logger type configuration.
+* @template T - Custom logger type names
+* @template L - Log level types
+* @example
+* ```typescript
+* class CustomPrettyReporter extends AbstractPrettyReporter {
+*   public log(meta: ReadonlyMeta) {
+*     const formatted = this.formatMessage(meta);
+*     console.log(formatted);
+*   }
+* }
+* ```
+*/
+declare abstract class AbstractPrettyReporter<T extends string = string, L extends string = string> implements LoggerTypesAwareReporter<T, L> {
+  /** Styling options for pretty formatting */
+  protected readonly styles: PrettyStyleOptions;
+  /** Logger type configurations for styling */
+  protected loggerTypes: LoggerTypesConfig<LiteralUnion<DefaultLogTypes, T>, L>;
+  /**
+  * Creates a new AbstractPrettyReporter instance.
+  * @param options Styling options for pretty formatting
+  * @protected
+  */
+  protected constructor(options: Partial<PrettyStyleOptions>);
+  /**
+  * Sets the logger types configuration for styling.
+  * @param types Logger type configurations with colors and labels
+  */
+  setLoggerTypes(types: LoggerTypesConfig<LiteralUnion<DefaultLogTypes, T>, L>): void;
+  /**
+  * Logs a message with pretty formatting.
+  * @param meta The log metadata to format and output
+  * @abstract
+  */
+  abstract log(meta: ReadonlyMeta<L>): void;
+}
+/**
+* Options for configuring pretty reporter styling.
+*/
+type PrettyStyleOptions = {
+  /** Bold styling options */
+  bold: {
+    /** Whether to bold the label text */
+    label: boolean;
+  };
+  /** Function to format dates in log output */
+  dateFormatter: (date: Date) => string;
+  /** Maximum length of message before line break (optional) */
+  messageLength: number | undefined;
+  /** Underline styling options */
+  underline: {
+    /** Whether to underline the label */
+    label: boolean;
+    /** Whether to underline prefixes */
+    prefix: boolean;
+    /** Whether to underline suffixes */
+    suffix: boolean;
+  };
+  /** Uppercase styling options */
+  uppercase: {
+    /** Whether to uppercase the label text */
+    label: boolean;
+  };
+};
+type SimpleReporterOptions = PrettyStyleOptions & {
+  error: Partial<Omit<Options$1, "color | prefix | indentation">>;
+  inspect: Partial<Options>;
+};
+declare class SimpleReporter<T extends string = string, L extends string = string> extends AbstractPrettyReporter<T, L> implements InteractiveStreamReporter<L> {
+  #private;
+  constructor(options?: Partial<SimpleReporterOptions>);
+  override setLoggerTypes(types: LoggerTypesConfig<LiteralUnion<DefaultLogTypes, T>, L>): void;
+  setStdout(stdout_: NodeJS.WriteStream): void;
+  setStderr(stderr_: NodeJS.WriteStream): void;
+  setInteractiveManager(manager?: InteractiveManager): void;
+  setIsInteractive(interactive: boolean): void;
+  log(meta: ReadonlyMeta<L>): void;
+  protected formatMessage(data: ReadonlyMeta<L>): string;
+}
+export { SimpleReporter, SimpleReporterOptions };

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

@@ -1,185 +1,11 @@
-import { createRequire as __cjs_createRequire } from "node:module";
+import{createRequire as P}from"node:module";import L from"@visulima/colorize";import{A as z,c as B,r as D,b as O,d as F,g as G,e as H,f as c,h as K,a as Q,j as C,V as U,U as $,i as X}from"../../packem_shared/abstract-pretty-reporter-DrLBJ6ds.js";const ie=P(import.meta.url),V=typeof globalThis<"u"&&typeof globalThis.process<"u"?globalThis.process:process,{stdout:W,stderr:Y}=V,{bgGrey:Z,bold:E,cyan:J,green:N,greenBright:ee,grey:h,red:b,underline:I,white:te}=L,se=/[\\/]pail[\\/]dist/,x=T=>!se.test(T);class he extends z{#e;#r;#i;#h=!1;#o;#s;#t;#a=!1;#n="";#p="";constructor(t={}){const{error:o,inspect:n,...i}=t;super({uppercase:{label:!0,...i.uppercase},...i}),this.#o={...B,indent:void 0,...n},this.#s={...o,color:{fileLine:N,hint:J,marker:b,message:b,method:ee,title:b}},this.#e=W,this.#r=Y,this.#l()}setLoggerTypes(t){super.setLoggerTypes(t),this.#l()}setStdout(t){this.#e=t,this.#t=void 0,this.#a=!1}setStderr(t){this.#r=t}setInteractiveManager(t){this.#i=t}setIsInteractive(t){this.#h=t}log(t){const o=this.formatMessage(t),n=t.type.level,i=D(n)?"stderr":"stdout",a=i==="stderr"?this.#r:this.#e;this.#h&&this.#i!==void 0&&a.isTTY?this.#i.update(i,o.split(`
+`),0):O(`${o}
+`,a)}#l(){this.#n=F(this.loggerTypes),this.#p=G(this.loggerTypes)}#u(){return!this.#a&&typeof this.#e.on=="function"&&(this.#a=!0,this.#e.on("resize",()=>{this.#t=void 0})),this.#t===void 0&&(this.#t=H().columns),this.#t}formatMessage(t){let o=this.#u();typeof this.styles.messageLength=="number"&&(o=this.styles.messageLength);const{badge:n,context:i,date:a,error:S,file:l,groups:f,label:g,message:u,prefix:d,repeated:j,scope:m,suffix:y,traceError:_,type:R}=t,{color:M}=this.loggerTypes[R.name],v=M?L[M]:te,p=f.map(()=>"    ").join(""),e=[];if(f.length>0&&e.push(`${p+h(`[${f.at(-1)??""}]`)} `),a&&e.push(`${h(this.styles.dateFormatter(typeof a=="string"?new Date(a):a))} `),n)e.push(E(v(n)));else{const s=this.#n;s.length>0&&e.push(h(" ".repeat(s.length)))}const A=this.#p,w=c(A);if(g){const s=c(g),r=Math.max(0,w-s);e.push(`${E(v(K(g,this.styles)))} `," ".repeat(r))}else e.push(" ".repeat(w+1));j&&e.push(`${Z.white(`[${String(j)}x]`)} `),Array.isArray(m)&&m.length>0&&e.push(`${h(`[${m.join(" > ")}]`)} `),d&&e.push(`${h(`[${this.styles.underline.prefix?I(d):d}]`)} `);const k=c(e.join(""));if(u!==Q){const s=typeof u=="string"?u:C(u,this.#o);e.push(p+U(s,{trim:!1,width:o-3,wrapMode:X.STRICT_WIDTH}))}if(i){let s=!1;e.push(...i.map(r=>{if(r instanceof Error)return s=!0,`
 
-const __cjs_require = __cjs_createRequire(import.meta.url);
+${$(r,{...this.#s,filterStacktrace:x,prefix:p})}`;if(typeof r=="object")return` ${C(r,this.#o)}`;const q=(s?`
 
-const __cjs_getProcess = typeof globalThis !== "undefined" && typeof globalThis.process !== "undefined" ? globalThis.process : process;
+`:" ")+String(r);return s=!1,q}))}if(S&&e.push($(S,{...this.#s,filterStacktrace:x,prefix:p})),_&&e.push(`
 
-const {
-  stdout,
-  stderr
-} = __cjs_getProcess;
-import colorize, { red, greenBright, cyan, green, grey, bold, bgGrey, underline, white } from '@visulima/colorize';
-import { A as AbstractPrettyReporter, d as defaultInspectorConfig, b as writeStream, t as terminalSize, c as getLongestBadge, g as getLongestLabel, e as getStringWidth, f as formatLabel, a as EMPTY_SYMBOL, i as inspect, w as wordWrap, r as renderError, W as WrapMode } from '../../packem_shared/abstract-pretty-reporter-jU8WL_6c.js';
-
-const PAIL_DIST_REGEX = /[\\/]pail[\\/]dist/;
-const pailFileFilter = (line) => !PAIL_DIST_REGEX.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 };
+${$(_,{...this.#s,filterStacktrace:x,hideErrorCauseCodeView:!0,hideErrorCodeView:!0,hideErrorErrorsCodeView:!0,hideMessage:!0,prefix:p})}`),y&&e.push(` ${p}${h(this.styles.underline.suffix?I(y):y)}`),l){const s=(l.name??"")+(l.line?`:${String(l.line)}`:""),r=Math.max(0,k-c("Caller: "));e.push(`
+`,h("Caller: ")," ".repeat(r),s,`
+`)}return e.join("")}}export{he as SimpleReporter};