vibecheck-ai 2.0.1 → 5.0.0

package/bin/runners/lib/report.js

@@ -0,0 +1,135 @@
+/**
+ * Unified Report Module
+ * 
+ * This is the SINGLE entry point for all report generation.
+ * Internal modules:
+ * - report-engine.js  → data assembly + export formats
+ * - html-report.js    → HTML generation (primary)
+ * - report-html.js    → Alternative HTML styles (deprecated)
+ * - report-templates.js → Template components (internal)
+ */
+
+const path = require("path");
+const fs = require("fs");
+
+// Primary modules
+const { generateHTMLReport, writeHTMLReport } = require("./html-report");
+const { buildReportData, exportToSARIF, exportToCSV, exportToMarkdown, exportToJSON } = require("./report-engine");
+
+/**
+ * Generate a report from ship results
+ * @param {Object} options
+ * @param {string} options.repoRoot - Repository root path
+ * @param {Object} options.shipReport - Ship report data (optional, loads from disk if not provided)
+ * @param {string} options.format - Output format: html (default), json, sarif, csv, markdown
+ * @param {string} options.outputPath - Custom output path (optional)
+ * @returns {Object} { path, format, data }
+ */
+async function generateReport(options = {}) {
+  const {
+    repoRoot = process.cwd(),
+    shipReport = null,
+    format = "html",
+    outputPath = null,
+  } = options;
+
+  // Load ship report if not provided
+  let report = shipReport;
+  if (!report) {
+    const shipPath = path.join(repoRoot, ".vibecheck", "ship", "last_ship.json");
+    if (fs.existsSync(shipPath)) {
+      report = JSON.parse(fs.readFileSync(shipPath, "utf-8"));
+    } else {
+      throw new Error("No ship report found. Run 'vibecheck ship' first.");
+    }
+  }
+
+  // Build report data
+  const reportData = buildReportData(report);
+
+  // Generate output based on format
+  let outputFile;
+  let outputData;
+
+  switch (format.toLowerCase()) {
+    case "html":
+      outputData = generateHTMLReport(reportData);
+      outputFile = outputPath || path.join(repoRoot, ".vibecheck", "reports", "report.html");
+      break;
+    case "json":
+      outputData = exportToJSON(reportData);
+      outputFile = outputPath || path.join(repoRoot, ".vibecheck", "reports", "report.json");
+      break;
+    case "sarif":
+      outputData = exportToSARIF(reportData);
+      outputFile = outputPath || path.join(repoRoot, ".vibecheck", "reports", "report.sarif");
+      break;
+    case "csv":
+      outputData = exportToCSV(reportData);
+      outputFile = outputPath || path.join(repoRoot, ".vibecheck", "reports", "report.csv");
+      break;
+    case "markdown":
+    case "md":
+      outputData = exportToMarkdown(reportData);
+      outputFile = outputPath || path.join(repoRoot, ".vibecheck", "reports", "report.md");
+      break;
+    default:
+      throw new Error(`Unknown format: ${format}. Use: html, json, sarif, csv, markdown`);
+  }
+
+  // Ensure output directory exists
+  const outputDir = path.dirname(outputFile);
+  if (!fs.existsSync(outputDir)) {
+    fs.mkdirSync(outputDir, { recursive: true });
+  }
+
+  // Write output
+  fs.writeFileSync(outputFile, outputData, "utf-8");
+
+  return {
+    path: outputFile,
+    format,
+    data: reportData,
+  };
+}
+
+/**
+ * Open the latest report in browser
+ */
+async function openReport(repoRoot = process.cwd()) {
+  const reportPath = path.join(repoRoot, ".vibecheck", "ship", "last_ship.html");
+  const altPath = path.join(repoRoot, ".vibecheck", "reports", "report.html");
+  
+  const filePath = fs.existsSync(reportPath) ? reportPath : 
+                   fs.existsSync(altPath) ? altPath : null;
+
+  if (!filePath) {
+    throw new Error("No report found. Run 'vibecheck ship' or 'vibecheck report' first.");
+  }
+
+  // Cross-platform open
+  const { exec } = require("child_process");
+  const cmd = process.platform === "win32" ? `start "" "${filePath}"` :
+              process.platform === "darwin" ? `open "${filePath}"` :
+              `xdg-open "${filePath}"`;
+
+  return new Promise((resolve, reject) => {
+    exec(cmd, (err) => {
+      if (err) reject(err);
+      else resolve(filePath);
+    });
+  });
+}
+
+module.exports = {
+  generateReport,
+  openReport,
+  // Re-export for backward compatibility
+  generateHTMLReport,
+  writeHTMLReport,
+  buildReportData,
+  exportToSARIF,
+  exportToCSV,
+  exportToMarkdown,
+  exportToJSON,
+};