@vibecheckai/cli 2.8.2 → 3.0.0

package/bin/runners/runReport.js

@@ -0,0 +1,478 @@
+/**
+ * vibecheck report - World-Class Professional Reports
+ * 
+ * Enterprise-grade report generation with:
+ * - Beautiful interactive HTML with modern design
+ * - Multiple export formats (HTML, MD, JSON, SARIF, CSV)
+ * - Executive, Technical, Compliance report types
+ * - Historical trends and fix time estimates
+ * - Print-optimized layouts
+ */
+
+const path = require("path");
+const fs = require("fs");
+
+// Report engine modules
+let reportEngine, reportHtml;
+try {
+  reportEngine = require("./lib/report-engine");
+  reportHtml = require("./lib/report-html");
+} catch (e) {
+  // Fallback to basic templates if enhanced modules unavailable
+  reportEngine = null;
+  reportHtml = null;
+}
+
+// ANSI color codes
+const c = {
+  reset: "\x1b[0m",
+  bold: "\x1b[1m",
+  dim: "\x1b[2m",
+  red: "\x1b[31m",
+  green: "\x1b[32m",
+  yellow: "\x1b[33m",
+  blue: "\x1b[34m",
+  magenta: "\x1b[35m",
+  cyan: "\x1b[36m",
+};
+
+function parseArgs(args) {
+  const opts = {
+    type: "executive",
+    format: "html",
+    path: ".",
+    output: null,
+    logo: null,
+    company: null,
+    theme: "dark",
+    includeVerify: false,
+    includeTrends: false,
+    redactPaths: false,
+    maxFindings: 50,
+    help: false,
+  };
+
+  for (let i = 0; i < args.length; i++) {
+    const a = args[i];
+    if (a === "--type" || a === "-t") opts.type = args[++i];
+    if (a === "--format" || a === "-f") opts.format = args[++i];
+    if (a === "--output" || a === "-o") opts.output = args[++i];
+    if (a === "--logo") opts.logo = args[++i];
+    if (a === "--company") opts.company = args[++i];
+    if (a === "--theme") opts.theme = args[++i];
+    if (a === "--light") opts.theme = "light";
+    if (a === "--dark") opts.theme = "dark";
+    if (a === "--include-verify") opts.includeVerify = true;
+    if (a === "--include-trends" || a === "--trends") opts.includeTrends = true;
+    if (a === "--redact-paths" || a === "--redact") opts.redactPaths = true;
+    if (a === "--max-findings") opts.maxFindings = parseInt(args[++i]) || 50;
+    if (a.startsWith("--path=")) opts.path = a.split("=")[1];
+    if (a === "--path" || a === "-p") opts.path = args[++i];
+    if (a === "--help" || a === "-h") opts.help = true;
+  }
+
+  return opts;
+}
+
+function printHelp() {
+  console.log(`
+${c.bold}${c.cyan}vibecheck report${c.reset} — World-Class Professional Reports
+
+${c.dim}Generate beautiful, professional reports for stakeholders.${c.reset}
+
+${c.bold}USAGE${c.reset}
+  vibecheck report                          Generate executive HTML report
+  vibecheck report --format=md              Generate Markdown report
+  vibecheck report --format=sarif           Generate SARIF for security tools
+  vibecheck report --type=compliance        Generate compliance report
+
+${c.bold}REPORT TYPES${c.reset}
+  ${c.cyan}executive${c.reset}    One-page overview for stakeholders (default)
+  ${c.cyan}technical${c.reset}    Detailed findings for developers/CTOs
+  ${c.cyan}compliance${c.reset}   SOC2/HIPAA-ready language for regulated industries
+  ${c.cyan}trend${c.reset}        Historical score analysis over time
+
+${c.bold}OUTPUT FORMATS${c.reset}
+  ${c.green}html${c.reset}         Beautiful interactive report (default)
+  ${c.green}md${c.reset}           Markdown for documentation/GitHub
+  ${c.green}json${c.reset}         Machine-readable JSON
+  ${c.green}sarif${c.reset}        SARIF for security tool integration
+  ${c.green}csv${c.reset}          CSV for spreadsheet analysis
+
+${c.bold}OPTIONS${c.reset}
+  --type, -t <type>       Report type: executive, technical, compliance, trend
+  --format, -f <format>   Output format: html, md, json, sarif, csv
+  --output, -o <path>     Output file path
+  --theme <dark|light>    HTML theme (default: dark)
+  --company <name>        Company name for branding
+  --logo <path>           Custom logo path/URL
+  --include-trends        Include historical trend data
+  --redact-paths          Hide file paths for client reports
+  --max-findings <n>      Max findings to show (default: 50)
+  --path, -p <dir>        Project path (default: current directory)
+  --help, -h              Show this help
+
+${c.bold}EXAMPLES${c.reset}
+  vibecheck report                                    # Interactive HTML
+  vibecheck report --format=md --output=REPORT.md    # Markdown file
+  vibecheck report --type=compliance --company=Acme  # Compliance report
+  vibecheck report --format=sarif -o report.sarif    # Security tooling
+  vibecheck report --theme=light --redact            # Client-safe HTML
+  vibecheck report --trends                          # Include history
+
+${c.bold}OUTPUT${c.reset}
+  HTML reports include:
+  • Animated score visualization
+  • Interactive severity charts
+  • Category breakdown bars
+  • Fix time estimates
+  • Dark/light mode toggle
+  • Print-optimized layout
+`);
+}
+
+async function runReport(args) {
+  const opts = parseArgs(args);
+
+  if (opts.help) {
+    printHelp();
+    return 0;
+  }
+
+  const projectPath = path.resolve(opts.path);
+  const outputDir = path.join(projectPath, ".vibecheck");
+  const projectName = path.basename(projectPath);
+
+  console.log(`\n${c.bold}${c.cyan}📄 Generating ${opts.type} report...${c.reset}\n`);
+
+  // Load ship results from multiple possible sources
+  let shipResults = loadShipResults(projectPath, outputDir);
+
+  if (!shipResults) {
+    console.log(`${c.yellow}⚠${c.reset} No scan results found. Using demo data for preview.\n`);
+    console.log(`${c.dim}  Tip: Run 'vibecheck ship' first for real results.${c.reset}\n`);
+    shipResults = getDemoData();
+  }
+
+  // Build comprehensive report data using the new engine
+  let reportData;
+  if (reportEngine) {
+    reportData = reportEngine.buildReportData(shipResults, {
+      projectName,
+      repoRoot: projectPath,
+      includeTrends: opts.includeTrends,
+    });
+  } else {
+    // Fallback to basic report data
+    reportData = buildBasicReportData(shipResults, projectName);
+  }
+
+  // Generate report content based on format
+  let reportContent = "";
+  let fileExtension = opts.format;
+
+  switch (opts.format) {
+    case "html":
+      reportContent = generateHTMLReport(reportData, opts);
+      break;
+    case "md":
+    case "markdown":
+      reportContent = generateMarkdownReport(reportData, opts);
+      fileExtension = "md";
+      break;
+    case "json":
+      reportContent = generateJSONReport(reportData, opts);
+      break;
+    case "sarif":
+      reportContent = generateSARIFReport(reportData, opts);
+      break;
+    case "csv":
+      reportContent = generateCSVReport(reportData, opts);
+      break;
+    default:
+      console.error(`${c.red}✗${c.reset} Unknown format: ${opts.format}`);
+      console.log(`${c.dim}  Supported: html, md, json, sarif, csv${c.reset}`);
+      return 1;
+  }
+
+  // Determine output path
+  const outputFileName = opts.output || path.join(outputDir, `report.${fileExtension}`);
+
+  // Ensure output directory exists
+  const outputDirPath = path.dirname(outputFileName);
+  if (!fs.existsSync(outputDirPath)) {
+    fs.mkdirSync(outputDirPath, { recursive: true });
+  }
+
+  // Write report
+  fs.writeFileSync(outputFileName, reportContent);
+
+  // Save report history for trend analysis
+  saveReportHistory(outputDir, reportData);
+
+  // Print success message
+  console.log(`${c.green}✓${c.reset} Report generated successfully!\n`);
+  printReportSummary(reportData, opts, outputFileName);
+
+  return 0;
+}
+
+// ============================================================================
+// DATA LOADING
+// ============================================================================
+
+function loadShipResults(projectPath, outputDir) {
+  // Try multiple sources for ship results
+  const sources = [
+    path.join(outputDir, "ship_report.json"),
+    path.join(outputDir, "report.json"),
+    path.join(outputDir, "truth", "truthpack.json"),
+  ];
+
+  for (const src of sources) {
+    if (fs.existsSync(src)) {
+      try {
+        return JSON.parse(fs.readFileSync(src, "utf8"));
+      } catch {
+        continue;
+      }
+    }
+  }
+
+  return null;
+}
+
+function getDemoData() {
+  return {
+    score: 72,
+    verdict: "WARN",
+    findings: [
+      { id: "SEC001", severity: "BLOCK", type: "secret", message: "API key exposed in source code", file: "src/config.ts", line: 42, fix: "Move to environment variable" },
+      { id: "AUTH001", severity: "BLOCK", type: "auth", message: "Authentication bypass in admin route", file: "src/routes/admin.ts", line: 15, fix: "Add auth middleware" },
+      { id: "MOCK001", severity: "WARN", type: "mock", message: "Mock data used in production path", file: "src/api/users.ts", line: 88, fix: "Remove mock data fallback" },
+      { id: "ERR001", severity: "WARN", type: "error", message: "Empty catch block in payment flow", file: "src/billing/checkout.ts", line: 156, fix: "Add error handling" },
+      { id: "CFG001", severity: "INFO", type: "config", message: "Hardcoded timeout value", file: "src/utils/http.ts", line: 23, fix: "Move to config" },
+      { id: "DBG001", severity: "INFO", type: "quality", message: "Console.log statement", file: "src/debug.ts", line: 5, fix: "Remove or use logger" },
+    ],
+    truthpack: {
+      routes: { server: Array(12).fill({}) },
+      env: { vars: Array(8).fill("") },
+      auth: { nextMiddleware: [{}] },
+      billing: { webhooks: [{}] },
+    },
+  };
+}
+
+function buildBasicReportData(shipResults, projectName) {
+  const findings = shipResults?.findings || [];
+  return {
+    meta: {
+      projectName,
+      generatedAt: new Date().toISOString(),
+      version: "2.0.0",
+      reportId: `VC-${Date.now().toString(36).toUpperCase()}`,
+    },
+    summary: {
+      score: shipResults?.score || 0,
+      verdict: shipResults?.verdict || (shipResults?.canShip ? "SHIP" : "WARN"),
+      totalFindings: findings.length,
+      severityCounts: {
+        critical: findings.filter(f => f.severity === "BLOCK" || f.severity === "critical").length,
+        high: findings.filter(f => f.severity === "high").length,
+        medium: findings.filter(f => f.severity === "WARN" || f.severity === "medium").length,
+        low: findings.filter(f => f.severity === "low" || f.severity === "INFO").length,
+      },
+      categoryScores: shipResults?.categoryScores || { security: 80, auth: 70, billing: 90, quality: 60 },
+    },
+    findings: findings.map((f, i) => ({ ...f, id: f.id || `F${String(i+1).padStart(3,"0")}` })),
+    fixEstimates: { humanReadable: "~2h", totalMinutes: 120, bySeverity: {} },
+    truthpack: { routes: 0, envVars: 0, hasAuth: false, hasBilling: false },
+  };
+}
+
+// ============================================================================
+// REPORT GENERATORS
+// ============================================================================
+
+function generateHTMLReport(reportData, opts) {
+  // Use world-class HTML generator if available
+  if (reportHtml && reportHtml.generateWorldClassHTML) {
+    return reportHtml.generateWorldClassHTML(reportData, opts);
+  }
+  
+  // Fallback to enhanced templates
+  try {
+    const templates = require("./lib/report-templates");
+    switch (opts.type) {
+      case "technical":
+        return templates.generateEnhancedTechnicalReport(convertToLegacyFormat(reportData), opts);
+      case "compliance":
+        return templates.generateEnhancedComplianceReport(convertToLegacyFormat(reportData), opts);
+      default:
+        return templates.generateEnhancedExecutiveReport(convertToLegacyFormat(reportData), opts);
+    }
+  } catch {
+    return generateBasicHTML(reportData, opts);
+  }
+}
+
+function generateMarkdownReport(reportData, opts) {
+  if (reportEngine && reportEngine.exportToMarkdown) {
+    return reportEngine.exportToMarkdown(reportData, opts);
+  }
+  return generateBasicMarkdown(reportData, opts);
+}
+
+function generateJSONReport(reportData, opts) {
+  if (reportEngine && reportEngine.exportToJSON) {
+    return reportEngine.exportToJSON(reportData);
+  }
+  return JSON.stringify(reportData, null, 2);
+}
+
+function generateSARIFReport(reportData, opts) {
+  if (reportEngine && reportEngine.exportToSARIF) {
+    return JSON.stringify(reportEngine.exportToSARIF(reportData), null, 2);
+  }
+  // Basic SARIF fallback
+  return JSON.stringify({
+    $schema: "https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json",
+    version: "2.1.0",
+    runs: [{
+      tool: { driver: { name: "vibecheck", version: "2.0.0" } },
+      results: reportData.findings.map(f => ({
+        ruleId: f.id,
+        level: f.severity === "critical" ? "error" : "warning",
+        message: { text: f.title || f.message },
+      })),
+    }],
+  }, null, 2);
+}
+
+function generateCSVReport(reportData, opts) {
+  if (reportEngine && reportEngine.exportToCSV) {
+    return reportEngine.exportToCSV(reportData);
+  }
+  // Basic CSV fallback
+  const headers = ["ID", "Severity", "Title", "File", "Line"];
+  const rows = reportData.findings.map(f => [
+    f.id || "",
+    f.severity || "",
+    `"${(f.title || f.message || "").replace(/"/g, '""')}"`,
+    f.file || "",
+    f.line || "",
+  ]);
+  return [headers.join(","), ...rows.map(r => r.join(","))].join("\n");
+}
+
+function convertToLegacyFormat(reportData) {
+  return {
+    projectName: reportData.meta.projectName,
+    generatedAt: reportData.meta.generatedAt,
+    score: reportData.summary.score,
+    verdict: reportData.summary.verdict,
+    findings: reportData.findings,
+    categoryScores: reportData.summary.categoryScores,
+  };
+}
+
+// ============================================================================
+// FALLBACK GENERATORS
+// ============================================================================
+
+function generateBasicHTML(reportData, opts) {
+  const { meta, summary } = reportData;
+  const verdictColor = summary.verdict === "SHIP" ? "#22c55e" : summary.verdict === "WARN" ? "#f59e0b" : "#ef4444";
+  
+  return `<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>Vibecheck Report - ${meta.projectName}</title>
+  <style>
+    body { font-family: -apple-system, sans-serif; max-width: 800px; margin: 0 auto; padding: 40px; background: #0f172a; color: #f8fafc; }
+    .header { border-bottom: 2px solid #334155; padding-bottom: 20px; margin-bottom: 30px; }
+    .score { font-size: 4rem; font-weight: 800; text-align: center; margin: 40px 0; }
+    .verdict { display: inline-block; padding: 12px 24px; border-radius: 50px; font-weight: 600; background: ${verdictColor}22; color: ${verdictColor}; }
+    .section { margin: 30px 0; }
+    h2 { color: #94a3b8; font-size: 0.875rem; text-transform: uppercase; letter-spacing: 0.1em; }
+    .finding { background: #1e293b; padding: 16px; border-radius: 8px; margin: 12px 0; border-left: 4px solid #3b82f6; }
+    .footer { margin-top: 60px; text-align: center; color: #64748b; }
+  </style>
+</head>
+<body>
+  <div class="header">
+    <h1>Ship Readiness Report</h1>
+    <p>Project: ${meta.projectName} · ${new Date(meta.generatedAt).toLocaleString()}</p>
+  </div>
+  <div class="score">${summary.score}</div>
+  <div style="text-align: center;"><span class="verdict">${summary.verdict}</span></div>
+  <div class="section">
+    <h2>Findings (${summary.totalFindings})</h2>
+    ${reportData.findings.slice(0, 10).map(f => `
+      <div class="finding">
+        <strong>${f.severity?.toUpperCase()}</strong>: ${f.title || f.message}
+        ${f.file ? `<br><code>${f.file}${f.line ? `:${f.line}` : ""}</code>` : ""}
+      </div>
+    `).join("")}
+  </div>
+  <div class="footer">Generated by Vibecheck · ${meta.reportId}</div>
+</body>
+</html>`;
+}
+
+function generateBasicMarkdown(reportData, opts) {
+  const { meta, summary, findings } = reportData;
+  return `# Vibecheck Report
+
+**Project:** ${meta.projectName}  
+**Generated:** ${new Date(meta.generatedAt).toLocaleString()}  
+**Score:** ${summary.score}/100  
+**Verdict:** ${summary.verdict}
+
+## Findings (${summary.totalFindings})
+
+${findings.slice(0, 20).map(f => `- **${f.severity?.toUpperCase()}**: ${f.title || f.message}${f.file ? ` (\`${f.file}\`)` : ""}`).join("\n")}
+
+---
+*Generated by Vibecheck · ${meta.reportId}*
+`;
+}
+
+// ============================================================================
+// UTILITIES
+// ============================================================================
+
+function saveReportHistory(outputDir, reportData) {
+  try {
+    const historyDir = path.join(outputDir, "history");
+    if (!fs.existsSync(historyDir)) {
+      fs.mkdirSync(historyDir, { recursive: true });
+    }
+    
+    const timestamp = new Date().toISOString().split("T")[0];
+    const historyFile = path.join(historyDir, `${timestamp}.json`);
+    
+    fs.writeFileSync(historyFile, JSON.stringify({
+      meta: reportData.meta,
+      summary: reportData.summary,
+    }, null, 2));
+  } catch {
+    // Silently fail history saving
+  }
+}
+
+function printReportSummary(reportData, opts, outputFile) {
+  const { summary } = reportData;
+  const verdictColor = summary.verdict === "SHIP" ? c.green : summary.verdict === "WARN" ? c.yellow : c.red;
+  
+  console.log(`  ${c.dim}Type:${c.reset}     ${c.bold}${opts.type}${c.reset}`);
+  console.log(`  ${c.dim}Format:${c.reset}   ${c.bold}${opts.format}${c.reset}`);
+  console.log(`  ${c.dim}Score:${c.reset}    ${verdictColor}${c.bold}${summary.score}${c.reset}/100`);
+  console.log(`  ${c.dim}Verdict:${c.reset}  ${verdictColor}${c.bold}${summary.verdict}${c.reset}`);
+  console.log(`  ${c.dim}Findings:${c.reset} ${summary.totalFindings}`);
+  console.log(`\n  ${c.dim}Output:${c.reset}   ${c.cyan}${outputFile}${c.reset}\n`);
+}
+
+module.exports = { runReport };