@doccov/sdk 0.30.6 → 0.31.0

package/dist/index.js

@@ -1,16 +1,21 @@
 import {
+  DEFAULT_REQUIREMENTS,
   DRIFT_CATEGORIES,
   DRIFT_CATEGORY_DESCRIPTIONS,
   DRIFT_CATEGORY_LABELS,
   HISTORY_DIR,
+  IncrementalAnalyzer,
+  PRESETS,
   applyEdits,
   applyForgottenExportFixes,
   applyPatchToJSDoc,
   buildDocCovSpec,
   buildExportRegistry,
+  buildModuleGraph,
   calculateAggregateCoverage,
   categorizeDrift,
   categorizeDrifts,
+  cleanupOrphanedTempFiles,
   computeDrift,
   computeExportDrift,
   computeHealth,
@@ -26,7 +31,9 @@ import {
   extractStandardSchemasFromProject,
   findAdapter,
   findJSDocLocation,
+  findOrphanedTempFiles,
   findProjectRoot,
+  findSymbolModule,
   formatDelta,
   formatDriftSummaryLine,
   generateFix,
@@ -48,6 +55,7 @@ import {
   groupFixesByFile,
   hasNonAssertionComments,
   isBuiltInIdentifier,
+  isExportDocumented,
   isExportFullyDocumented,
   isFixableDrift,
   isSchemaType,
@@ -62,11 +70,13 @@ import {
   renderApiSurface,
   renderSparkline,
   resolveCompiledPath,
+  resolveRequirements,
   saveReport,
   saveSnapshot,
   serializeJSDoc,
+  symbolExistsInGraph,
   ts
-} from "./shared/chunk-fdjehkbt.js";
+} from "./shared/chunk-ee3ctqje.js";
 import {
   mergeFilters,
   parseListFlag
@@ -82,6 +92,55 @@ import {
   getDiffReportPath,
   getReportPath
 } from "./shared/chunk-r4wa72ae.js";
+// src/analysis/batch.ts
+function createPackageResult(openpkg, doccov, entryPath) {
+  const totalExports = doccov.summary.totalExports;
+  const documented = doccov.summary.health?.completeness.documented ?? 0;
+  const health = doccov.summary.health?.score ?? doccov.summary.score;
+  const driftCount = doccov.summary.drift.total;
+  const coverageScore = doccov.summary.score;
+  return {
+    name: openpkg.meta.name,
+    version: openpkg.meta.version,
+    entryPath,
+    totalExports,
+    documented,
+    health,
+    driftCount,
+    coverageScore,
+    openpkg,
+    doccov
+  };
+}
+function aggregateResults(packages) {
+  if (packages.length === 0) {
+    return {
+      packages: [],
+      aggregate: {
+        totalExports: 0,
+        documented: 0,
+        health: 0,
+        driftCount: 0,
+        coverageScore: 0
+      }
+    };
+  }
+  const totalExports = packages.reduce((sum, p) => sum + p.totalExports, 0);
+  const documented = packages.reduce((sum, p) => sum + p.documented, 0);
+  const driftCount = packages.reduce((sum, p) => sum + p.driftCount, 0);
+  const weightedHealth = totalExports > 0 ? Math.round(packages.reduce((sum, p) => sum + p.health * p.totalExports, 0) / totalExports) : 0;
+  const weightedCoverage = totalExports > 0 ? Math.round(packages.reduce((sum, p) => sum + p.coverageScore * p.totalExports, 0) / totalExports) : 0;
+  return {
+    packages,
+    aggregate: {
+      totalExports,
+      documented,
+      health: weightedHealth,
+      driftCount,
+      coverageScore: weightedCoverage
+    }
+  };
+}
 // src/analyzer.ts
 import * as fsSync from "node:fs";
 import * as fs5 from "node:fs/promises";
@@ -109,7 +168,7 @@ function findRepoRoot(startDir) {
   }
   return startDir;
 }
-var DEFAULT_MAX_TYPE_DEPTH = 20;
+var DEFAULT_MAX_TYPE_DEPTH = 4;
 var DEFAULT_OPTIONS = {
   includePrivate: false,
   followImports: true,
@@ -226,13 +285,7 @@ async function runAnalysis(input) {
   const packageJsonPath = findNearestPackageJson(baseDir);
   const hasNodeModules = canResolveExternalModules(program, baseDir);
   const resolveExternalTypes = options.resolveExternalTypes !== undefined ? options.resolveExternalTypes : hasNodeModules;
-  const diagnostics = ts.getPreEmitDiagnostics(context.program).filter((d) => {
-    if (d.code === 5053)
-      return false;
-    const msg = ts.flattenDiagnosticMessageText(d.messageText, `
-`);
-    return !/allowJs/i.test(msg);
-  });
+  const diagnostics = [];
   const specDiagnostics = [];
   if (!hasNodeModules && hasExternalImports(context.sourceFile)) {
     specDiagnostics.push({
@@ -14479,12 +14532,26 @@ var apiSurfaceConfigSchema = exports_external.object({
   warnBelow: exports_external.number().min(0).max(100).optional(),
   ignore: exports_external.array(exports_external.string()).optional()
 });
+var stylePresetSchema = exports_external.enum([
+  "minimal",
+  "verbose",
+  "types-only"
+]);
+var docRequirementsSchema = exports_external.object({
+  description: exports_external.boolean().optional(),
+  params: exports_external.boolean().optional(),
+  returns: exports_external.boolean().optional(),
+  examples: exports_external.boolean().optional(),
+  since: exports_external.boolean().optional()
+});
 var checkConfigSchema = exports_external.object({
   examples: exampleModesSchema.optional(),
   minHealth: exports_external.number().min(0).max(100).optional(),
   minCoverage: exports_external.number().min(0).max(100).optional(),
   maxDrift: exports_external.number().min(0).max(100).optional(),
-  apiSurface: apiSurfaceConfigSchema.optional()
+  apiSurface: apiSurfaceConfigSchema.optional(),
+  style: stylePresetSchema.optional(),
+  require: docRequirementsSchema.optional()
 });
 var docCovConfigSchema = exports_external.object({
   include: stringList.optional(),
@@ -14517,12 +14584,24 @@ var normalizeConfig = (input) => {
   }
   let check2;
   if (input.check) {
+    let require2;
+    if (input.check.require) {
+      require2 = {
+        description: input.check.require.description,
+        params: input.check.require.params,
+        returns: input.check.require.returns,
+        examples: input.check.require.examples,
+        since: input.check.require.since
+      };
+    }
     check2 = {
       examples: input.check.examples,
       minHealth: input.check.minHealth,
       minCoverage: input.check.minCoverage,
       maxDrift: input.check.maxDrift,
-      apiSurface: input.check.apiSurface
+      apiSurface: input.check.apiSurface,
+      style: input.check.style,
+      require: require2
     };
   }
   return {
@@ -14658,6 +14737,7 @@ function getPrimaryBuildScript(buildInfo) {
   return buildInfo.scripts[0] ?? null;
 }
 // src/detect/entry-point.ts
+import * as nodePath from "node:path";
 async function detectEntryPoint(fs6, packagePath = ".") {
   const pkgJson = await readPackageJson(fs6, packagePath);
   if (!pkgJson) {
@@ -14781,9 +14861,31 @@ async function resolveToSource(fs6, basePath, filePath, tsConfig) {
   }
   return null;
 }
+async function findEntryPointForFile(fs6, filePath) {
+  let currentDir = nodePath.dirname(filePath);
+  while (currentDir !== nodePath.dirname(currentDir)) {
+    const hasPackageJson = await fs6.exists(nodePath.join(currentDir, "package.json"));
+    if (hasPackageJson) {
+      try {
+        const entryPoint = await detectEntryPoint(fs6, currentDir);
+        return { entryPoint, packagePath: currentDir };
+      } catch {}
+    }
+    currentDir = nodePath.dirname(currentDir);
+  }
+  return null;
+}
+async function isPackageEntryPoint(fs6, filePath) {
+  const result = await findEntryPointForFile(fs6, filePath);
+  if (!result)
+    return false;
+  const entryAbsolute = nodePath.resolve(result.packagePath, result.entryPoint.path);
+  const fileAbsolute = nodePath.resolve(filePath);
+  return entryAbsolute === fileAbsolute;
+}
 // src/detect/filesystem.ts
 import * as fs6 from "node:fs";
-import * as nodePath from "node:path";
+import * as nodePath2 from "node:path";
 import { Writable } from "node:stream";
 
 class NodeFileSystem {
@@ -14792,7 +14894,7 @@ class NodeFileSystem {
     this.basePath = basePath;
   }
   resolve(relativePath) {
-    return nodePath.join(this.basePath, relativePath);
+    return nodePath2.join(this.basePath, relativePath);
   }
   async exists(relativePath) {
     return fs6.existsSync(this.resolve(relativePath));
@@ -15422,7 +15524,7 @@ async function runExample(code, options = {}) {
   try {
     fs8.writeFileSync(tmpFile, cleanCode, "utf-8");
     const startTime = Date.now();
-    return await new Promise((resolve4) => {
+    return await new Promise((resolve5) => {
       let stdout = "";
       let stderr = "";
       let killed = false;
@@ -15445,7 +15547,7 @@ async function runExample(code, options = {}) {
         clearTimeout(timeoutId);
         const duration3 = Date.now() - startTime;
         if (killed) {
-          resolve4({
+          resolve5({
             success: false,
             stdout,
             stderr: stderr || `Example timed out after ${timeout}ms`,
@@ -15453,7 +15555,7 @@ async function runExample(code, options = {}) {
             duration: duration3
           });
         } else {
-          resolve4({
+          resolve5({
             success: exitCode === 0,
             stdout,
             stderr,
@@ -15464,7 +15566,7 @@ async function runExample(code, options = {}) {
       });
       proc.on("error", (error48) => {
         clearTimeout(timeoutId);
-        resolve4({
+        resolve5({
           success: false,
           stdout,
           stderr: error48.message,
@@ -15515,7 +15617,7 @@ function getInstallCommand2(pm, packagePath) {
   }
 }
 async function runCommand(cmd, args, options) {
-  return new Promise((resolve4) => {
+  return new Promise((resolve5) => {
     let stdout = "";
     let stderr = "";
     let killed = false;
@@ -15536,14 +15638,14 @@ async function runCommand(cmd, args, options) {
     proc.on("close", (exitCode) => {
       clearTimeout(timeoutId);
       if (killed) {
-        resolve4({
+        resolve5({
           success: false,
           stdout,
           stderr: stderr || `Command timed out after ${options.timeout}ms`,
           exitCode: exitCode ?? 1
         });
       } else {
-        resolve4({
+        resolve5({
           success: exitCode === 0,
           stdout,
           stderr,
@@ -15553,7 +15655,7 @@ async function runCommand(cmd, args, options) {
     });
     proc.on("error", (error48) => {
       clearTimeout(timeoutId);
-      resolve4({
+      resolve5({
         success: false,
         stdout,
         stderr: error48.message,
@@ -17050,6 +17152,7 @@ export {
   validateExamples,
   typecheckExamples,
   typecheckExample,
+  symbolExistsInGraph,
   shouldValidate,
   serializeJSDoc,
   saveSpecCache,
@@ -17060,6 +17163,7 @@ export {
   runExamples,
   runExample,
   resolveTarget,
+  resolveRequirements,
   resolveCompiledPath,
   renderSparkline,
   renderApiSurface,
@@ -17083,8 +17187,10 @@ export {
   listWorkspacePackages,
   isStandardJSONSchema,
   isSchemaType,
+  isPackageEntryPoint,
   isFixableDrift,
   isExportFullyDocumented,
+  isExportDocumented,
   isExecutableLang,
   installDependencies,
   hashString,
@@ -17122,11 +17228,14 @@ export {
   formatPackageList,
   formatDriftSummaryLine,
   formatDelta,
+  findSymbolModule,
   findRemovedReferences,
   findProjectRoot,
   findPackageByName,
+  findOrphanedTempFiles,
   findJSDocLocation,
   findExportReferences,
+  findEntryPointForFile,
   findDeprecatedReferences,
   findAdapter,
   fetchSpecFromGitHub,
@@ -17153,16 +17262,19 @@ export {
   detectBuildInfo,
   defineConfig,
   createSourceFile,
+  createPackageResult,
   createNodeCommandRunner,
   computeSnapshot,
   computeHealth,
   computeExportDrift,
   computeDrift,
   clearSpecCache,
+  cleanupOrphanedTempFiles,
   categorizeDrifts,
   categorizeDrift,
   calculateAggregateCoverage,
   buildRawUrl,
+  buildModuleGraph,
   buildExportRegistry,
   buildDocCovSpec,
   buildDisplayUrl,
@@ -17175,17 +17287,21 @@ export {
   analyzeFile,
   analyzeDocsImpact,
   analyze,
+  aggregateResults,
   VALIDATION_INFO,
   SandboxFileSystem,
   SPEC_CACHE_FILE,
   REPORT_VERSION,
   REPORT_EXTENSIONS,
+  PRESETS,
   NodeFileSystem,
+  IncrementalAnalyzer,
   HISTORY_DIR,
   DocCov,
   DRIFT_CATEGORY_LABELS,
   DRIFT_CATEGORY_DESCRIPTIONS,
   DRIFT_CATEGORIES,
+  DEFAULT_REQUIREMENTS,
   DEFAULT_REPORT_PATH,
   DEFAULT_REPORT_DIR,
   CACHE_VERSION,