browser-debugger-cli 0.1.0 → 0.3.0

package/dist/ui/formatting.d.ts

@@ -0,0 +1,300 @@
+/**
+ * Shared formatting utilities for UI output.
+ *
+ * This module provides low-level formatting helpers used across all UI components.
+ * Includes: separators, sections, lists, key-value pairs, text utilities, time formatting,
+ * and the OutputFormatter class for building complex formatted output.
+ */
+/**
+ * Fluent builder for constructing formatted console output.
+ *
+ * Provides a chainable API for building complex multi-line output with consistent
+ * spacing, indentation, and structure. All methods return `this` for chaining.
+ *
+ * @example
+ * ```typescript
+ * const output = new OutputFormatter()
+ *   .text('Found 3 elements:')
+ *   .list(['<div>', '<span>', '<p>'])
+ *   .blank()
+ *   .section('Next steps:', [
+ *     'Highlight: bdg dom highlight 0',
+ *     'Get HTML: bdg dom get 0'
+ *   ])
+ *   .build();
+ *
+ * console.log(output);
+ * // Output:
+ * // Found 3 elements:
+ * //   <div>
+ * //   <span>
+ * //   <p>
+ * //
+ * // Next steps:
+ * //   Highlight: bdg dom highlight 0
+ * //   Get HTML: bdg dom get 0
+ * ```
+ */
+export declare class OutputFormatter {
+    private lines;
+    /**
+     * Add a text line to the output.
+     *
+     * @param content - Text content to add
+     * @returns This formatter for chaining
+     */
+    text(content: string): this;
+    /**
+     * Add a blank line to the output.
+     *
+     * @returns This formatter for chaining
+     */
+    blank(): this;
+    /**
+     * Add an indented list of items.
+     *
+     * @param items - Array of items to list
+     * @param indent - Indentation spaces (default: 2)
+     * @returns This formatter for chaining
+     */
+    list(items: string[], indent?: number): this;
+    /**
+     * Add a section with title and indented items.
+     *
+     * @param title - Section title
+     * @param items - Array of items (will be indented)
+     * @param indent - Indentation spaces (default: 2)
+     * @returns This formatter for chaining
+     */
+    section(title: string, items: string[], indent?: number): this;
+    /**
+     * Add a horizontal separator line.
+     *
+     * @param char - Character to repeat (default: '━')
+     * @param width - Width in characters (default: 50)
+     * @returns This formatter for chaining
+     */
+    separator(char?: string, width?: number): this;
+    /**
+     * Add a key-value pair with alignment.
+     *
+     * @param key - Key string
+     * @param value - Value string
+     * @param keyWidth - Width to pad key to (default: no padding)
+     * @returns This formatter for chaining
+     */
+    keyValue(key: string, value: string, keyWidth?: number): this;
+    /**
+     * Add multiple key-value pairs with aligned keys.
+     *
+     * @param pairs - Array of [key, value] tuples
+     * @param keyWidth - Width to pad keys to (auto-calculated if not provided)
+     * @returns This formatter for chaining
+     */
+    keyValueList(pairs: Array<[string, string]>, keyWidth?: number): this;
+    /**
+     * Add indented content.
+     *
+     * @param content - Content to indent (can be multiline)
+     * @param spaces - Number of spaces to indent (default: 2)
+     * @returns This formatter for chaining
+     */
+    indent(content: string, spaces?: number): this;
+    /**
+     * Build the final output string.
+     *
+     * @returns Formatted output with lines joined by newlines
+     */
+    build(): string;
+}
+/**
+ * Create a horizontal separator line.
+ *
+ * @param char - Character to use for separator (default: '━')
+ * @param width - Width of separator in characters (default: 50)
+ * @returns Separator string
+ *
+ * @example
+ * ```typescript
+ * separator()        // → '━━━━━━...' (50 chars)
+ * separator('-', 20) // → '--------------------'
+ * ```
+ */
+export declare function separator(char?: string, width?: number): string;
+/**
+ * Create a titled section with content lines.
+ *
+ * @param title - Section title
+ * @param content - Array of content lines (will be indented)
+ * @param indent - Number of spaces to indent content (default: 2)
+ * @returns Formatted section string
+ *
+ * @example
+ * ```typescript
+ * section('Process Info:', [
+ *   'Daemon PID: 12345',
+ *   'Chrome PID: 67890'
+ * ])
+ * // →
+ * // Process Info:
+ * //   Daemon PID: 12345
+ * //   Chrome PID: 67890
+ * ```
+ */
+export declare function section(title: string, content: string[], indent?: number): string;
+/**
+ * Create a bullet list with optional indentation.
+ *
+ * @param items - Array of list items
+ * @param indent - Number of spaces to indent (default: 2)
+ * @param bullet - Bullet character (default: '-')
+ * @returns Formatted bullet list
+ *
+ * @example
+ * ```typescript
+ * bulletList(['Item 1', 'Item 2'], 2, '•')
+ * // →
+ * //   • Item 1
+ * //   • Item 2
+ * ```
+ */
+export declare function bulletList(items: string[], indent?: number, bullet?: string): string;
+/**
+ * Create a key-value pair with alignment.
+ *
+ * @param key - Key string
+ * @param value - Value string
+ * @param keyWidth - Width to pad key to (default: auto)
+ * @returns Formatted key-value pair
+ *
+ * @example
+ * ```typescript
+ * keyValue('Status', 'Active', 15)
+ * // → 'Status:         Active'
+ * ```
+ */
+export declare function keyValue(key: string, value: string, keyWidth?: number): string;
+/**
+ * Indent text by a number of spaces.
+ *
+ * @param text - Text to indent (can be multiline)
+ * @param spaces - Number of spaces to indent
+ * @returns Indented text
+ *
+ * @example
+ * ```typescript
+ * indent('Line 1\nLine 2', 4)
+ * // →
+ * //     Line 1
+ * //     Line 2
+ * ```
+ */
+export declare function indent(text: string, spaces: number): string;
+/**
+ * Truncate text to maximum length with ellipsis.
+ *
+ * @param text - Text to truncate
+ * @param maxLength - Maximum length
+ * @returns Truncated text
+ *
+ * @example
+ * ```typescript
+ * truncate('Very long text here', 10)
+ * // → 'Very lo...'
+ * ```
+ */
+export declare function truncate(text: string, maxLength: number): string;
+/**
+ * Truncate console message text (especially stack traces).
+ *
+ * @param text - The console message text
+ * @param maxLines - Maximum number of lines to show (default: 3)
+ * @returns Truncated text with line count
+ *
+ * @example
+ * ```typescript
+ * truncateText('Line 1\nLine 2\nLine 3\nLine 4\nLine 5', 3)
+ * // →
+ * // Line 1
+ * // Line 2
+ * // Line 3
+ * //   ... (2 more lines)
+ * ```
+ */
+export declare function truncateText(text: string, maxLines?: number): string;
+/**
+ * Truncate a URL for compact display.
+ *
+ * Removes www. prefix, shortens long paths with ellipsis, and truncates to maxLength.
+ *
+ * @param url - URL string to truncate
+ * @param maxLength - Maximum length of output (default: 60)
+ * @returns Truncated URL for display
+ *
+ * @example
+ * ```typescript
+ * truncateUrl('https://i.clarity.ms/collect')
+ *   // → 'clarity.ms/collect'
+ * truncateUrl('https://aswpapius.com/api/web-channels/47d7def8-d602-49ec-bfdb-c959b1346774')
+ *   // → 'aswpapius.com/.../47d7def8'
+ * ```
+ */
+export declare function truncateUrl(url: string, maxLength?: number): string;
+/**
+ * Pluralize a word based on count.
+ *
+ * @param count - Number of items
+ * @param singular - Singular form of word
+ * @param plural - Plural form of word (optional, defaults to singular + 's')
+ * @returns Formatted count with correct word form
+ *
+ * @example
+ * ```typescript
+ * pluralize(1, 'request')       // → '1 request'
+ * pluralize(5, 'request')       // → '5 requests'
+ * pluralize(0, 'entry', 'entries') // → '0 entries'
+ * ```
+ */
+export declare function pluralize(count: number, singular: string, plural?: string): string;
+/**
+ * Format duration in milliseconds to human-readable string.
+ *
+ * @param ms - Duration in milliseconds
+ * @returns Formatted duration string
+ *
+ * @example
+ * ```typescript
+ * formatDuration(1500)      // → '1.5s'
+ * formatDuration(65000)     // → '1m 5s'
+ * formatDuration(3661000)   // → '1h 1m'
+ * ```
+ */
+export declare function formatDuration(ms: number): string;
+/**
+ * Format timestamp to ISO string.
+ *
+ * @param date - Date object or timestamp
+ * @returns ISO 8601 formatted string
+ *
+ * @example
+ * ```typescript
+ * formatTimestamp(new Date())
+ * // → '2025-11-05T12:34:56.789Z'
+ * ```
+ */
+export declare function formatTimestamp(date: Date | number): string;
+/**
+ * Format relative time ("time ago").
+ *
+ * @param date - Date object or timestamp
+ * @returns Human-readable relative time
+ *
+ * @example
+ * ```typescript
+ * formatTimeAgo(Date.now() - 5000)     // → '5 seconds ago'
+ * formatTimeAgo(Date.now() - 65000)    // → '1 minute ago'
+ * formatTimeAgo(Date.now() - 3661000)  // → '1 hour ago'
+ * ```
+ */
+export declare function formatTimeAgo(date: Date | number): string;
+//# sourceMappingURL=formatting.d.ts.map

package/dist/ui/formatting.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"formatting.d.ts","sourceRoot":"","sources":["../../src/ui/formatting.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAQH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,KAAK,CAAgB;IAE7B;;;;;OAKG;IACH,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAK3B;;;;OAIG;IACH,KAAK,IAAI,IAAI;IAKb;;;;;;OAMG;IACH,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,MAAM,GAAE,MAAU,GAAG,IAAI;IAM/C;;;;;;;OAOG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,MAAM,GAAE,MAAU,GAAG,IAAI;IAKjE;;;;;;OAMG;IACH,SAAS,CAAC,IAAI,GAAE,MAAY,EAAE,KAAK,GAAE,MAAW,GAAG,IAAI;IAKvD;;;;;;;OAOG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI;IAM7D;;;;;;OAMG;IACH,YAAY,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI;IAMrE;;;;;;OAMG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,GAAE,MAAU,GAAG,IAAI;IAMjD;;;;OAIG;IACH,KAAK,IAAI,MAAM;CAGhB;AAMD;;;;;;;;;;;;GAYG;AACH,wBAAgB,SAAS,CAAC,IAAI,GAAE,MAAY,EAAE,KAAK,GAAE,MAAW,GAAG,MAAM,CAExE;AAMD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,MAAM,GAAE,MAAU,GAAG,MAAM,CAGpF;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,MAAM,GAAE,MAAU,EAAE,MAAM,GAAE,MAAY,GAAG,MAAM,CAG5F;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAK9E;AAMD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAM3D;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAKhE;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,GAAE,MAAU,GAAG,MAAM,CAWvE;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,GAAE,MAAW,GAAG,MAAM,CAuCvE;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAGlF;AAMD;;;;;;;;;;;;GAYG;AACH,wBAAgB,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAwBjD;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,GAAG,MAAM,CAG3D;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,GAAG,MAAM,CAoBzD"}