@vibecheckai/cli 3.1.2 → 3.1.4

package/bin/runners/lib/report-output.js

@@ -0,0 +1,187 @@
+/**
+ * Report Output - Report Generation Display
+ * 
+ * Handles all report command output formatting:
+ * - Report generation progress
+ * - Format selection display
+ * - Output file information
+ * - Report type descriptions
+ */
+
+const path = require('path');
+const {
+  ansi,
+  colors,
+  icons,
+  Spinner,
+  renderSection,
+  formatDuration,
+} = require('./terminal-ui');
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// REPORT-SPECIFIC ICONS
+// ═══════════════════════════════════════════════════════════════════════════════
+
+const reportIcons = {
+  report: '📄',
+  html: '🌐',
+  markdown: '📝',
+  json: '📊',
+  sarif: '🔒',
+  csv: '📈',
+  executive: '👔',
+  technical: '🔧',
+  compliance: '🛡️',
+  trend: '📈',
+  success: '✓',
+  error: '✗',
+};
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// BANNER
+// ═══════════════════════════════════════════════════════════════════════════════
+
+const BANNER = `
+${ansi.rgb(0, 200, 255)}  ██╗   ██╗██╗██████╗ ███████╗ ██████╗██╗  ██╗███████╗ ██████╗██╗  ██╗${ansi.reset}
+${ansi.rgb(30, 180, 255)}  ██║   ██║██║██╔══██╗██╔════╝██╔════╝██║  ██║██╔════╝██╔════╝██║ ██╔╝${ansi.reset}
+${ansi.rgb(60, 160, 255)}  ██║   ██║██║██████╔╝█████╗  ██║     ███████║█████╗  ██║     █████╔╝ ${ansi.reset}
+${ansi.rgb(90, 140, 255)}  ╚██╗ ██╔╝██║██╔══██╗██╔══╝  ██║     ██╔══██║██╔══╝  ██║     ██╔═██╗ ${ansi.reset}
+${ansi.rgb(120, 120, 255)}   ╚████╔╝ ██║██████╔╝███████╗╚██████╗██║  ██║███████╗╚██████╗██║  ██╗${ansi.reset}
+${ansi.rgb(150, 100, 255)}    ╚═══╝  ╚═╝╚═════╝ ╚══════╝ ╚═════╝╚═╝  ╚═╝╚══════╝ ╚═════╝╚═╝  ╚═╝${ansi.reset}
+
+${ansi.dim}  ┌─────────────────────────────────────────────────────────────────────┐${ansi.reset}
+${ansi.dim}  │${ansi.reset}  ${ansi.rgb(255, 255, 255)}${ansi.bold}Report Generator${ansi.reset} ${ansi.dim}•${ansi.reset} ${ansi.rgb(200, 200, 200)}Professional Reports${ansi.reset} ${ansi.dim}•${ansi.reset} ${ansi.rgb(150, 150, 150)}Multiple Formats${ansi.reset}  ${ansi.dim}│${ansi.reset}
+${ansi.dim}  └─────────────────────────────────────────────────────────────────────┘${ansi.reset}
+`;
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// REPORT TYPE DESCRIPTIONS
+// ═══════════════════════════════════════════════════════════════════════════════
+
+function getReportTypeDescription(type) {
+  const descriptions = {
+    executive: 'One-page overview for stakeholders',
+    technical: 'Detailed findings for developers/CTOs',
+    compliance: 'SOC2/HIPAA-ready language for regulated industries',
+    trend: 'Historical score analysis over time',
+  };
+  return descriptions[type] || 'Standard report';
+}
+
+function getFormatIcon(format) {
+  const iconMap = {
+    html: reportIcons.html,
+    md: reportIcons.markdown,
+    markdown: reportIcons.markdown,
+    json: reportIcons.json,
+    sarif: reportIcons.sarif,
+    csv: reportIcons.csv,
+  };
+  return iconMap[format] || reportIcons.report;
+}
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// REPORT GENERATION DISPLAY
+// ═══════════════════════════════════════════════════════════════════════════════
+
+function renderReportInfo(type, format, outputPath) {
+  const lines = [];
+  lines.push(renderSection('REPORT INFO', reportIcons.report));
+  lines.push('');
+  lines.push(`  Type:       ${colors.accent}${type}${ansi.reset} ${ansi.dim}(${getReportTypeDescription(type)})${ansi.reset}`);
+  lines.push(`  Format:     ${getFormatIcon(format)} ${colors.accent}${format.toUpperCase()}${ansi.reset}`);
+  if (outputPath) {
+    lines.push(`  Output:     ${colors.accent}${outputPath}${ansi.reset}`);
+  }
+  return lines.join('\n');
+}
+
+function renderSuccess(outputPath, format) {
+  const lines = [];
+  lines.push('');
+  lines.push(`  ${colors.success}${icons.success}${ansi.reset} ${ansi.bold}Report generated successfully!${ansi.reset}`);
+  lines.push('');
+  lines.push(`  ${ansi.dim}File:${ansi.reset} ${colors.accent}${outputPath}${ansi.reset}`);
+  if (format === 'html') {
+    lines.push(`  ${ansi.dim}Open:${ansi.reset} ${colors.accent}file://${path.resolve(outputPath)}${ansi.reset}`);
+  }
+  return lines.join('\n');
+}
+
+function renderError(error) {
+  const lines = [];
+  lines.push('');
+  lines.push(`  ${colors.error}${icons.error}${ansi.reset} ${ansi.bold}Report generation failed${ansi.reset}`);
+  lines.push(`  ${ansi.dim}${error.message}${ansi.reset}`);
+  return lines.join('\n');
+}
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// HELP TEXT
+// ═══════════════════════════════════════════════════════════════════════════════
+
+function formatHelp() {
+  return `
+  ${ansi.bold}Usage:${ansi.reset} vibecheck report [options]
+
+  ${ansi.bold}Description${ansi.reset}
+    Generate beautiful, professional reports for stakeholders.
+
+  ${ansi.bold}Report Types${ansi.reset}
+    ${colors.accent}executive${ansi.reset}    One-page overview for stakeholders (default)
+    ${colors.accent}technical${ansi.reset}    Detailed findings for developers/CTOs
+    ${colors.accent}compliance${ansi.reset}   SOC2/HIPAA-ready language for regulated industries
+    ${colors.accent}trend${ansi.reset}        Historical score analysis over time
+
+  ${ansi.bold}Output Formats${ansi.reset}
+    ${colors.success}html${ansi.reset}         Beautiful interactive report (default)
+    ${colors.success}md${ansi.reset}           Markdown for documentation/GitHub
+    ${colors.success}json${ansi.reset}         Machine-readable JSON
+    ${colors.success}sarif${ansi.reset}        SARIF for security tool integration
+    ${colors.success}csv${ansi.reset}         CSV for spreadsheet analysis
+
+  ${ansi.bold}Options${ansi.reset}
+    ${colors.accent}--type, -t <type>${ansi.reset}       Report type: executive, technical, compliance, trend
+    ${colors.accent}--format, -f <format>${ansi.reset}   Output format: html, md, json, sarif, csv
+    ${colors.accent}--output, -o <path>${ansi.reset}     Output file path
+    ${colors.accent}--theme <dark|light>${ansi.reset}    HTML theme (default: dark)
+    ${colors.accent}--company <name>${ansi.reset}        Company name for branding
+    ${colors.accent}--logo <path>${ansi.reset}           Custom logo path/URL
+    ${colors.accent}--include-trends${ansi.reset}        Include historical trend data
+    ${colors.accent}--redact-paths${ansi.reset}          Hide file paths for client reports
+    ${colors.accent}--max-findings <n>${ansi.reset}      Max findings to show (default: 50)
+    ${colors.accent}--path, -p <dir>${ansi.reset}        Project path (default: current directory)
+    ${colors.accent}--help, -h${ansi.reset}              Show this help
+
+  ${ansi.bold}Examples${ansi.reset}
+    ${ansi.dim}# Interactive HTML${ansi.reset}
+    vibecheck report
+
+    ${ansi.dim}# Markdown file${ansi.reset}
+    vibecheck report --format=md --output=REPORT.md
+
+    ${ansi.dim}# Compliance report${ansi.reset}
+    vibecheck report --type=compliance --company=Acme
+
+    ${ansi.dim}# Security tooling${ansi.reset}
+    vibecheck report --format=sarif -o report.sarif
+
+    ${ansi.dim}# Client-safe HTML${ansi.reset}
+    vibecheck report --theme=light --redact
+`;
+}
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// EXPORTS
+// ═══════════════════════════════════════════════════════════════════════════════
+
+module.exports = {
+  BANNER,
+  formatHelp,
+  renderReportInfo,
+  renderSuccess,
+  renderError,
+  getReportTypeDescription,
+  getFormatIcon,
+  reportIcons,
+};