Function renderReport

skills/vercel-optimize/lib/render-report.mjs:15–188

({ recommendations = [], gated = [], abstentions = [], observations = [], signals = {}, candidates = [], opts = {} } = {})

const GATED_TARGET_PREVIEW = 5;

export function renderReport({ recommendations = [], gated = [], abstentions = [], observations = [], signals = {}, candidates = [], opts = {} } = {}) {
  const safety = splitCustomerSafeObservations(observations, abstentions, signals);
  observations = safety.observations;
  abstentions = [...abstentions, ...safety.heldBackObservations];
  assertValidObservations(observations);

  const projectName = opts.projectName ?? signals.project?.name ?? '<project>';
  const stack = signals.stack ?? signals.codebase?.stack ?? {};
  const usage = signals.usage ?? null;
  const plan = signals.plan ?? { plan: 'unknown', reason: '(not detected)' };

  // Sub-agents don't always propagate o11ySignal/aliasRoutes — look them up by candidateRef and canonicalize the displayed ref.
  recommendations = recommendations.map((r) => enrichRecFromCandidates(r, candidates));
  const { needsEvidenceRows, noChangeRows } = splitInvestigationOutcomes(abstentions);

  const lines = [];
  lines.push(`# Vercel Optimization Report — ${projectName}`);
  lines.push('');
  lines.push(renderMetadataLine(stack, plan, usage, signals));
  const coverageLine = renderCoverageLine(candidates, recommendations, signals, {
    abstentions,
    heldBackCount: opts.heldBackCount,
    noChangeCount: opts.noChangeCount,
  });
  if (coverageLine) lines.push(coverageLine);
  if (opts.generatedAt) {
    lines.push('');
    lines.push(`_Generated ${opts.generatedAt}_`);
  }
  lines.push('');

  lines.push(...renderCostHeader(signals));
  lines.push('');
  lines.push(...renderCostBreakdown(usage, signals));
  if (usage) {
    const coverage = computeCostCoverage(usage, registeredGates);
    lines.push(...renderCostCoverageMarkdown(coverage));
  }
  lines.push('');

  const platformRecs = recommendations.filter(isPlatformScope).slice(0, PLATFORM_CAP);
  const codeRecs = recommendations.filter((r) => !isPlatformScope(r));
  const sorted = sortRecs(codeRecs);
  const high = sorted.filter((r) => r.impactTier === 'high');
  const medium = sorted.filter((r) => r.impactTier === 'medium');
  const low = sorted.filter((r) => r.impactTier === 'low' || !r.impactTier);
  lines.push('## Highest-impact recommendations');
  lines.push('');
  if (sorted.length === 0) {
    lines.push('_No recommendations are ready to apply from this run._');
  } else {
    const top = sorted.slice(0, 5);
    top.forEach((rec, i) => {
      const candidate = candidateForDisplay(rec);
      const signal = formatSignal(rec.o11ySignal ?? signalFromRec(rec) ?? '', candidate);
      lines.push(`${i + 1}. **${formatCandidateLabel(candidate)}** — ${signal}`);
      lines.push(`   - **What to do**: ${formatRecommendationText(rec.what ?? '')}`);
      lines.push(`   - **Impact**: ${formatRecommendationText(impactString(rec, signals))}`);