legal-markdown-js/dist/cli/interactive/utils/format-helpers.js

Node.js implementation of LegalMarkdown for processing legal documents with markdown and YAML - Complete feature parity with Ruby version

/**
 * 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 chalk from 'chalk';
import * as path from 'path';
/**
 * 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 function formatConfigSummary(config) {
    const { inputFile, outputFilename, outputFormats, processingOptions, archiveOptions, cssFile } = config;
    let summary = chalk.bold.cyan('\n📋 Configuration Summary:\n\n');
    // Input file
    summary += `📄 ${chalk.bold('Input file:')} ${inputFile}\n`;
    // Output filename
    summary += `📝 ${chalk.bold('Output filename:')} ${outputFilename}\n`;
    // Output formats
    const formats = [];
    if (outputFormats.pdf)
        formats.push('PDF');
    if (outputFormats.html)
        formats.push('HTML');
    if (outputFormats.docx)
        formats.push('DOCX');
    if (outputFormats.markdown)
        formats.push('Markdown');
    if (outputFormats.metadata)
        formats.push('Metadata');
    summary += `🎯 ${chalk.bold('Output formats:')} ${formats.join(', ')}\n`;
    // CSS file
    if (cssFile) {
        summary += `🎨 ${chalk.bold('CSS file:')} ${cssFile}\n`;
    }
    else if (outputFormats.html || outputFormats.pdf || outputFormats.docx) {
        summary += `🎨 ${chalk.bold('CSS file:')} None\n`;
    }
    // Processing options
    const options = [];
    if (processingOptions.debug)
        options.push('Debug');
    if (processingOptions.fieldTracking)
        options.push('Field tracking');
    if (processingOptions.highlight)
        options.push('Highlight');
    if (options.length > 0) {
        summary += `⚙️  ${chalk.bold('Processing options:')} ${options.join(', ')}\n`;
    }
    // Archive options
    if (archiveOptions.enabled) {
        const archiveDir = archiveOptions.directory || 'default archive directory';
        summary += `📦 ${chalk.bold('Source archiving:')} Enabled → ${chalk.cyan(archiveDir)}\n`;
        summary += `   ${chalk.gray('Smart archiving will determine file handling based on content changes')}\n`;
    }
    else {
        summary += `📦 ${chalk.bold('Source archiving:')} Disabled\n`;
    }
    summary += '\n';
    return summary;
}
/**
 * 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 function formatSuccessMessage(outputFiles, archiveResult) {
    let message = chalk.bold.green('\n✅ Files generated successfully!\n\n');
    // Show generated files
    message += chalk.bold('📄 Generated files:\n');
    // Check if there are any highlight files
    const hasHighlight = outputFiles.some(file => file.includes('.HIGHLIGHT.'));
    if (hasHighlight) {
        // Group files by extension
        const grouped = new Map();
        for (const file of outputFiles) {
            const ext = path.extname(file);
            const basename = path.basename(file, ext);
            const isHighlight = basename.includes('.HIGHLIGHT');
            if (isHighlight) {
                const normalBasename = basename.replace('.HIGHLIGHT', '');
                const key = `${normalBasename}${ext}`;
                const existing = grouped.get(key) || {};
                existing.highlight = file;
                grouped.set(key, existing);
            }
            else {
                const key = `${basename}${ext}`;
                const existing = grouped.get(key) || {};
                existing.normal = file;
                grouped.set(key, existing);
            }
        }
        // Show grouped files by extension
        const extensions = new Set(Array.from(grouped.keys()).map(key => key.split('.').pop()?.toLowerCase()));
        for (const ext of ['md', 'html', 'pdf', 'docx']) {
            if (!extensions.has(ext))
                continue;
            message += chalk.gray(`\n   ${ext.toUpperCase()}:\n`);
            for (const [key, fileGroup] of grouped) {
                if (!key.endsWith(`.${ext}`))
                    continue;
                if (fileGroup.normal) {
                    message += `   ${chalk.cyan(fileGroup.normal)}\n`;
                }
                if (fileGroup.highlight) {
                    message += `   ${chalk.cyan(fileGroup.highlight)}\n`;
                }
            }
        }
    }
    else {
        // Simple list when no highlight
        for (const file of outputFiles) {
            message += `   ${chalk.cyan(file)}\n`;
        }
    }
    // Show archiving results only if archiving failed
    // (Successful archiving is already shown in Generated files section)
    if (archiveResult && !archiveResult.success) {
        message += '\n';
        message += chalk.bold('📦 Source file archiving:\n');
        message += `   ${chalk.red('✗')} Archiving failed: ${archiveResult.error}\n`;
    }
    message += '\n';
    return message;
}
/**
 * Format error message with consistent styling
 *
 * @param error Error message text to display
 * @returns Formatted error message with red styling and error icon
 */
export function formatErrorMessage(error) {
    return chalk.bold.red(`\n❌ Error: ${error}\n`);
}
/**
 * Format warning message with consistent styling
 *
 * @param warning Warning message text to display
 * @returns Formatted warning message with yellow styling and warning icon
 */
export function formatWarningMessage(warning) {
    return chalk.bold.yellow(`\n⚠️  Warning: ${warning}\n`);
}
//# sourceMappingURL=format-helpers.js.map