@doccov/cli 0.30.0 → 0.30.2

package/dist/cli.js

@@ -1068,8 +1068,12 @@ function bar2(pct, width = 10) {
 }
 function renderMarkdown(stats, options = {}) {
   const limit = options.limit ?? 20;
+  const { reportUrl } = options;
   const lines = [];
   lines.push(`# DocCov Report: ${stats.packageName}@${stats.version}`);
+  if (reportUrl) {
+    lines.push(`[View full report →](${reportUrl})`);
+  }
   lines.push("");
   if (stats.health) {
     const h = stats.health;
@@ -1111,19 +1115,42 @@ function renderMarkdown(stats, options = {}) {
       lines.push(`| ${k.kind} | ${k.count} | ${k.avgScore}% |`);
     }
   }
-  const lowExports = stats.exports.filter((e) => e.score < 100).slice(0, limit);
-  if (lowExports.length > 0) {
+  const undocExports = stats.exports.filter((e) => e.score === 0);
+  if (undocExports.length > 0) {
+    lines.push("");
+    lines.push("## Undocumented Exports");
     lines.push("");
-    lines.push("## Lowest Coverage Exports");
+    lines.push("| Export | Kind | Missing |");
+    lines.push("|--------|------|---------|");
+    for (const e of undocExports.slice(0, limit)) {
+      lines.push(`| \`${e.name}\` | ${e.kind} | ${e.missing.join(", ") || "-"} |`);
+    }
+    if (undocExports.length > limit) {
+      const moreText = `${undocExports.length - limit} more`;
+      if (reportUrl) {
+        lines.push(`| [${moreText} →](${reportUrl}#undocumented) | | |`);
+      } else {
+        lines.push(`| ... | | ${moreText} |`);
+      }
+    }
+  }
+  const partialExports = stats.exports.filter((e) => e.score > 0 && e.score < 100);
+  if (partialExports.length > 0) {
+    lines.push("");
+    lines.push("## Partial Coverage Exports");
     lines.push("");
     lines.push("| Export | Kind | Score | Missing |");
     lines.push("|--------|------|-------|---------|");
-    for (const e of lowExports) {
+    for (const e of partialExports.slice(0, limit)) {
       lines.push(`| \`${e.name}\` | ${e.kind} | ${e.score}% | ${e.missing.join(", ") || "-"} |`);
     }
-    const totalLow = stats.exports.filter((e) => e.score < 100).length;
-    if (totalLow > limit) {
-      lines.push(`| ... | | | ${totalLow - limit} more |`);
+    if (partialExports.length > limit) {
+      const moreText = `${partialExports.length - limit} more`;
+      if (reportUrl) {
+        lines.push(`| [${moreText} →](${reportUrl}#partial) | | | |`);
+      } else {
+        lines.push(`| ... | | | ${moreText} |`);
+      }
     }
   }
   if (stats.driftIssues.length > 0) {
@@ -1158,7 +1185,12 @@ function renderMarkdown(stats, options = {}) {
         lines.push(`| \`${d.exportName}\` | ${d.issue}${hint} |`);
       }
       if (issues.length > 10) {
-        lines.push(`| ... | ${issues.length - 10} more ${category} issues |`);
+        const moreText = `${issues.length - 10} more ${category} issues`;
+        if (reportUrl) {
+          lines.push(`| [${moreText} →](${reportUrl}#drift-${category}) | |`);
+        } else {
+          lines.push(`| ... | ${moreText} |`);
+        }
       }
       lines.push("");
     }
@@ -1178,7 +1210,32 @@ function renderMarkdown(stats, options = {}) {
       lines.push(`| \`${f.name}\` | ${definedIn} | ${refs}${moreRefs} |`);
     }
     if (stats.apiSurface.forgotten.length > limit) {
-      lines.push(`| ... | | ${stats.apiSurface.forgotten.length - limit} more |`);
+      const moreText = `${stats.apiSurface.forgotten.length - limit} more`;
+      if (reportUrl) {
+        lines.push(`| [${moreText} →](${reportUrl}#api-surface) | | |`);
+      } else {
+        lines.push(`| ... | | ${moreText} |`);
+      }
+    }
+  }
+  if (stats.staleRefs && stats.staleRefs.length > 0) {
+    lines.push("");
+    lines.push("## Stale References");
+    lines.push("");
+    lines.push(`**${stats.staleRefs.length} stale reference(s)** found in documentation`);
+    lines.push("");
+    lines.push("| File | Line | Export |");
+    lines.push("|------|------|--------|");
+    for (const ref of stats.staleRefs.slice(0, limit)) {
+      lines.push(`| ${ref.file} | ${ref.line} | \`${ref.exportName}\` |`);
+    }
+    if (stats.staleRefs.length > limit) {
+      const moreText = `${stats.staleRefs.length - limit} more`;
+      if (reportUrl) {
+        lines.push(`| [${moreText} →](${reportUrl}#stale-refs) | | |`);
+      } else {
+        lines.push(`| ... | | ${moreText} |`);
+      }
     }
   }
   lines.push("");
@@ -1192,7 +1249,7 @@ import { getExportAnalysis, getExportDrift as getExportDrift2, isFixableDrift }
 import {
   DRIFT_CATEGORIES as DRIFT_CATEGORIES2
 } from "@doccov/spec";
-function computeStats(openpkg, doccov) {
+function computeStats(openpkg, doccov, options = {}) {
   const exports = openpkg.exports ?? [];
   const signals = {
     description: { covered: 0, total: 0 },
@@ -1287,13 +1344,14 @@ function computeStats(openpkg, doccov) {
     driftByCategory,
     driftSummary,
     apiSurface: doccov.apiSurface,
-    health: doccov.summary.health
+    health: doccov.summary.health,
+    staleRefs: options.staleRefs
   };
 }
 // src/reports/writer.ts
 import * as fs3 from "node:fs";
 import * as path5 from "node:path";
-import { DEFAULT_REPORT_DIR, getDoccovDir, getReportPath } from "@doccov/sdk";
+import { DEFAULT_REPORT_DIR, findProjectRoot, getDoccovDir, getReportPath } from "@doccov/sdk";
 import chalk5 from "chalk";
 function writeReport(options) {
   const { format, content, outputPath, cwd = process.cwd(), silent = false } = options;
@@ -1304,7 +1362,8 @@ function writeReport(options) {
     fs3.mkdirSync(dir, { recursive: true });
   }
   fs3.writeFileSync(reportPath, content);
-  const relativePath = path5.relative(cwd, reportPath);
+  const projectRoot = findProjectRoot(cwd);
+  const relativePath = path5.relative(projectRoot, reportPath);
   if (!silent) {
     console.log(chalk5.green(`✓ Wrote ${format} report to ${relativePath}`));
   }
@@ -1563,15 +1622,17 @@ function handleNonTextOutput(options, deps) {
     minApiSurface,
     typecheckErrors,
     runtimeErrors,
+    staleRefs,
     limit,
     stdout,
     outputPath,
     cwd
   } = options;
   const { log } = deps;
-  const stats = computeStats(openpkg, doccov);
+  const stats = computeStats(openpkg, doccov, { staleRefs });
   const report = generateReportFromDocCov(openpkg, doccov);
-  const jsonContent = JSON.stringify(report, null, 2);
+  const extendedReport = staleRefs.length > 0 ? { ...report, staleRefs } : report;
+  const jsonContent = JSON.stringify(extendedReport, null, 2);
   const healthScore = doccov.summary.health?.score ?? stats.coverageScore;
   let formatContent;
   switch (format) {
@@ -1600,7 +1661,8 @@ function handleNonTextOutput(options, deps) {
   const apiSurfaceFailed = minApiSurface !== undefined && apiSurfaceScore < minApiSurface;
   const hasTypecheckErrors = typecheckErrors.length > 0;
   const hasRuntimeErrors = runtimeErrors > 0;
-  return !(healthFailed || apiSurfaceFailed || hasTypecheckErrors || hasRuntimeErrors);
+  const hasStaleRefs = staleRefs.length > 0;
+  return !(healthFailed || apiSurfaceFailed || hasTypecheckErrors || hasRuntimeErrors || hasStaleRefs);
 }
 function displayApiSurfaceOutput(doccov, deps) {
   const { log } = deps;
@@ -3787,6 +3849,7 @@ function registerCheckCommand(program, dependencies = {}) {
           minApiSurface,
           typecheckErrors,
           runtimeErrors: runtimeDrifts.length,
+          staleRefs,
           limit: parseInt(options.limit, 10) || 20,
           stdout: options.stdout,
           outputPath: options.output,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@doccov/cli",
-  "version": "0.30.0",
+  "version": "0.30.2",
   "description": "DocCov CLI - Documentation coverage and drift detection for TypeScript",
   "keywords": [
     "typescript",
@@ -48,10 +48,10 @@
   "dependencies": {
     "@ai-sdk/anthropic": "^1.0.0",
     "@ai-sdk/openai": "^1.0.0",
-    "@doccov/sdk": "^0.30.0",
+    "@doccov/sdk": "^0.30.1",
     "@doccov/spec": "^0.27.0",
     "@inquirer/prompts": "^7.8.0",
-    "@openpkg-ts/spec": "^0.12.0",
+    "@openpkg-ts/spec": "^0.19.0",
     "ai": "^4.0.0",
     "chalk": "^5.4.1",
     "cheerio": "^1.1.2",