docrev 0.8.1 → 0.8.5

package/dist/lib/errors.js

@@ -0,0 +1,303 @@
+/**
+ * Error handling utilities with actionable suggestions
+ */
+import chalk from 'chalk';
+import * as path from 'path';
+import * as fs from 'fs';
+/**
+ * Format an error message with optional suggestions
+ * @param message - Main error message
+ * @param suggestions - Actionable suggestions
+ * @returns Formatted error string
+ */
+export function formatError(message, suggestions = []) {
+    const lines = [chalk.red(`Error: ${message}`)];
+    if (suggestions.length > 0) {
+        lines.push('');
+        for (const suggestion of suggestions) {
+            lines.push(chalk.dim(`  ${suggestion}`));
+        }
+    }
+    return lines.join('\n');
+}
+/**
+ * Get actionable suggestions for file not found errors
+ * @param filePath - The file path that wasn't found
+ * @returns Array of suggestions
+ */
+export function getFileNotFoundSuggestions(filePath) {
+    const suggestions = [];
+    const ext = path.extname(filePath).toLowerCase();
+    const dir = path.dirname(filePath);
+    const base = path.basename(filePath);
+    // Check if directory exists
+    if (!fs.existsSync(dir)) {
+        suggestions.push(`Directory does not exist: ${dir}`);
+        suggestions.push(`Create it with: mkdir -p "${dir}"`);
+        return suggestions;
+    }
+    // Look for similar files
+    try {
+        const files = fs.readdirSync(dir);
+        const similar = findSimilarFiles(base, files, 3);
+        if (similar.length > 0) {
+            suggestions.push('Did you mean:');
+            for (const f of similar) {
+                suggestions.push(`  ${path.join(dir, f)}`);
+            }
+        }
+    }
+    catch {
+        // Directory not readable
+    }
+    // Extension-specific suggestions
+    if (ext === '.md' || ext === '') {
+        suggestions.push('Run "rev status" to see files in the current project');
+    }
+    else if (ext === '.docx') {
+        suggestions.push('Use "rev import <docx>" to import Word documents');
+    }
+    else if (ext === '.bib') {
+        suggestions.push('Create a bibliography with "rev doi bib <doi>"');
+        suggestions.push('Or check references.bib in your project');
+    }
+    else if (ext === '.pdf') {
+        suggestions.push('Build PDFs with "rev build pdf"');
+    }
+    return suggestions;
+}
+/**
+ * Get actionable suggestions for dependency errors
+ * @param dependency - The missing dependency
+ * @returns Array of suggestions
+ */
+export function getDependencySuggestions(dependency) {
+    const suggestions = [];
+    const platform = process.platform;
+    switch (dependency.toLowerCase()) {
+        case 'pandoc':
+            suggestions.push('Pandoc is required for document conversion');
+            if (platform === 'darwin') {
+                suggestions.push('Install with: brew install pandoc');
+            }
+            else if (platform === 'win32') {
+                suggestions.push('Install from: https://pandoc.org/installing.html');
+                suggestions.push('Or with: winget install --id JohnMacFarlane.Pandoc');
+            }
+            else {
+                suggestions.push('Install with: sudo apt install pandoc');
+                suggestions.push('Or from: https://pandoc.org/installing.html');
+            }
+            suggestions.push('Run "rev install" to check all dependencies');
+            break;
+        case 'pdflatex':
+        case 'xelatex':
+        case 'latex':
+            suggestions.push('LaTeX is required for PDF generation');
+            if (platform === 'darwin') {
+                suggestions.push('Install with: brew install --cask mactex');
+                suggestions.push('Or minimal: brew install --cask basictex');
+            }
+            else if (platform === 'win32') {
+                suggestions.push('Install MiKTeX from: https://miktex.org/download');
+                suggestions.push('Or TeX Live from: https://tug.org/texlive/');
+            }
+            else {
+                suggestions.push('Install with: sudo apt install texlive-full');
+                suggestions.push('Or minimal: sudo apt install texlive-latex-base');
+            }
+            suggestions.push('Alternative: Use "rev build docx" for Word output');
+            break;
+        case 'pandoc-crossref':
+            suggestions.push('pandoc-crossref enables figure/table/equation numbering');
+            if (platform === 'darwin') {
+                suggestions.push('Install with: brew install pandoc-crossref');
+            }
+            else if (platform === 'win32') {
+                suggestions.push('Download from: https://github.com/lierdakil/pandoc-crossref/releases');
+            }
+            else {
+                suggestions.push('Install with: sudo apt install pandoc-crossref');
+                suggestions.push('Or from: https://github.com/lierdakil/pandoc-crossref/releases');
+            }
+            suggestions.push('Cross-references will work but wonʼt be numbered without it');
+            break;
+    }
+    return suggestions;
+}
+/**
+ * Get actionable suggestions for configuration errors
+ * @param field - The problematic config field
+ * @param issue - What's wrong with it
+ * @returns Array of suggestions
+ */
+export function getConfigSuggestions(field, issue) {
+    const suggestions = [];
+    switch (field) {
+        case 'bibliography':
+            suggestions.push('Create a references.bib file in your project');
+            suggestions.push('Or set bibliography in rev.yaml:');
+            suggestions.push('  bibliography: path/to/refs.bib');
+            break;
+        case 'sections':
+            suggestions.push('List your sections in rev.yaml:');
+            suggestions.push('  sections:');
+            suggestions.push('    - introduction.md');
+            suggestions.push('    - methods.md');
+            suggestions.push('Or run "rev init" to auto-detect');
+            break;
+        case 'user':
+            suggestions.push('Set your name for comment attribution:');
+            suggestions.push('  rev config user "Your Name"');
+            break;
+        case 'csl':
+            suggestions.push('CSL styles control citation format');
+            suggestions.push('Download styles from: https://www.zotero.org/styles');
+            suggestions.push('Or use: citation-style: apa (common styles available)');
+            break;
+        default:
+            suggestions.push(`Check rev.yaml for "${field}" configuration`);
+            suggestions.push('Run "rev help config" for configuration options');
+    }
+    if (issue === 'typo') {
+        suggestions.unshift('This looks like a typo in rev.yaml');
+    }
+    return suggestions;
+}
+/**
+ * Get suggestions for comment/annotation errors
+ * @param issue - The issue type
+ * @returns Array of suggestions
+ */
+export function getAnnotationSuggestions(issue) {
+    const suggestions = [];
+    switch (issue) {
+        case 'no_comments':
+            suggestions.push('Comments use CriticMarkup syntax:');
+            suggestions.push('  {>>Author: Comment text<<}');
+            suggestions.push('Import from Word with: rev import <docx>');
+            break;
+        case 'no_changes':
+            suggestions.push('Track changes use CriticMarkup syntax:');
+            suggestions.push('  {++inserted text++}');
+            suggestions.push('  {--deleted text--}');
+            suggestions.push('  {~~old~>new~~}');
+            suggestions.push('Import from Word with: rev import <docx>');
+            break;
+        case 'invalid_number':
+            suggestions.push('Use "rev comments <file>" to see comment numbers');
+            suggestions.push('Or "rev status <file>" for a summary');
+            break;
+        case 'no_author':
+            suggestions.push('Set your author name:');
+            suggestions.push('  rev config user "Your Name"');
+            suggestions.push('Or use --author "Name" flag');
+            break;
+    }
+    return suggestions;
+}
+/**
+ * Get suggestions for build errors
+ * @param issue - The build issue
+ * @param context - Additional context
+ * @returns Array of suggestions
+ */
+export function getBuildSuggestions(issue, context = {}) {
+    const suggestions = [];
+    switch (issue) {
+        case 'no_sections':
+            suggestions.push('No section files found to build');
+            suggestions.push('Create markdown files or run "rev new" to start a project');
+            suggestions.push('Or run "rev init" to auto-detect existing files');
+            break;
+        case 'missing_bib':
+            suggestions.push('Bibliography file not found');
+            if (context.bibPath) {
+                suggestions.push(`Expected: ${context.bibPath}`);
+            }
+            suggestions.push('Create references.bib or update rev.yaml');
+            suggestions.push('Add citations with: rev doi bib <doi>');
+            break;
+        case 'pandoc_failed':
+            suggestions.push('Pandoc conversion failed');
+            suggestions.push('Check for syntax errors in your markdown');
+            suggestions.push('Run "rev validate" to check document structure');
+            if (context.format === 'pdf') {
+                suggestions.push('Try "rev build docx" as an alternative');
+            }
+            break;
+        case 'latex_error':
+            suggestions.push('LaTeX compilation failed');
+            suggestions.push('Common issues:');
+            suggestions.push('  - Missing packages (run tlmgr to install)');
+            suggestions.push('  - Invalid characters in text');
+            suggestions.push('  - Math mode errors');
+            suggestions.push('Try "rev build docx" to bypass LaTeX');
+            break;
+    }
+    return suggestions;
+}
+/**
+ * Find similar filenames using Levenshtein distance
+ * @param target - Target filename
+ * @param candidates - Available filenames
+ * @param limit - Max results
+ * @returns Array of similar filenames
+ */
+function findSimilarFiles(target, candidates, limit = 3) {
+    const scored = candidates
+        .map(c => ({ name: c, distance: levenshtein(target.toLowerCase(), c.toLowerCase()) }))
+        .filter(c => c.distance <= 3) // Only reasonably similar
+        .sort((a, b) => a.distance - b.distance);
+    return scored.slice(0, limit).map(c => c.name);
+}
+/**
+ * Simple Levenshtein distance
+ * @param a - First string
+ * @param b - Second string
+ * @returns Edit distance
+ */
+function levenshtein(a, b) {
+    if (a.length === 0)
+        return b.length;
+    if (b.length === 0)
+        return a.length;
+    const matrix = [];
+    for (let i = 0; i <= b.length; i++) {
+        matrix[i] = [i];
+    }
+    for (let j = 0; j <= a.length; j++) {
+        matrix[0][j] = j;
+    }
+    for (let i = 1; i <= b.length; i++) {
+        for (let j = 1; j <= a.length; j++) {
+            if (b.charAt(i - 1) === a.charAt(j - 1)) {
+                matrix[i][j] = matrix[i - 1][j - 1];
+            }
+            else {
+                matrix[i][j] = Math.min(matrix[i - 1][j - 1] + 1, matrix[i][j - 1] + 1, matrix[i - 1][j] + 1);
+            }
+        }
+    }
+    return matrix[b.length][a.length];
+}
+/**
+ * Print error and exit
+ * @param message - Error message
+ * @param suggestions - Suggestions
+ */
+export function exitWithError(message, suggestions = []) {
+    console.error(formatError(message, suggestions));
+    process.exit(1);
+}
+/**
+ * Validate file exists with helpful error
+ * @param filePath - File to check
+ * @param fileType - Type description for error message
+ */
+export function requireFile(filePath, fileType = 'File') {
+    if (!fs.existsSync(filePath)) {
+        exitWithError(`${fileType} not found: ${filePath}`, getFileNotFoundSuggestions(filePath));
+    }
+}
+//# sourceMappingURL=errors.js.map

package/dist/lib/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../lib/errors.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AAOzB;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAC,OAAe,EAAE,cAAwB,EAAE;IACrE,MAAM,KAAK,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,UAAU,OAAO,EAAE,CAAC,CAAC,CAAC;IAE/C,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;YACrC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,UAAU,EAAE,CAAC,CAAC,CAAC;QAC3C,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,0BAA0B,CAAC,QAAgB;IACzD,MAAM,WAAW,GAAa,EAAE,CAAC;IACjC,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,CAAC;IACjD,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACnC,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAErC,4BAA4B;IAC5B,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QACxB,WAAW,CAAC,IAAI,CAAC,6BAA6B,GAAG,EAAE,CAAC,CAAC;QACrD,WAAW,CAAC,IAAI,CAAC,6BAA6B,GAAG,GAAG,CAAC,CAAC;QACtD,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,yBAAyB;IACzB,IAAI,CAAC;QACH,MAAM,KAAK,GAAG,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QAClC,MAAM,OAAO,GAAG,gBAAgB,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;QAEjD,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvB,WAAW,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;YAClC,KAAK,MAAM,CAAC,IAAI,OAAO,EAAE,CAAC;gBACxB,WAAW,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;YAC7C,CAAC;QACH,CAAC;IACH,CAAC;IAAC,MAAM,CAAC;QACP,yBAAyB;IAC3B,CAAC;IAED,iCAAiC;IACjC,IAAI,GAAG,KAAK,KAAK,IAAI,GAAG,KAAK,EAAE,EAAE,CAAC;QAChC,WAAW,CAAC,IAAI,CAAC,sDAAsD,CAAC,CAAC;IAC3E,CAAC;SAAM,IAAI,GAAG,KAAK,OAAO,EAAE,CAAC;QAC3B,WAAW,CAAC,IAAI,CAAC,kDAAkD,CAAC,CAAC;IACvE,CAAC;SAAM,IAAI,GAAG,KAAK,MAAM,EAAE,CAAC;QAC1B,WAAW,CAAC,IAAI,CAAC,gDAAgD,CAAC,CAAC;QACnE,WAAW,CAAC,IAAI,CAAC,yCAAyC,CAAC,CAAC;IAC9D,CAAC;SAAM,IAAI,GAAG,KAAK,MAAM,EAAE,CAAC;QAC1B,WAAW,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;IACtD,CAAC;IAED,OAAO,WAAW,CAAC;AACrB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,wBAAwB,CAAC,UAAkB;IACzD,MAAM,WAAW,GAAa,EAAE,CAAC;IACjC,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;IAElC,QAAQ,UAAU,CAAC,WAAW,EAAE,EAAE,CAAC;QACjC,KAAK,QAAQ;YACX,WAAW,CAAC,IAAI,CAAC,4CAA4C,CAAC,CAAC;YAC/D,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBAC1B,WAAW,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;YACxD,CAAC;iBAAM,IAAI,QAAQ,KAAK,OAAO,EAAE,CAAC;gBAChC,WAAW,CAAC,IAAI,CAAC,kDAAkD,CAAC,CAAC;gBACrE,WAAW,CAAC,IAAI,CAAC,oDAAoD,CAAC,CAAC;YACzE,CAAC;iBAAM,CAAC;gBACN,WAAW,CAAC,IAAI,CAAC,uCAAuC,CAAC,CAAC;gBAC1D,WAAW,CAAC,IAAI,CAAC,6CAA6C,CAAC,CAAC;YAClE,CAAC;YACD,WAAW,CAAC,IAAI,CAAC,6CAA6C,CAAC,CAAC;YAChE,MAAM;QAER,KAAK,UAAU,CAAC;QAChB,KAAK,SAAS,CAAC;QACf,KAAK,OAAO;YACV,WAAW,CAAC,IAAI,CAAC,sCAAsC,CAAC,CAAC;YACzD,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBAC1B,WAAW,CAAC,IAAI,CAAC,0CAA0C,CAAC,CAAC;gBAC7D,WAAW,CAAC,IAAI,CAAC,0CAA0C,CAAC,CAAC;YAC/D,CAAC;iBAAM,IAAI,QAAQ,KAAK,OAAO,EAAE,CAAC;gBAChC,WAAW,CAAC,IAAI,CAAC,kDAAkD,CAAC,CAAC;gBACrE,WAAW,CAAC,IAAI,CAAC,4CAA4C,CAAC,CAAC;YACjE,CAAC;iBAAM,CAAC;gBACN,WAAW,CAAC,IAAI,CAAC,6CAA6C,CAAC,CAAC;gBAChE,WAAW,CAAC,IAAI,CAAC,iDAAiD,CAAC,CAAC;YACtE,CAAC;YACD,WAAW,CAAC,IAAI,CAAC,mDAAmD,CAAC,CAAC;YACtE,MAAM;QAER,KAAK,iBAAiB;YACpB,WAAW,CAAC,IAAI,CAAC,yDAAyD,CAAC,CAAC;YAC5E,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBAC1B,WAAW,CAAC,IAAI,CAAC,4CAA4C,CAAC,CAAC;YACjE,CAAC;iBAAM,IAAI,QAAQ,KAAK,OAAO,EAAE,CAAC;gBAChC,WAAW,CAAC,IAAI,CAAC,sEAAsE,CAAC,CAAC;YAC3F,CAAC;iBAAM,CAAC;gBACN,WAAW,CAAC,IAAI,CAAC,gDAAgD,CAAC,CAAC;gBACnE,WAAW,CAAC,IAAI,CAAC,gEAAgE,CAAC,CAAC;YACrF,CAAC;YACD,WAAW,CAAC,IAAI,CAAC,6DAA6D,CAAC,CAAC;YAChF,MAAM;IACV,CAAC;IAED,OAAO,WAAW,CAAC;AACrB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB,CAAC,KAAa,EAAE,KAAa;IAC/D,MAAM,WAAW,GAAa,EAAE,CAAC;IAEjC,QAAQ,KAAK,EAAE,CAAC;QACd,KAAK,cAAc;YACjB,WAAW,CAAC,IAAI,CAAC,8CAA8C,CAAC,CAAC;YACjE,WAAW,CAAC,IAAI,CAAC,kCAAkC,CAAC,CAAC;YACrD,WAAW,CAAC,IAAI,CAAC,kCAAkC,CAAC,CAAC;YACrD,MAAM;QAER,KAAK,UAAU;YACb,WAAW,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;YACpD,WAAW,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YAChC,WAAW,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;YAC1C,WAAW,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;YACrC,WAAW,CAAC,IAAI,CAAC,kCAAkC,CAAC,CAAC;YACrD,MAAM;QAER,KAAK,MAAM;YACT,WAAW,CAAC,IAAI,CAAC,wCAAwC,CAAC,CAAC;YAC3D,WAAW,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;YAClD,MAAM;QAER,KAAK,KAAK;YACR,WAAW,CAAC,IAAI,CAAC,oCAAoC,CAAC,CAAC;YACvD,WAAW,CAAC,IAAI,CAAC,qDAAqD,CAAC,CAAC;YACxE,WAAW,CAAC,IAAI,CAAC,uDAAuD,CAAC,CAAC;YAC1E,MAAM;QAER;YACE,WAAW,CAAC,IAAI,CAAC,uBAAuB,KAAK,iBAAiB,CAAC,CAAC;YAChE,WAAW,CAAC,IAAI,CAAC,iDAAiD,CAAC,CAAC;IACxE,CAAC;IAED,IAAI,KAAK,KAAK,MAAM,EAAE,CAAC;QACrB,WAAW,CAAC,OAAO,CAAC,oCAAoC,CAAC,CAAC;IAC5D,CAAC;IAED,OAAO,WAAW,CAAC;AACrB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,wBAAwB,CAAC,KAAa;IACpD,MAAM,WAAW,GAAa,EAAE,CAAC;IAEjC,QAAQ,KAAK,EAAE,CAAC;QACd,KAAK,aAAa;YAChB,WAAW,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;YACtD,WAAW,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;YACjD,WAAW,CAAC,IAAI,CAAC,0CAA0C,CAAC,CAAC;YAC7D,MAAM;QAER,KAAK,YAAY;YACf,WAAW,CAAC,IAAI,CAAC,wCAAwC,CAAC,CAAC;YAC3D,WAAW,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;YAC1C,WAAW,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;YACzC,WAAW,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;YACrC,WAAW,CAAC,IAAI,CAAC,0CAA0C,CAAC,CAAC;YAC7D,MAAM;QAER,KAAK,gBAAgB;YACnB,WAAW,CAAC,IAAI,CAAC,kDAAkD,CAAC,CAAC;YACrE,WAAW,CAAC,IAAI,CAAC,sCAAsC,CAAC,CAAC;YACzD,MAAM;QAER,KAAK,WAAW;YACd,WAAW,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;YAC1C,WAAW,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;YAClD,WAAW,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;YAChD,MAAM;IACV,CAAC;IAED,OAAO,WAAW,CAAC;AACrB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CAAC,KAAa,EAAE,UAAwB,EAAE;IAC3E,MAAM,WAAW,GAAa,EAAE,CAAC;IAEjC,QAAQ,KAAK,EAAE,CAAC;QACd,KAAK,aAAa;YAChB,WAAW,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;YACpD,WAAW,CAAC,IAAI,CAAC,2DAA2D,CAAC,CAAC;YAC9E,WAAW,CAAC,IAAI,CAAC,iDAAiD,CAAC,CAAC;YACpE,MAAM;QAER,KAAK,aAAa;YAChB,WAAW,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;YAChD,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;gBACpB,WAAW,CAAC,IAAI,CAAC,aAAa,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;YACnD,CAAC;YACD,WAAW,CAAC,IAAI,CAAC,0CAA0C,CAAC,CAAC;YAC7D,WAAW,CAAC,IAAI,CAAC,uCAAuC,CAAC,CAAC;YAC1D,MAAM;QAER,KAAK,eAAe;YAClB,WAAW,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;YAC7C,WAAW,CAAC,IAAI,CAAC,0CAA0C,CAAC,CAAC;YAC7D,WAAW,CAAC,IAAI,CAAC,gDAAgD,CAAC,CAAC;YACnE,IAAI,OAAO,CAAC,MAAM,KAAK,KAAK,EAAE,CAAC;gBAC7B,WAAW,CAAC,IAAI,CAAC,wCAAwC,CAAC,CAAC;YAC7D,CAAC;YACD,MAAM;QAER,KAAK,aAAa;YAChB,WAAW,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;YAC7C,WAAW,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;YACnC,WAAW,CAAC,IAAI,CAAC,6CAA6C,CAAC,CAAC;YAChE,WAAW,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAC;YACnD,WAAW,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;YACzC,WAAW,CAAC,IAAI,CAAC,sCAAsC,CAAC,CAAC;YACzD,MAAM;IACV,CAAC;IAED,OAAO,WAAW,CAAC;AACrB,CAAC;AAED;;;;;;GAMG;AACH,SAAS,gBAAgB,CAAC,MAAc,EAAE,UAAoB,EAAE,QAAgB,CAAC;IAC/E,MAAM,MAAM,GAAG,UAAU;SACtB,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,WAAW,CAAC,MAAM,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC,CAAC;SACrF,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,IAAI,CAAC,CAAC,CAAC,0BAA0B;SACvD,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC;IAE3C,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AACjD,CAAC;AAED;;;;;GAKG;AACH,SAAS,WAAW,CAAC,CAAS,EAAE,CAAS;IACvC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,CAAC,CAAC,MAAM,CAAC;IACpC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,CAAC,CAAC,MAAM,CAAC;IAEpC,MAAM,MAAM,GAAe,EAAE,CAAC;IAE9B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACnC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACnC,MAAM,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IACpB,CAAC;IAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACnC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACnC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;gBACxC,MAAM,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAE,CAAC,CAAC,GAAG,CAAC,CAAE,CAAC;YACzC,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CACtB,MAAM,CAAC,CAAC,GAAG,CAAC,CAAE,CAAC,CAAC,GAAG,CAAC,CAAE,GAAG,CAAC,EAC1B,MAAM,CAAC,CAAC,CAAE,CAAC,CAAC,GAAG,CAAC,CAAE,GAAG,CAAC,EACtB,MAAM,CAAC,CAAC,GAAG,CAAC,CAAE,CAAC,CAAC,CAAE,GAAG,CAAC,CACvB,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC,CAAC,CAAC,MAAM,CAAE,CAAC,CAAC,CAAC,MAAM,CAAE,CAAC;AACtC,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,OAAe,EAAE,cAAwB,EAAE;IACvE,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC;IACjD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAC,QAAgB,EAAE,WAAmB,MAAM;IACrE,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC7B,aAAa,CACX,GAAG,QAAQ,eAAe,QAAQ,EAAE,EACpC,0BAA0B,CAAC,QAAQ,CAAC,CACrC,CAAC;IACJ,CAAC;AACH,CAAC"}

package/dist/lib/format.d.ts

@@ -0,0 +1,104 @@
+/**
+ * Formatting utilities for CLI output
+ * Tables, boxes, spinners, progress bars
+ */
+interface TableOptions {
+    align?: Array<'left' | 'right' | 'center'>;
+    headerStyle?: (text: string) => string;
+    borderStyle?: (text: string) => string;
+    cellStyle?: ((value: string, colIndex: number, rowIndex: number) => string) | null;
+}
+interface SimpleTableOptions {
+    headerStyle?: (text: string) => string;
+    indent?: string;
+}
+interface BoxOptions {
+    title?: string | null;
+    padding?: number;
+    borderStyle?: (text: string) => string;
+    titleStyle?: (text: string) => string;
+}
+interface StatsOptions {
+    title?: string | null;
+}
+interface ProgressOptions {
+    width?: number;
+    label?: string;
+}
+interface InlineDiffPreviewOptions {
+    maxLines?: number;
+    contextChars?: number;
+}
+interface HeaderOptions {
+    style?: (text: string) => string;
+    width?: number;
+}
+interface Spinner {
+    text: string;
+    start: () => Spinner;
+    stop: (finalMessage?: string | null) => Spinner;
+    success: (msg?: string) => Spinner;
+    error: (msg?: string) => Spinner;
+}
+interface ProgressBar {
+    update: (n: number) => ProgressBar;
+    increment: () => ProgressBar;
+    done: (message?: string) => ProgressBar;
+}
+/**
+ * Format a table with borders and alignment
+ * @param headers - Column headers
+ * @param rows - Row data
+ * @param options - Formatting options
+ * @returns Formatted table string
+ */
+export declare function table(headers: string[], rows: string[][], options?: TableOptions): string;
+/**
+ * Simple table without borders (compact)
+ */
+export declare function simpleTable(headers: string[], rows: string[][], options?: SimpleTableOptions): string;
+/**
+ * Format a box around content
+ */
+export declare function box(content: string, options?: BoxOptions): string;
+/**
+ * Summary stats in a nice format
+ */
+export declare function stats(data: Record<string, string | number>, options?: StatsOptions): string;
+/**
+ * Progress indicator
+ */
+export declare function progress(current: number, total: number, options?: ProgressOptions): string;
+export declare function setEmoji(enabled: boolean): void;
+/**
+ * Status line with icon
+ */
+export declare function status(type: string, message: string): string;
+/**
+ * Create a pulsing star spinner for async operations
+ */
+export declare function spinner(message: string): Spinner;
+/**
+ * Create a progress bar for batch operations
+ * @param total - Total number of items
+ * @param label - Label for the progress bar
+ * @returns Progress bar controller with update(), increment(), and done()
+ */
+export declare function progressBar(total: number, label?: string): ProgressBar;
+/**
+ * Diff display with inline highlighting
+ */
+export declare function diff(insertions: number, deletions: number, substitutions: number): string;
+/**
+ * Show inline diff preview for CriticMarkup changes
+ * @param text - Text with CriticMarkup annotations
+ * @param options - Display options
+ * @returns Formatted preview string
+ */
+export declare function inlineDiffPreview(text: string, options?: InlineDiffPreviewOptions): string;
+/**
+ * Section header
+ */
+export declare function header(text: string, options?: HeaderOptions): string;
+export {};
+//# sourceMappingURL=format.d.ts.map

package/dist/lib/format.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"format.d.ts","sourceRoot":"","sources":["../../lib/format.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,UAAU,YAAY;IACpB,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAC,CAAC;IAC3C,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;IACvC,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;IACvC,SAAS,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,MAAM,CAAC,GAAG,IAAI,CAAC;CACpF;AAED,UAAU,kBAAkB;IAC1B,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,UAAU,UAAU;IAClB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;IACvC,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;CACvC;AAED,UAAU,YAAY;IACpB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,UAAU,eAAe;IACvB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,UAAU,wBAAwB;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,UAAU,aAAa;IACrB,KAAK,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;IACjC,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,UAAU,OAAO;IACf,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,OAAO,CAAC;IACrB,IAAI,EAAE,CAAC,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,KAAK,OAAO,CAAC;IAChD,OAAO,EAAE,CAAC,GAAG,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC;IACnC,KAAK,EAAE,CAAC,GAAG,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC;CAClC;AAED,UAAU,WAAW;IACnB,MAAM,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,WAAW,CAAC;IACnC,SAAS,EAAE,MAAM,WAAW,CAAC;IAC7B,IAAI,EAAE,CAAC,OAAO,CAAC,EAAE,MAAM,KAAK,WAAW,CAAC;CACzC;AAED;;;;;;GAMG;AACH,wBAAgB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,OAAO,GAAE,YAAiB,GAAG,MAAM,CAkE7F;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,OAAO,GAAE,kBAAuB,GAAG,MAAM,CAiBzG;AAED;;GAEG;AACH,wBAAgB,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,UAAe,GAAG,MAAM,CA4CrE;AAED;;GAEG;AACH,wBAAgB,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,EAAE,OAAO,GAAE,YAAiB,GAAG,MAAM,CAkB/F;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,eAAoB,GAAG,MAAM,CAQ9F;AAKD,wBAAgB,QAAQ,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAE/C;AAED;;GAEG;AACH,wBAAgB,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CA8B5D;AAkBD;;GAEG;AACH,wBAAgB,OAAO,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAwChD;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,GAAE,MAAmB,GAAG,WAAW,CA4BlF;AAED;;GAEG;AACH,wBAAgB,IAAI,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,MAAM,CAczF;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,wBAA6B,GAAG,MAAM,CAoF9F;AAYD;;GAEG;AACH,wBAAgB,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,aAAkB,GAAG,MAAM,CAIxE"}