legal-markdown-js
Version:
Node.js implementation of LegalMarkdown for processing legal documents with markdown and YAML - Complete feature parity with Ruby version
46 lines • 1.94 kB
TypeScript
/**
* Display formatting utilities for Interactive CLI
*
* This module provides consistent formatting functions for displaying
* configuration summaries, success messages, errors, and warnings
* throughout the interactive CLI experience.
*/
import { InteractiveConfig, ProcessingResult } from '../types';
/**
* Format the configuration summary for confirmation display
*
* Creates a comprehensive, visually appealing summary of the user's
* selected configuration options, formatted with colors and icons
* for easy reading and confirmation.
*
* @param config Complete interactive configuration to summarize
* @returns Formatted configuration summary string with colors and icons
*/
export declare function formatConfigSummary(config: InteractiveConfig): string;
/**
* Format success message with generated files list and archive results
*
* Creates a celebratory success message displaying all the files
* that were successfully generated during processing, plus information
* about archiving results if archiving was enabled.
*
* @param outputFiles Array of absolute paths to generated output files
* @param archiveResult Archive operation results (if archiving was enabled)
* @returns Formatted success message with file list and archive info
*/
export declare function formatSuccessMessage(outputFiles: string[], archiveResult?: ProcessingResult['archiveResult']): string;
/**
* Format error message with consistent styling
*
* @param error Error message text to display
* @returns Formatted error message with red styling and error icon
*/
export declare function formatErrorMessage(error: string): string;
/**
* Format warning message with consistent styling
*
* @param warning Warning message text to display
* @returns Formatted warning message with yellow styling and warning icon
*/
export declare function formatWarningMessage(warning: string): string;
//# sourceMappingURL=format-helpers.d.ts.map