@driftdev/cli 1.12.1 → 1.13.0

package/dist/drift.js

@@ -52,7 +52,7 @@ var init_global = () => {};
 
 // src/drift.ts
 import { readFileSync as readFileSync23 } from "node:fs";
-import * as path34 from "node:path";
+import * as path35 from "node:path";
 import { fileURLToPath as fileURLToPath2 } from "node:url";
 import { Command } from "commander";
 
@@ -4271,7 +4271,7 @@ function registerInitCommand(program) {
 }
 
 // src/commands/lint.ts
-import * as path28 from "node:path";
+import * as path29 from "node:path";
 import { buildExportRegistry, computeDrift as computeDrift4, detectProseDrift } from "@driftdev/sdk";
 
 // src/formatters/lint.ts
@@ -4309,6 +4309,13 @@ function renderLint(data, next) {
 }
 
 // src/utils/annotations.ts
+import * as path28 from "node:path";
+function annotationPath(filePath) {
+  if (!path28.isAbsolute(filePath))
+    return filePath;
+  const rel = path28.relative(process.cwd(), filePath);
+  return rel.startsWith("..") ? filePath : rel;
+}
 function escapeData(value) {
   return value.replace(/%/g, "%25").replace(/\r/g, "%0D").replace(/\n/g, "%0A");
 }
@@ -4319,7 +4326,7 @@ function emitAnnotations(issues, level = "error") {
   for (const issue of issues) {
     const props = [];
     if (issue.filePath)
-      props.push(`file=${escapeProperty(issue.filePath)}`);
+      props.push(`file=${escapeProperty(annotationPath(issue.filePath))}`);
     if (issue.line !== undefined)
       props.push(`line=${issue.line}`);
     props.push(`title=${escapeProperty(`drift: ${issue.export || "docs"}`)}`);
@@ -4382,9 +4389,9 @@ function registerLintCommand(program) {
         formatOutput("lint", { issues: [], count: 0 }, startTime, version, renderLint);
         return;
       }
-      let entryFile = entry ? path28.resolve(process.cwd(), entry) : undefined;
+      let entryFile = entry ? path29.resolve(process.cwd(), entry) : undefined;
       if (lang === "typescript" && !entryFile) {
-        entryFile = config.entry ? path28.resolve(process.cwd(), config.entry) : detectEntry();
+        entryFile = config.entry ? path29.resolve(process.cwd(), config.entry) : detectEntry();
       }
       const { apiSpec: spec } = await resolveTruth({
         entry: entryFile,
@@ -4450,7 +4457,7 @@ function registerLintCommand(program) {
 }
 
 // src/commands/list.ts
-import * as path29 from "node:path";
+import * as path30 from "node:path";
 import { computeDrift as computeDrift5 } from "@driftdev/sdk";
 import { listExports as listExports2 } from "@openpkg-ts/sdk";
 
@@ -4565,7 +4572,7 @@ function registerListCommand(program) {
       } else {
         let entryFile;
         if (searchOrEntry && looksLikeFilePath(searchOrEntry)) {
-          entryFile = path29.resolve(process.cwd(), searchOrEntry);
+          entryFile = path30.resolve(process.cwd(), searchOrEntry);
         } else if (searchOrEntry) {
           entryFile = detectEntry();
           searchTerm = searchOrEntry;
@@ -4822,7 +4829,7 @@ function diffArgs(command, args) {
 // src/commands/release.ts
 import { execSync as execSync4 } from "node:child_process";
 import { existsSync as existsSync15, readFileSync as readFileSync20 } from "node:fs";
-import * as path30 from "node:path";
+import * as path31 from "node:path";
 import { computeDrift as computeDrift6 } from "@driftdev/sdk";
 
 // src/formatters/release.ts
@@ -4870,7 +4877,7 @@ function getLastTag() {
   }
 }
 function getPackageVersion(cwd) {
-  const pkgPath = path30.join(cwd, "package.json");
+  const pkgPath = path31.join(cwd, "package.json");
   if (!existsSync15(pkgPath))
     return null;
   try {
@@ -4886,7 +4893,7 @@ function registerReleaseCommand(program) {
     const cwd = process.cwd();
     try {
       const { config } = loadConfig();
-      const entryFile = entry ? path30.resolve(cwd, entry) : config.entry ? path30.resolve(cwd, config.entry) : detectEntry();
+      const entryFile = entry ? path31.resolve(cwd, entry) : config.entry ? path31.resolve(cwd, config.entry) : detectEntry();
       const { spec } = await cachedExtract(entryFile);
       const exports = spec.exports ?? [];
       const total = exports.length;
@@ -5011,7 +5018,7 @@ function renderReport(data) {
 // src/utils/scan-packages.ts
 import { execSync as execSync5 } from "node:child_process";
 import { existsSync as existsSync16, readFileSync as readFileSync21 } from "node:fs";
-import * as path31 from "node:path";
+import * as path32 from "node:path";
 import { computeDrift as computeDrift7 } from "@driftdev/sdk";
 function detectPackageDirs2(cwd) {
   const workspaces = detectWorkspaces(cwd);
@@ -5030,11 +5037,11 @@ async function scanAllPackages(cwd) {
   const packageDirs = detectPackageDirs2(cwd);
   const results = [];
   for (const dir of packageDirs) {
-    const absDir = dir === "." ? cwd : path31.join(cwd, dir);
+    const absDir = dir === "." ? cwd : path32.join(cwd, dir);
     if (!existsSync16(absDir))
       continue;
     let name = dir;
-    const pkgPath = path31.join(absDir, "package.json");
+    const pkgPath = path32.join(absDir, "package.json");
     if (existsSync16(pkgPath)) {
       try {
         const pkg = JSON.parse(readFileSync21(pkgPath, "utf-8"));
@@ -5133,7 +5140,7 @@ function registerReportCommand(program) {
 }
 
 // src/commands/scan.ts
-import * as path32 from "node:path";
+import * as path33 from "node:path";
 import {
   buildExportRegistry as buildExportRegistry2,
   computeDrift as computeDrift8,
@@ -5149,13 +5156,15 @@ function renderScan(data, next) {
     lines.push(indent(`${c.bold(data.packageName)}${c.gray(ver)}`));
     lines.push("");
   }
-  const hColor = coverageColor(data.health);
-  lines.push(indent(`Health     ${hColor(`${data.health}%`)}`));
-  const externalNote = data.coverage.external ? c.gray(`  +${data.coverage.external} external (not resolvable here)`) : "";
-  lines.push(indent(`Coverage   ${coverageColor(data.coverage.score)(`${data.coverage.score}%`)}  (${data.coverage.documented}/${data.coverage.total} exports)${externalNote}`));
-  lines.push(indent(`Lint       ${data.lint.count === 0 ? c.green("0 issues") : c.red(`${data.lint.count} issues`)}`));
-  lines.push("");
-  if (data.lint.count > 0) {
+  if (data.health !== undefined && data.coverage && data.lint) {
+    const hColor = coverageColor(data.health);
+    lines.push(indent(`Health     ${hColor(`${data.health}%`)}`));
+    const externalNote = data.coverage.external ? c.gray(`  +${data.coverage.external} external (not resolvable here)`) : "";
+    lines.push(indent(`Coverage   ${coverageColor(data.coverage.score)(`${data.coverage.score}%`)}  (${data.coverage.documented}/${data.coverage.total} exports)${externalNote}`));
+    lines.push(indent(`Lint       ${data.lint.count === 0 ? c.green("0 issues") : c.red(`${data.lint.count} issues`)}`));
+    lines.push("");
+  }
+  if (data.lint && data.lint.count > 0) {
     lines.push(indent("Issues"));
     lines.push(indent(c.gray(separator())));
     const shown = data.lint.issues.slice(0, 10);
@@ -5215,6 +5224,25 @@ function renderBatchScan(data) {
 }
 
 // src/commands/scan.ts
+function toDocsCoverageResult(run) {
+  return {
+    pass: run.pass,
+    pages: run.pages.map((p) => ({
+      page: p.page,
+      type: p.type,
+      status: p.status,
+      baselineGaps: p.baselineGaps,
+      counts: p.result.counts,
+      failures: p.failures,
+      warnings: p.warnings,
+      gaps: p.result.gaps,
+      ghosts: p.result.ghosts,
+      inversions: p.result.inversions,
+      documentedKeysFromOtherTypes: p.result.documentedKeysFromOtherTypes,
+      annotated: p.result.annotated
+    }))
+  };
+}
 function registerScanCommand(program) {
   program.command("scan [entry]").description("Run coverage + lint + prose drift in one pass").option("--min <n>", "Minimum health threshold (exit 1 if below)").option("--all", "Run across all workspace packages").option("--private", "Include private packages in --all mode").option("--lang <language>", "Source language (inferred from --spec/--abi/.clar; default typescript)").option("--abi <path>", "ABI JSON file (required for --lang clarity)").option("--spec <path>", "OpenAPI document: path or URL (implies --lang openapi)").option("--docs <patterns...>", "Markdown corpus for prose drift: glob patterns or directories (overrides repo-local defaults)").option("--docs-map <file>", "Docs map (page→type) activating key-coverage mode: gaps/ghosts/inversions per page").option("--annotations", "Emit GitHub Actions ::error/::warning annotations for findings").action(async (entry, options) => {
     const startTime = Date.now();
@@ -5294,10 +5322,31 @@ function registerScanCommand(program) {
           process.exitCode = 1;
         return;
       }
+      if (options.docsMap && !entry) {
+        const loaded = loadDocsMap(options.docsMap);
+        if (loaded.map.pages.every((p) => p.spec || p.entry)) {
+          const run = await runDocsCoverage(loaded);
+          const data2 = { pass: run.pass, docsCoverage: toDocsCoverageResult(run) };
+          formatOutput("scan", data2, startTime, version, renderScan);
+          if (options.annotations) {
+            emitAnnotations(run.annotations.errors, "error");
+            emitAnnotations(run.annotations.warnings, "warning");
+          }
+          if (!run.pass) {
+            if (!shouldRenderHuman()) {
+              const covFails = run.pages.flatMap((p) => p.failures.map((f) => `${p.page}: ${f}`));
+              process.stderr.write(`scan failed: docs coverage: ${covFails.join(" | ")}
+`);
+            }
+            process.exitCode = 1;
+          }
+          return;
+        }
+      }
       const { config } = loadConfig();
-      let entryFile = entry ? path32.resolve(process.cwd(), entry) : undefined;
+      let entryFile = entry ? path33.resolve(process.cwd(), entry) : undefined;
       if (lang === "typescript" && !entryFile) {
-        entryFile = config.entry ? path32.resolve(process.cwd(), config.entry) : detectEntry();
+        entryFile = config.entry ? path33.resolve(process.cwd(), config.entry) : detectEntry();
       }
       const { apiSpec, packageName, packageVersion } = await resolveTruth({
         entry: entryFile,
@@ -5379,25 +5428,7 @@ function registerScanCommand(program) {
         pass,
         packageName,
         packageVersion,
-        ...docsCoverage ? {
-          docsCoverage: {
-            pass: docsCoverage.pass,
-            pages: docsCoverage.pages.map((p) => ({
-              page: p.page,
-              type: p.type,
-              status: p.status,
-              baselineGaps: p.baselineGaps,
-              counts: p.result.counts,
-              failures: p.failures,
-              warnings: p.warnings,
-              gaps: p.result.gaps,
-              ghosts: p.result.ghosts,
-              inversions: p.result.inversions,
-              documentedKeysFromOtherTypes: p.result.documentedKeysFromOtherTypes,
-              annotated: p.result.annotated
-            }))
-          }
-        } : {}
+        ...docsCoverage ? { docsCoverage: toDocsCoverageResult(docsCoverage) } : {}
       };
       let next;
       if (issues.length > 0) {
@@ -5473,7 +5504,7 @@ function registerSemverCommand(program) {
 
 // src/commands/validate.ts
 import { readFileSync as readFileSync22 } from "node:fs";
-import * as path33 from "node:path";
+import * as path34 from "node:path";
 import { validateSpec } from "@openpkg-ts/spec";
 
 // src/formatters/validate.ts
@@ -5499,7 +5530,7 @@ function registerValidateCommand(program) {
     const startTime = Date.now();
     const version = getVersion();
     try {
-      const filePath = path33.resolve(process.cwd(), file);
+      const filePath = path34.resolve(process.cwd(), file);
       const content = readFileSync22(filePath, "utf-8");
       const spec = JSON.parse(content);
       const result = validateSpec(spec);
@@ -5642,13 +5673,13 @@ function extractCapabilities(program) {
 
 // src/drift.ts
 var __filename2 = fileURLToPath2(import.meta.url);
-var __dirname3 = path34.dirname(__filename2);
-var packageJson = JSON.parse(readFileSync23(path34.join(__dirname3, "../package.json"), "utf-8"));
+var __dirname3 = path35.dirname(__filename2);
+var packageJson = JSON.parse(readFileSync23(path35.join(__dirname3, "../package.json"), "utf-8"));
 var program = new Command;
 program.name("drift").description("drift — detect when your docs drift from your code").version(packageJson.version).option("--json", "Force JSON output (default when piped)").option("--human", "Force human-readable output (default in terminal)").option("--config <path>", "Path to drift config file").option("--cwd <dir>", "Run as if started in <dir>").option("--no-cache", "Bypass spec cache").option("--tools", "List all available tools for agent use (JSON)").hook("preAction", (_thisCommand) => {
   const opts = program.opts();
   if (opts.cwd) {
-    process.chdir(path34.resolve(opts.cwd));
+    process.chdir(path35.resolve(opts.cwd));
   }
   setOutputMode({ json: opts.json, human: opts.human });
   setConfigPath(opts.config);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@driftdev/cli",
-  "version": "1.12.1",
+  "version": "1.13.0",
   "description": "Drift CLI - detect when your docs drift from your code",
   "keywords": [
     "typescript",
@@ -47,10 +47,10 @@
   "dependencies": {
     "@driftdev/clarity-adapter": "^1.0.1",
     "@driftdev/openapi-adapter": "^1.0.1",
-    "@driftdev/sdk": "^1.12.0",
+    "@driftdev/sdk": "^1.13.0",
     "@modelcontextprotocol/sdk": "^1.29.0",
-    "@openpkg-ts/sdk": "^0.43.0",
-    "@openpkg-ts/spec": "^0.43.0",
+    "@openpkg-ts/sdk": "^0.51.0",
+    "@openpkg-ts/spec": "^0.50.0",
     "chalk": "^5.4.1",
     "commander": "^14.0.0",
     "zod": "^4.2.1"