@doccov/cli 0.23.0 → 0.24.1

package/dist/cli.js

@@ -292,8 +292,10 @@ import chalk3 from "chalk";
 // src/commands/check/utils.ts
 import * as fs from "node:fs";
 import * as path2 from "node:path";
-import { parseMarkdownFiles } from "@doccov/sdk";
-import { DRIFT_CATEGORIES } from "@openpkg-ts/spec";
+import {
+  DRIFT_CATEGORIES,
+  parseMarkdownFiles
+} from "@doccov/sdk";
 import { glob } from "glob";
 function collectDriftsFromExports(exports) {
   const results = [];
@@ -810,7 +812,7 @@ ${status} Coverage ${coverageScore >= 80 ? "passing" : coverageScore >= 50 ? "ne
   return output;
 }
 // src/reports/markdown.ts
-import { DRIFT_CATEGORY_LABELS } from "@openpkg-ts/spec";
+import { DRIFT_CATEGORY_LABELS } from "@doccov/sdk";
 function bar2(pct, width = 10) {
   const filled = Math.round(pct / 100 * width);
   return "█".repeat(filled) + "░".repeat(width - filled);
@@ -1220,10 +1222,10 @@ function renderDetailsTable(lines, diff) {
   }
 }
 // src/reports/stats.ts
-import { isFixableDrift } from "@doccov/sdk";
 import {
-  DRIFT_CATEGORIES as DRIFT_CATEGORIES2
-} from "@openpkg-ts/spec";
+  DRIFT_CATEGORIES as DRIFT_CATEGORIES2,
+  isFixableDrift
+} from "@doccov/sdk";
 function computeStats(spec) {
   const exports = spec.exports ?? [];
   const signals = {
@@ -2351,16 +2353,18 @@ var detectRepoInfo = (cwd, fileExists2, readFileSync4) => {
 import * as fs6 from "node:fs";
 import * as path8 from "node:path";
 import {
+  buildDocCovSpec,
   DocCov as DocCov3,
   detectPackageManager,
   NodeFileSystem as NodeFileSystem3,
   renderApiSurface,
   resolveTarget as resolveTarget3
 } from "@doccov/sdk";
+import { validateDocCovSpec } from "@doccov/spec";
 import { normalize, validateSpec } from "@openpkg-ts/spec";
 import chalk10 from "chalk";
 // package.json
-var version = "0.22.0";
+var version = "0.24.0";
 
 // src/commands/spec.ts
 var defaultDependencies4 = {
@@ -2384,15 +2388,19 @@ function registerSpecCommand(program, dependencies = {}) {
     ...defaultDependencies4,
     ...dependencies
   };
-  program.command("spec [entry]").description("Generate OpenPkg specification (JSON)").option("--cwd <dir>", "Working directory", process.cwd()).option("-p, --package <name>", "Target package name (for monorepos)").option("-o, --output <file>", "Output file path", "openpkg.json").option("-f, --format <format>", "Output format: json (default) or api-surface", "json").option("--include <patterns>", "Include exports matching pattern (comma-separated)").option("--exclude <patterns>", "Exclude exports matching pattern (comma-separated)").option("--visibility <tags>", "Filter by release stage: public,beta,alpha,internal (comma-separated)").option("--skip-resolve", "Skip external type resolution from node_modules").option("--max-type-depth <n>", "Maximum depth for type conversion", "20").option("--runtime", "Enable Standard Schema runtime extraction (richer output for Zod, Valibot, etc.)").option("--no-cache", "Bypass spec cache and force regeneration").option("--show-diagnostics", "Show TypeScript compiler diagnostics").option("--verbose", "Show detailed generation metadata").action(async (entry, options) => {
+  program.command("spec [entry]").description("Generate OpenPkg + DocCov specifications").option("--cwd <dir>", "Working directory", process.cwd()).option("-p, --package <name>", "Target package name (for monorepos)").option("-o, --output <dir>", "Output directory", ".doccov").option("-f, --format <format>", "Output format: json (default) or api-surface", "json").option("--openpkg-only", "Only generate openpkg.json (skip coverage analysis)").option("--include <patterns>", "Include exports matching pattern (comma-separated)").option("--exclude <patterns>", "Exclude exports matching pattern (comma-separated)").option("--visibility <tags>", "Filter by release stage: public,beta,alpha,internal (comma-separated)").option("--skip-resolve", "Skip external type resolution from node_modules").option("--max-type-depth <n>", "Maximum depth for type conversion", "20").option("--runtime", "Enable Standard Schema runtime extraction (richer output for Zod, Valibot, etc.)").option("--no-cache", "Bypass spec cache and force regeneration").option("--show-diagnostics", "Show TypeScript compiler diagnostics").option("--verbose", "Show detailed generation metadata").action(async (entry, options) => {
     try {
-      const steps = new StepProgress([
+      const stepsList = [
         { label: "Resolved target", activeLabel: "Resolving target" },
         { label: "Loaded config", activeLabel: "Loading config" },
         { label: "Generated spec", activeLabel: "Generating spec" },
-        { label: "Validated schema", activeLabel: "Validating schema" },
-        { label: "Wrote output", activeLabel: "Writing output" }
-      ]);
+        { label: "Validated schema", activeLabel: "Validating schema" }
+      ];
+      if (!options.openpkgOnly) {
+        stepsList.push({ label: "Built coverage analysis", activeLabel: "Building coverage" });
+      }
+      stepsList.push({ label: "Wrote output", activeLabel: "Writing output" });
+      const steps = new StepProgress(stepsList);
       steps.start();
       const fileSystem = new NodeFileSystem3(options.cwd);
       const resolved = await resolveTarget3(fileSystem, {
@@ -2457,18 +2465,46 @@ function registerSpecCommand(program, dependencies = {}) {
         process.exit(1);
       }
       steps.next();
+      let doccovSpec = null;
+      if (!options.openpkgOnly) {
+        doccovSpec = buildDocCovSpec({
+          openpkgPath: "openpkg.json",
+          openpkg: normalized,
+          packagePath: targetDir
+        });
+        const doccovValidation = validateDocCovSpec(doccovSpec);
+        if (!doccovValidation.ok) {
+          error(chalk10.red("DocCov spec failed schema validation"));
+          for (const err of doccovValidation.errors) {
+            error(chalk10.red(`doccov: ${err.instancePath || "/"} ${err.message}`));
+          }
+          process.exit(1);
+        }
+        steps.next();
+      }
       const format = options.format ?? "json";
-      const outputPath = path8.resolve(options.cwd, options.output);
+      const outputDir = path8.resolve(options.cwd, options.output);
+      fs6.mkdirSync(outputDir, { recursive: true });
       if (format === "api-surface") {
         const apiSurface = renderApiSurface(normalized);
-        writeFileSync4(outputPath, apiSurface);
-        steps.complete(`Generated ${options.output} (API surface)`);
+        const apiSurfacePath = path8.join(outputDir, "api-surface.txt");
+        writeFileSync4(apiSurfacePath, apiSurface);
+        steps.complete(`Generated ${options.output}/ (API surface)`);
       } else {
-        writeFileSync4(outputPath, JSON.stringify(normalized, null, 2));
-        steps.complete(`Generated ${options.output}`);
+        const openpkgPath = path8.join(outputDir, "openpkg.json");
+        writeFileSync4(openpkgPath, JSON.stringify(normalized, null, 2));
+        if (doccovSpec) {
+          const doccovPath = path8.join(outputDir, "doccov.json");
+          writeFileSync4(doccovPath, JSON.stringify(doccovSpec, null, 2));
+          steps.complete(`Generated ${options.output}/`);
+          log(chalk10.gray(`  openpkg.json: ${getArrayLength(normalized.exports)} exports`));
+          log(chalk10.gray(`  doccov.json:  ${doccovSpec.summary.score}% coverage, ${doccovSpec.summary.drift.total} drift issues`));
+        } else {
+          steps.complete(`Generated ${options.output}/openpkg.json`);
+          log(chalk10.gray(`  ${getArrayLength(normalized.exports)} exports`));
+          log(chalk10.gray(`  ${getArrayLength(normalized.types)} types`));
+        }
       }
-      log(chalk10.gray(`  ${getArrayLength(normalized.exports)} exports`));
-      log(chalk10.gray(`  ${getArrayLength(normalized.types)} types`));
       const schemaExtraction = normalized.generation?.analysis?.schemaExtraction;
       if (options.runtime && (!schemaExtraction?.runtimeCount || schemaExtraction.runtimeCount === 0)) {
         const pm = await detectPackageManager(fileSystem);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@doccov/cli",
-  "version": "0.23.0",
+  "version": "0.24.1",
   "description": "DocCov CLI - Documentation coverage and drift detection for TypeScript",
   "keywords": [
     "typescript",
@@ -48,9 +48,10 @@
   "dependencies": {
     "@ai-sdk/anthropic": "^1.0.0",
     "@ai-sdk/openai": "^1.0.0",
-    "@doccov/sdk": "^0.23.0",
+    "@doccov/sdk": "^0.24.1",
+    "@doccov/spec": "^0.24.1",
     "@inquirer/prompts": "^7.8.0",
-    "@openpkg-ts/spec": "^0.11.0",
+    "@openpkg-ts/spec": "^0.11.1",
     "ai": "^4.0.0",
     "chalk": "^5.4.1",
     "commander": "^14.0.0",