@doccov/sdk 0.28.0 → 0.28.2

package/dist/shared/{chunk-3p1hd5h3.js → chunk-0048g7g0.js}

@@ -426,9 +426,126 @@ function categorizeDrifts(drifts) {
   return { fixable, nonFixable };
 }
 
-// src/fix/jsdoc-writer.ts
+// src/fix/forgotten-exports.ts
 import * as fs from "node:fs";
 import * as path from "node:path";
+function generateForgottenExportFixes(apiSurface, options) {
+  const { baseDir, entryFile } = options;
+  const fixes = [];
+  for (const forgotten of apiSurface.forgotten) {
+    if (forgotten.isExternal)
+      continue;
+    if (!forgotten.fix)
+      continue;
+    const targetFile = forgotten.fix.targetFile ? path.resolve(baseDir, forgotten.fix.targetFile) : path.resolve(baseDir, entryFile);
+    fixes.push({
+      type: "forgotten-export",
+      typeName: forgotten.name,
+      targetFile,
+      exportStatement: forgotten.fix.exportStatement,
+      insertPosition: "append"
+    });
+  }
+  return fixes;
+}
+function groupFixesByFile(fixes) {
+  const grouped = new Map;
+  for (const fix of fixes) {
+    const existing = grouped.get(fix.targetFile) ?? [];
+    existing.push(fix);
+    grouped.set(fix.targetFile, existing);
+  }
+  return grouped;
+}
+async function applyForgottenExportFixes(fixes) {
+  const result = {
+    filesModified: 0,
+    fixesApplied: 0,
+    errors: []
+  };
+  const grouped = groupFixesByFile(fixes);
+  for (const [filePath, fileFixes] of grouped) {
+    try {
+      if (!fs.existsSync(filePath)) {
+        result.errors.push({
+          file: filePath,
+          error: "File not found"
+        });
+        continue;
+      }
+      const content = await fs.promises.readFile(filePath, "utf8");
+      const lines = content.split(`
+`);
+      const insertLine = findBestInsertionPoint(lines, fileFixes);
+      const statements = fileFixes.map((f) => f.exportStatement);
+      const uniqueStatements = [...new Set(statements)];
+      const newContent = insertExportStatements(lines, insertLine, uniqueStatements);
+      await fs.promises.writeFile(filePath, newContent, "utf8");
+      result.filesModified++;
+      result.fixesApplied += uniqueStatements.length;
+    } catch (err) {
+      result.errors.push({
+        file: filePath,
+        error: err instanceof Error ? err.message : String(err)
+      });
+    }
+  }
+  return result;
+}
+function findBestInsertionPoint(lines, _fixes) {
+  let lastExportLine = -1;
+  let lastReExportLine = -1;
+  for (let i = 0;i < lines.length; i++) {
+    const line = lines[i].trim();
+    if (line.match(/^export\s+(\*|\{[^}]*\})\s+from\s+['"]/)) {
+      lastReExportLine = i;
+    }
+    if (line.startsWith("export ")) {
+      lastExportLine = i;
+    }
+  }
+  if (lastReExportLine >= 0) {
+    return lastReExportLine + 1;
+  }
+  if (lastExportLine >= 0) {
+    return lastExportLine + 1;
+  }
+  return lines.length;
+}
+function insertExportStatements(lines, insertLine, statements) {
+  const newLines = [...lines];
+  const needsBlankBefore = insertLine > 0 && newLines[insertLine - 1]?.trim() !== "" && !newLines[insertLine - 1]?.trim().startsWith("export");
+  const insertBlock = statements.join(`
+`);
+  if (needsBlankBefore) {
+    newLines.splice(insertLine, 0, "", insertBlock);
+  } else {
+    newLines.splice(insertLine, 0, insertBlock);
+  }
+  return newLines.join(`
+`);
+}
+function previewForgottenExportFixes(fixes) {
+  const previews = new Map;
+  const grouped = groupFixesByFile(fixes);
+  for (const [filePath, fileFixes] of grouped) {
+    try {
+      if (!fs.existsSync(filePath))
+        continue;
+      const content = fs.readFileSync(filePath, "utf8");
+      const lines = content.split(`
+`);
+      const insertLine = findBestInsertionPoint(lines, fileFixes);
+      const statements = [...new Set(fileFixes.map((f) => f.exportStatement))];
+      previews.set(filePath, { insertLine, statements });
+    } catch {}
+  }
+  return previews;
+}
+
+// src/fix/jsdoc-writer.ts
+import * as fs2 from "node:fs";
+import * as path2 from "node:path";
 
 // src/ts-module.ts
 import * as tsNamespace from "typescript";
@@ -797,7 +914,7 @@ async function applyEdits(edits) {
   }
   for (const [filePath, fileEdits] of editsByFile) {
     try {
-      const content = fs.readFileSync(filePath, "utf-8");
+      const content = fs2.readFileSync(filePath, "utf-8");
       const lines = content.split(`
 `);
       const sortedEdits = [...fileEdits].sort((a, b) => b.startLine - a.startLine);
@@ -811,7 +928,7 @@ async function applyEdits(edits) {
         }
         result.editsApplied++;
       }
-      fs.writeFileSync(filePath, lines.join(`
+      fs2.writeFileSync(filePath, lines.join(`
 `));
       result.filesModified++;
     } catch (error) {
@@ -824,125 +941,8 @@ async function applyEdits(edits) {
   return result;
 }
 function createSourceFile(filePath) {
-  const content = fs.readFileSync(filePath, "utf-8");
-  return ts.createSourceFile(path.basename(filePath), content, ts.ScriptTarget.Latest, true, filePath.endsWith(".tsx") ? ts.ScriptKind.TSX : ts.ScriptKind.TS);
-}
-
-// src/fix/forgotten-exports.ts
-import * as fs2 from "node:fs";
-import * as path2 from "node:path";
-function generateForgottenExportFixes(apiSurface, options) {
-  const { baseDir, entryFile } = options;
-  const fixes = [];
-  for (const forgotten of apiSurface.forgotten) {
-    if (forgotten.isExternal)
-      continue;
-    if (!forgotten.fix)
-      continue;
-    const targetFile = forgotten.fix.targetFile ? path2.resolve(baseDir, forgotten.fix.targetFile) : path2.resolve(baseDir, entryFile);
-    fixes.push({
-      type: "forgotten-export",
-      typeName: forgotten.name,
-      targetFile,
-      exportStatement: forgotten.fix.exportStatement,
-      insertPosition: "append"
-    });
-  }
-  return fixes;
-}
-function groupFixesByFile(fixes) {
-  const grouped = new Map;
-  for (const fix of fixes) {
-    const existing = grouped.get(fix.targetFile) ?? [];
-    existing.push(fix);
-    grouped.set(fix.targetFile, existing);
-  }
-  return grouped;
-}
-async function applyForgottenExportFixes(fixes) {
-  const result = {
-    filesModified: 0,
-    fixesApplied: 0,
-    errors: []
-  };
-  const grouped = groupFixesByFile(fixes);
-  for (const [filePath, fileFixes] of grouped) {
-    try {
-      if (!fs2.existsSync(filePath)) {
-        result.errors.push({
-          file: filePath,
-          error: "File not found"
-        });
-        continue;
-      }
-      const content = await fs2.promises.readFile(filePath, "utf8");
-      const lines = content.split(`
-`);
-      const insertLine = findBestInsertionPoint(lines, fileFixes);
-      const statements = fileFixes.map((f) => f.exportStatement);
-      const uniqueStatements = [...new Set(statements)];
-      const newContent = insertExportStatements(lines, insertLine, uniqueStatements);
-      await fs2.promises.writeFile(filePath, newContent, "utf8");
-      result.filesModified++;
-      result.fixesApplied += uniqueStatements.length;
-    } catch (err) {
-      result.errors.push({
-        file: filePath,
-        error: err instanceof Error ? err.message : String(err)
-      });
-    }
-  }
-  return result;
-}
-function findBestInsertionPoint(lines, _fixes) {
-  let lastExportLine = -1;
-  let lastReExportLine = -1;
-  for (let i = 0;i < lines.length; i++) {
-    const line = lines[i].trim();
-    if (line.match(/^export\s+(\*|\{[^}]*\})\s+from\s+['"]/)) {
-      lastReExportLine = i;
-    }
-    if (line.startsWith("export ")) {
-      lastExportLine = i;
-    }
-  }
-  if (lastReExportLine >= 0) {
-    return lastReExportLine + 1;
-  }
-  if (lastExportLine >= 0) {
-    return lastExportLine + 1;
-  }
-  return lines.length;
-}
-function insertExportStatements(lines, insertLine, statements) {
-  const newLines = [...lines];
-  const needsBlankBefore = insertLine > 0 && newLines[insertLine - 1]?.trim() !== "" && !newLines[insertLine - 1]?.trim().startsWith("export");
-  const insertBlock = statements.join(`
-`);
-  if (needsBlankBefore) {
-    newLines.splice(insertLine, 0, "", insertBlock);
-  } else {
-    newLines.splice(insertLine, 0, insertBlock);
-  }
-  return newLines.join(`
-`);
-}
-function previewForgottenExportFixes(fixes) {
-  const previews = new Map;
-  const grouped = groupFixesByFile(fixes);
-  for (const [filePath, fileFixes] of grouped) {
-    try {
-      if (!fs2.existsSync(filePath))
-        continue;
-      const content = fs2.readFileSync(filePath, "utf8");
-      const lines = content.split(`
-`);
-      const insertLine = findBestInsertionPoint(lines, fileFixes);
-      const statements = [...new Set(fileFixes.map((f) => f.exportStatement))];
-      previews.set(filePath, { insertLine, statements });
-    } catch {}
-  }
-  return previews;
+  const content = fs2.readFileSync(filePath, "utf-8");
+  return ts.createSourceFile(path2.basename(filePath), content, ts.ScriptTarget.Latest, true, filePath.endsWith(".tsx") ? ts.ScriptKind.TSX : ts.ScriptKind.TS);
 }
 // src/analysis/drift/example-drift.ts
 import ts2 from "typescript";
@@ -2176,7 +2176,7 @@ function computeHealth(input) {
     examples
   } = input;
   const completenessScore = coverageScore;
-  const driftRatio = documentedExports > 0 ? driftIssues / documentedExports : 0;
+  const driftRatio = totalExports > 0 ? driftIssues / totalExports : 0;
   const driftPenalty = Math.min(driftRatio * 0.5, 0.5);
   const accuracyScore = Math.round((1 - driftPenalty) * 100);
   let exampleScore;
@@ -2798,18 +2798,18 @@ function renderApiSurface(spec) {
 // src/extract/schema/index.ts
 import {
   arktypeAdapter,
-  typeboxAdapter,
-  valibotAdapter,
-  zodAdapter,
   extractSchemaType,
-  findAdapter,
-  isSchemaType,
   extractStandardSchemas,
   extractStandardSchemasFromProject,
+  findAdapter,
+  getNonNullableType,
+  isSchemaType,
   isStandardJSONSchema,
+  isTypeReference,
   resolveCompiledPath,
-  getNonNullableType,
-  isTypeReference
+  typeboxAdapter,
+  valibotAdapter,
+  zodAdapter
 } from "@openpkg-ts/extract";
 import {
   arktypeAdapter as arktypeAdapter2,
@@ -3060,4 +3060,4 @@ function getExtendedTrend(spec, cwd, options) {
   };
 }
 
-export { isFixableDrift, generateFix, generateFixesForExport, mergeFixes, categorizeDrifts, ts, parseJSDocToPatch, applyPatchToJSDoc, serializeJSDoc, findJSDocLocation, applyEdits, createSourceFile, generateForgottenExportFixes, groupFixesByFile, applyForgottenExportFixes, previewForgottenExportFixes, isBuiltInIdentifier, detectExampleRuntimeErrors, parseAssertions, hasNonAssertionComments, detectExampleAssertionFailures, buildExportRegistry, computeDrift, computeExportDrift, computeHealth, buildDocCovSpec, DRIFT_CATEGORIES2 as DRIFT_CATEGORIES, DRIFT_CATEGORY_LABELS, DRIFT_CATEGORY_DESCRIPTIONS, categorizeDrift, groupDriftsByCategory, getDriftSummary, formatDriftSummaryLine, calculateAggregateCoverage, ensureSpecCoverage, getExportAnalysis, getExportScore, getExportDrift, getExportMissing, isExportFullyDocumented, generateReport, generateReportFromDocCov, loadCachedReport, saveReport, isCachedReportValid, renderApiSurface, extractSchemaOutputType, getRegisteredAdapters, getSupportedLibraries, extractSchemaType, findAdapter, isSchemaType, extractStandardSchemas, extractStandardSchemasFromProject, isStandardJSONSchema, resolveCompiledPath, detectRuntimeSchemas, HISTORY_DIR, computeSnapshot, saveSnapshot, loadSnapshots, getTrend, renderSparkline, formatDelta, pruneHistory, loadSnapshotsForDays, generateWeeklySummaries, getExtendedTrend };
+export { isFixableDrift, generateFix, generateFixesForExport, mergeFixes, categorizeDrifts, generateForgottenExportFixes, groupFixesByFile, applyForgottenExportFixes, previewForgottenExportFixes, ts, parseJSDocToPatch, applyPatchToJSDoc, serializeJSDoc, findJSDocLocation, applyEdits, createSourceFile, isBuiltInIdentifier, detectExampleRuntimeErrors, parseAssertions, hasNonAssertionComments, detectExampleAssertionFailures, buildExportRegistry, computeDrift, computeExportDrift, computeHealth, buildDocCovSpec, DRIFT_CATEGORIES2 as DRIFT_CATEGORIES, DRIFT_CATEGORY_LABELS, DRIFT_CATEGORY_DESCRIPTIONS, categorizeDrift, groupDriftsByCategory, getDriftSummary, formatDriftSummaryLine, calculateAggregateCoverage, ensureSpecCoverage, getExportAnalysis, getExportScore, getExportDrift, getExportMissing, isExportFullyDocumented, generateReport, generateReportFromDocCov, loadCachedReport, saveReport, isCachedReportValid, renderApiSurface, extractSchemaOutputType, getRegisteredAdapters, getSupportedLibraries, extractSchemaType, extractStandardSchemas, extractStandardSchemasFromProject, findAdapter, isSchemaType, isStandardJSONSchema, resolveCompiledPath, detectRuntimeSchemas, HISTORY_DIR, computeSnapshot, saveSnapshot, loadSnapshots, getTrend, renderSparkline, formatDelta, pruneHistory, loadSnapshotsForDays, generateWeeklySummaries, getExtendedTrend };

package/dist/types/index.d.ts

@@ -145,6 +145,7 @@ declare function parseListFlag(value?: string | string[]): string[] | undefined;
 * ```
 */
 declare function mergeFilters(config: DocCovConfig | null, overrides: FilterOptions): ResolvedFilters;
+import { ApiSurfaceResult, DocumentationHealth } from "@doccov/spec";
 /**
 * All possible drift type identifiers.
 */
@@ -166,7 +167,6 @@ interface CategorizedDrift extends SpecDocDrift {
 	category: DriftCategory;
 	fixable: boolean;
 }
-import { ApiSurfaceResult, DocumentationHealth } from "@doccov/spec";
 /**
 * DocCov report schema version.
 */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@doccov/sdk",
-  "version": "0.28.0",
+  "version": "0.28.2",
   "description": "DocCov SDK - Documentation coverage and drift detection for TypeScript",
   "keywords": [
     "typescript",