@wundr.io/cli 1.0.12 → 1.0.14

package/dist/framework/output-formatter.d.ts

@@ -0,0 +1,274 @@
+/**
+ * Output Formatter - Consistent output formatting for all CLI commands.
+ *
+ * Provides:
+ * - Table rendering with column alignment and truncation
+ * - JSON output (pretty or compact)
+ * - Key-value pair formatting
+ * - List formatting (ordered/unordered)
+ * - Tree rendering for hierarchical data
+ * - Progress bars
+ * - Status indicators with consistent color coding
+ * - Diff formatting
+ * - Smart output that respects --json, --quiet, --no-color flags
+ *
+ * @module framework/output-formatter
+ */
+import type { CommandContext, OutputFormatterInterface } from './command-interface';
+/**
+ * Options for table rendering.
+ */
+export interface TableOptions {
+    /** Column headers. If not provided, inferred from data keys. */
+    columns?: ColumnDefinition[];
+    /** Maximum width for the entire table. Defaults to terminal width. */
+    maxWidth?: number;
+    /** Whether to show row numbers. */
+    rowNumbers?: boolean;
+    /** Whether to show borders. */
+    borders?: boolean;
+    /** Header style. */
+    headerStyle?: 'bold' | 'underline' | 'dim' | 'none';
+    /** Empty table message. */
+    emptyMessage?: string;
+    /** Maximum number of rows to display. */
+    maxRows?: number;
+}
+/**
+ * Column definition for table rendering.
+ */
+export interface ColumnDefinition {
+    /** Column header label */
+    header: string;
+    /** Property key in the data object */
+    key: string;
+    /** Fixed width for the column. If not set, auto-calculated. */
+    width?: number;
+    /** Minimum width. */
+    minWidth?: number;
+    /** Maximum width. */
+    maxWidth?: number;
+    /** Text alignment. */
+    align?: 'left' | 'right' | 'center';
+    /** Custom formatter for cell values. */
+    format?: (value: unknown) => string;
+    /** Color function for cell values. */
+    color?: (value: unknown) => string;
+}
+/**
+ * Options for JSON output.
+ */
+export interface JsonOptions {
+    /** Pretty print with indentation. Defaults to true. */
+    pretty?: boolean;
+    /** Indentation spaces. Defaults to 2. */
+    indent?: number;
+    /** Sort object keys. */
+    sortKeys?: boolean;
+}
+/**
+ * Options for key-value pair formatting.
+ */
+export interface KeyValueOptions {
+    /** Separator between key and value. Defaults to ': '. */
+    separator?: string;
+    /** Padding for key column alignment. */
+    keyWidth?: number;
+    /** Color for keys. */
+    keyColor?: (s: string) => string;
+    /** Color for values. */
+    valueColor?: (s: string) => string;
+    /** Indentation level. */
+    indent?: number;
+}
+/**
+ * Options for list formatting.
+ */
+export interface ListOptions {
+    /** Ordered (numbered) list. */
+    ordered?: boolean;
+    /** Bullet character for unordered lists. */
+    bullet?: string;
+    /** Indentation level. */
+    indent?: number;
+}
+/**
+ * Node in a tree structure.
+ */
+export interface TreeNode {
+    /** Display label */
+    label: string;
+    /** Optional icon/prefix */
+    prefix?: string;
+    /** Child nodes */
+    children?: TreeNode[];
+}
+/**
+ * Options for tree rendering.
+ */
+export interface TreeOptions {
+    /** Whether to use Unicode box-drawing characters. Defaults to true. */
+    unicode?: boolean;
+    /** Indentation per level. */
+    indent?: number;
+    /** Maximum depth to render. */
+    maxDepth?: number;
+}
+/**
+ * Options for progress bar.
+ */
+export interface ProgressOptions {
+    /** Total width of the progress bar. Defaults to 30. */
+    width?: number;
+    /** Filled character. Defaults to '='. */
+    filled?: string;
+    /** Empty character. Defaults to '-'. */
+    empty?: string;
+    /** Show percentage. */
+    showPercentage?: boolean;
+    /** Show count (current/total). */
+    showCount?: boolean;
+    /** Label to show after the bar. */
+    label?: string;
+}
+/**
+ * Status states with associated colors and icons.
+ */
+export type StatusState = 'running' | 'stopped' | 'error' | 'pending' | 'done' | 'skipped' | 'warning' | 'healthy' | 'degraded' | 'unhealthy' | 'active' | 'paused' | 'terminated';
+export declare class OutputFormatter implements OutputFormatterInterface {
+    private noColor;
+    constructor(options?: {
+        noColor?: boolean;
+    });
+    /**
+     * Render a data array as an aligned table.
+     *
+     * @param data - Array of row objects
+     * @param options - Table rendering options
+     * @returns Formatted table string
+     */
+    table(data: Record<string, unknown>[], options?: TableOptions): string;
+    /**
+     * Format data as JSON.
+     *
+     * @param data - Any serializable data
+     * @param pretty - Pretty print. Defaults to true.
+     * @returns JSON string
+     */
+    json(data: unknown, pretty?: boolean): string;
+    /**
+     * Format key-value pairs with aligned columns.
+     *
+     * @param data - Object with string keys
+     * @param options - Formatting options
+     * @returns Formatted key-value string
+     */
+    keyValue(data: Record<string, unknown>, options?: KeyValueOptions): string;
+    /**
+     * Format items as a list.
+     *
+     * @param items - List items
+     * @param ordered - Use numbers instead of bullets
+     * @returns Formatted list string
+     */
+    list(items: string[], ordered?: boolean): string;
+    /**
+     * Render a tree structure.
+     *
+     * @param node - Root node
+     * @param options - Rendering options
+     * @returns Formatted tree string
+     */
+    tree(node: TreeNode, options?: TreeOptions): string;
+    /**
+     * Render a progress bar.
+     *
+     * @param current - Current progress value
+     * @param total - Total/target value
+     * @param width - Bar width in characters
+     * @returns Formatted progress bar string
+     */
+    progressBar(current: number, total: number, width?: number): string;
+    /**
+     * Format a status indicator with consistent color and icon.
+     *
+     * @param state - Status state
+     * @param label - Label to display next to the status
+     * @returns Formatted status string
+     */
+    status(state: string, label: string): string;
+    /**
+     * Format a simple diff between two values.
+     *
+     * @param before - Original value
+     * @param after - New value
+     * @returns Formatted diff string
+     */
+    diff(before: string, after: string): string;
+    /**
+     * Format a section header with a separator line.
+     *
+     * @param title - Section title
+     * @param width - Separator width. Defaults to 60.
+     * @returns Formatted header string
+     */
+    header(title: string, width?: number): string;
+    /**
+     * Format a sub-section header.
+     *
+     * @param title - Sub-section title
+     * @param width - Separator width. Defaults to 40.
+     * @returns Formatted sub-header string
+     */
+    subHeader(title: string, width?: number): string;
+    /**
+     * Format a duration in milliseconds to a human-readable string.
+     */
+    duration(ms: number): string;
+    /**
+     * Format bytes to a human-readable string.
+     */
+    bytes(bytes: number): string;
+    /**
+     * Format data as YAML.
+     * Uses a lightweight built-in serializer to avoid external dependencies.
+     *
+     * @param data - Any serializable data
+     * @param indent - Indentation level (used for recursion). Defaults to 0.
+     * @returns YAML-formatted string
+     */
+    yaml(data: unknown, indent?: number): string;
+    /**
+     * Format data in the specified output format.
+     *
+     * @param data - Data to format
+     * @param format - Output format
+     * @returns Formatted string
+     */
+    formatAs(data: unknown, format: 'json' | 'yaml' | 'table' | 'plain'): string;
+    /**
+     * Smart output respecting context flags (--json, --quiet, --no-color).
+     *
+     * In JSON mode: outputs data as JSON to stdout.
+     * In quiet mode: outputs nothing.
+     * Otherwise: outputs message to stdout.
+     *
+     * @param data - Structured data for JSON mode
+     * @param message - Human-readable message for normal mode
+     * @param context - Command context with global flags
+     */
+    output(data: unknown, message: string, context: CommandContext): void;
+    private inferColumns;
+    private calculateColumnWidths;
+    private padCell;
+    private applyHeaderStyle;
+    private truncate;
+    private formatValue;
+    private humanize;
+    /**
+     * Lightweight YAML serializer.
+     */
+    private toYaml;
+    private renderTreeChildren;
+}
+//# sourceMappingURL=output-formatter.d.ts.map

package/dist/framework/output-formatter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"output-formatter.d.ts","sourceRoot":"","sources":["../../src/framework/output-formatter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAIH,OAAO,KAAK,EACV,cAAc,EACd,wBAAwB,EACzB,MAAM,qBAAqB,CAAC;AAM7B;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,gEAAgE;IAChE,OAAO,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAE7B,sEAAsE;IACtE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,mCAAmC;IACnC,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB,+BAA+B;IAC/B,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,oBAAoB;IACpB,WAAW,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,KAAK,GAAG,MAAM,CAAC;IAEpD,2BAA2B;IAC3B,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,yCAAyC;IACzC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,0BAA0B;IAC1B,MAAM,EAAE,MAAM,CAAC;IAEf,sCAAsC;IACtC,GAAG,EAAE,MAAM,CAAC;IAEZ,+DAA+D;IAC/D,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,qBAAqB;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,qBAAqB;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,sBAAsB;IACtB,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAC;IAEpC,wCAAwC;IACxC,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,MAAM,CAAC;IAEpC,sCAAsC;IACtC,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,MAAM,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,uDAAuD;IACvD,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB,yCAAyC;IACzC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,wBAAwB;IACxB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,yDAAyD;IACzD,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,wCAAwC;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,sBAAsB;IACtB,QAAQ,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC;IAEjC,wBAAwB;IACxB,UAAU,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC;IAEnC,yBAAyB;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,+BAA+B;IAC/B,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,4CAA4C;IAC5C,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,yBAAyB;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,oBAAoB;IACpB,KAAK,EAAE,MAAM,CAAC;IAEd,2BAA2B;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,kBAAkB;IAClB,QAAQ,CAAC,EAAE,QAAQ,EAAE,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,uEAAuE;IACvE,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,6BAA6B;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,+BAA+B;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,uDAAuD;IACvD,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,yCAAyC;IACzC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,wCAAwC;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,uBAAuB;IACvB,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB,kCAAkC;IAClC,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB,mCAAmC;IACnC,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GACnB,SAAS,GACT,SAAS,GACT,OAAO,GACP,SAAS,GACT,MAAM,GACN,SAAS,GACT,SAAS,GACT,SAAS,GACT,UAAU,GACV,WAAW,GACX,QAAQ,GACR,QAAQ,GACR,YAAY,CAAC;AAuCjB,qBAAa,eAAgB,YAAW,wBAAwB;IAC9D,OAAO,CAAC,OAAO,CAAU;gBAEb,OAAO,GAAE;QAAE,OAAO,CAAC,EAAE,OAAO,CAAA;KAAO;IAQ/C;;;;;;OAMG;IACH,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,EAAE,OAAO,GAAE,YAAiB,GAAG,MAAM;IAyE1E;;;;;;OAMG;IACH,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,GAAE,OAAc,GAAG,MAAM;IAWnD;;;;;;OAMG;IACH,QAAQ,CACN,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,OAAO,GAAE,eAAoB,GAC5B,MAAM;IA4BT;;;;;;OAMG;IACH,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,OAAO,GAAE,OAAe,GAAG,MAAM;IAmBvD;;;;;;OAMG;IACH,IAAI,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,GAAE,WAAgB,GAAG,MAAM;IAmBvD;;;;;;;OAOG;IACH,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,GAAE,MAAW,GAAG,MAAM;IAqBvE;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM;IAc5C;;;;;;OAMG;IACH,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM;IAQ3C;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,GAAE,MAAW,GAAG,MAAM;IAIjD;;;;;;OAMG;IACH,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,GAAE,MAAW,GAAG,MAAM;IAQpD;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM;IAY5B;;OAEG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAY5B;;;;;;;OAOG;IACH,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,GAAE,MAAU,GAAG,MAAM;IAQ/C;;;;;;OAMG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM;IA6B5E;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,GAAG,IAAI;IAiBrE,OAAO,CAAC,YAAY;IAWpB,OAAO,CAAC,qBAAqB;IA4B7B,OAAO,CAAC,OAAO;IAoBf,OAAO,CAAC,gBAAgB;IAaxB,OAAO,CAAC,QAAQ;IAKhB,OAAO,CAAC,WAAW;IAUnB,OAAO,CAAC,QAAQ;IAUhB;;OAEG;IACH,OAAO,CAAC,MAAM;IA+Dd,OAAO,CAAC,kBAAkB;CAiC3B"}