@doccov/sdk 0.5.6 → 0.5.7

package/dist/index.d.ts

@@ -159,8 +159,10 @@ interface DocsImpact {
 interface DocsImpactResult {
 	/** Files with impacted references */
 	impactedFiles: DocsImpact[];
-	/** New exports that have no documentation */
+	/** New exports (from this diff) that have no documentation */
 	missingDocs: string[];
+	/** ALL exports from the spec that have no documentation in the scanned files */
+	allUndocumented: string[];
 	/** Statistics */
 	stats: {
 		/** Total markdown files scanned */
@@ -171,6 +173,10 @@ interface DocsImpactResult {
 		referencesFound: number;
 		/** References impacted by changes */
 		impactedReferences: number;
+		/** Total exports in the spec */
+		totalExports: number;
+		/** Exports found documented in markdown */
+		documentedExports: number;
 	};
 }
 /**
@@ -255,7 +261,7 @@ declare function getDocumentedExports(markdownFiles: MarkdownDocFile[], exportNa
 * Get all exports that lack documentation
 */
 declare function getUndocumentedExports(markdownFiles: MarkdownDocFile[], exportNames: string[]): string[];
-import { OpenPkg as OpenPkg3, SpecDiff as SpecDiff2 } from "@openpkg-ts/spec";
+import { CategorizedBreaking, OpenPkg as OpenPkg3, SpecDiff as SpecDiff2 } from "@openpkg-ts/spec";
 /**
 * Extended spec diff result with docs impact
 */
@@ -264,6 +270,8 @@ interface SpecDiffWithDocs extends SpecDiff2 {
 	docsImpact?: DocsImpactResult;
 	/** Member-level changes for classes (methods added/removed/changed) */
 	memberChanges?: MemberChange[];
+	/** Breaking changes categorized by severity (high/medium/low) */
+	categorizedBreaking?: CategorizedBreaking[];
 }
 /**
 * Options for diffSpecWithDocs
@@ -756,4 +764,4 @@ declare function readPackageJson(fs: FileSystem, dir: string): Promise<PackageJs
 * ```
 */
 declare function analyzeProject2(fs: FileSystem, options?: AnalyzeProjectOptions): Promise<ProjectInfo>;
-export { serializeJSDoc, safeParseJson, runExamplesWithPackage, runExamples, runExample, readPackageJson, parseMarkdownFiles, parseMarkdownFile, parseJSDocToPatch, parseAssertions, mergeFixes, isFixableDrift, isExecutableLang, hasNonAssertionComments, hasDocsImpact, hasDocsForExport, getUndocumentedExports, getRunCommand, getPrimaryBuildScript, getInstallCommand, getDocumentedExports, getDocsImpactSummary, generateFixesForExport, generateFix, formatPackageList, findRemovedReferences, findPackageByName, findJSDocLocation, findExportReferences, findDeprecatedReferences, extractPackageSpec, extractImports, extractFunctionCalls, diffSpecWithDocs, detectPackageManager, detectMonorepo, detectExampleRuntimeErrors, detectExampleAssertionFailures, detectEntryPoint, detectBuildInfo, createSourceFile, categorizeDrifts, blockReferencesExport, applyPatchToJSDoc, applyEdits, analyzeProject2 as analyzeProject, analyzeFile, analyzeDocsImpact, analyze, WorkspacePackage, SpecDiffWithDocs, SandboxFileSystem, RunExamplesWithPackageResult, RunExamplesWithPackageOptions, RunExampleOptions, ProjectInfo, PackageManagerInfo, PackageManager, PackageJson, PackageExports, OpenPkgSpec, OpenPkgOptions, OpenPkg4 as OpenPkg, NodeFileSystem, MonorepoType, MonorepoInfo, MarkdownDocFile, MarkdownCodeBlock, JSDocTag, JSDocReturn, JSDocPatch, JSDocParam, JSDocEdit, FixType, FixSuggestion, FilterOptions, FileSystem, ExportReference, ExampleRunResult, EntryPointSource, EntryPointInfo, DocsImpactResult, DocsImpactReference, DocsImpact, DocsChangeType, DocCovOptions, DocCov, DiffWithDocsOptions, Diagnostic, BuildInfo, ApplyEditsResult, AnalyzeProjectOptions, AnalyzeOptions, AnalysisResult };
+export { serializeJSDoc, safeParseJson, runExamplesWithPackage, runExamples, runExample, readPackageJson, parseMarkdownFiles, parseMarkdownFile, parseJSDocToPatch, parseAssertions, mergeFixes, isFixableDrift, isExecutableLang, hasNonAssertionComments, hasDocsImpact, hasDocsForExport, getUndocumentedExports, getRunCommand, getPrimaryBuildScript, getInstallCommand, getDocumentedExports, getDocsImpactSummary, generateFixesForExport, generateFix, formatPackageList, findRemovedReferences, findPackageByName, findJSDocLocation, findExportReferences, findDeprecatedReferences, extractPackageSpec, extractImports, extractFunctionCalls, diffSpecWithDocs, detectPackageManager, detectMonorepo, detectExampleRuntimeErrors, detectExampleAssertionFailures, detectEntryPoint, detectBuildInfo, createSourceFile, categorizeDrifts, blockReferencesExport, applyPatchToJSDoc, applyEdits, analyzeProject2 as analyzeProject, analyzeFile, analyzeDocsImpact, analyze, WorkspacePackage, SpecDiffWithDocs, SandboxFileSystem, RunExamplesWithPackageResult, RunExamplesWithPackageOptions, RunExampleOptions, ProjectInfo, PackageManagerInfo, PackageManager, PackageJson, PackageExports, OpenPkgSpec, OpenPkgOptions, OpenPkg4 as OpenPkg, NodeFileSystem, MonorepoType, MonorepoInfo, MemberChange, MarkdownDocFile, MarkdownCodeBlock, JSDocTag, JSDocReturn, JSDocPatch, JSDocParam, JSDocEdit, FixType, FixSuggestion, FilterOptions, FileSystem, ExportReference, ExampleRunResult, EntryPointSource, EntryPointInfo, DocsImpactResult, DocsImpactReference, DocsImpact, DocsChangeType, DocCovOptions, DocCov, DiffWithDocsOptions, Diagnostic, BuildInfo, ApplyEditsResult, AnalyzeProjectOptions, AnalyzeOptions, AnalysisResult };

package/dist/index.js

@@ -1201,8 +1201,11 @@ function blockReferencesExport(block, exportName) {
   return calls.includes(exportName);
 }
 // src/markdown/analyzer.ts
-function getChangeType(exportName, diff) {
+function getChangeType(exportName, diff, newExportNames) {
   if (diff.breaking.includes(exportName)) {
+    if (!newExportNames.includes(exportName)) {
+      return "removed";
+    }
     return "signature-changed";
   }
   return null;
@@ -1284,7 +1287,7 @@ function analyzeDocsImpact(diff, markdownFiles, newExportNames = [], memberChang
       if (exportsWithoutMemberChanges.length > 0) {
         const refs = findExportReferences([{ ...mdFile, codeBlocks: [block] }], exportsWithoutMemberChanges);
         for (const ref of refs) {
-          const changeType = getChangeType(ref.exportName, diff);
+          const changeType = getChangeType(ref.exportName, diff, newExportNames);
           if (!changeType)
             continue;
           const refKey = `${ref.file}:${ref.line}:${ref.exportName}`;
@@ -1301,17 +1304,18 @@ function analyzeDocsImpact(diff, markdownFiles, newExportNames = [], memberChang
       }
     }
   }
-  const documentedExports = new Set;
+  const documentedExportsSet = new Set;
   for (const file of markdownFiles) {
     for (const block of file.codeBlocks) {
       for (const exportName of newExportNames) {
         if (block.code.includes(exportName)) {
-          documentedExports.add(exportName);
+          documentedExportsSet.add(exportName);
         }
       }
     }
   }
-  const missingDocs = diff.nonBreaking.filter((name) => !documentedExports.has(name));
+  const missingDocs = diff.nonBreaking.filter((name) => !documentedExportsSet.has(name));
+  const allUndocumented = newExportNames.filter((name) => !documentedExportsSet.has(name));
   const totalCodeBlocks = markdownFiles.reduce((sum, f) => sum + f.codeBlocks.length, 0);
   const allReferences = findExportReferences(markdownFiles, [...changedExports, ...diff.nonBreaking]);
   let impactedReferences = 0;
@@ -1321,11 +1325,14 @@ function analyzeDocsImpact(diff, markdownFiles, newExportNames = [], memberChang
   return {
     impactedFiles: Array.from(impactByFile.values()),
     missingDocs,
+    allUndocumented,
     stats: {
       filesScanned: markdownFiles.length,
       codeBlocksFound: totalCodeBlocks,
       referencesFound: allReferences.length,
-      impactedReferences
+      impactedReferences,
+      totalExports: newExportNames.length,
+      documentedExports: documentedExportsSet.size
     }
   };
 }
@@ -1405,7 +1412,17 @@ function diffMemberChanges(oldSpec, newSpec, changedClassNames) {
       }
     }
   }
-  return changes;
+  return deduplicateMemberChanges(changes);
+}
+function deduplicateMemberChanges(changes) {
+  const seen = new Set;
+  return changes.filter((mc) => {
+    const key = `${mc.className}:${mc.memberName}:${mc.changeType}`;
+    if (seen.has(key))
+      return false;
+    seen.add(key);
+    return true;
+  });
 }
 function toExportMap(exports) {
   const map = new Map;
@@ -1446,10 +1463,32 @@ function formatSignature(member) {
   const sig = member.signatures[0];
   const params = sig.parameters?.map((p) => {
     const optional = p.required === false ? "?" : "";
-    return `${p.name}${optional}`;
+    const typeName = extractTypeName(p.schema);
+    return typeName ? `${p.name}${optional}: ${typeName}` : `${p.name}${optional}`;
   }) ?? [];
   return `${member.name}(${params.join(", ")})`;
 }
+function extractTypeName(schema) {
+  if (!schema || typeof schema !== "object") {
+    return;
+  }
+  const s = schema;
+  if (typeof s.$ref === "string") {
+    const parts = s.$ref.split("/");
+    return parts[parts.length - 1];
+  }
+  if (typeof s.type === "string") {
+    return s.type;
+  }
+  if (typeof s.tsType === "string") {
+    const tsType = s.tsType;
+    if (tsType.length > 30) {
+      return tsType.slice(0, 27) + "...";
+    }
+    return tsType;
+  }
+  return;
+}
 function hasSignatureChanged(oldMember, newMember) {
   const oldSigs = oldMember.signatures ?? [];
   const newSigs = newMember.signatures ?? [];
@@ -1543,14 +1582,19 @@ function splitCamelCase(str) {
   return str.replace(/([a-z])([A-Z])/g, "$1 $2").toLowerCase().split(" ");
 }
 // src/markdown/diff-with-docs.ts
-import { diffSpec } from "@openpkg-ts/spec";
+import {
+  categorizeBreakingChanges,
+  diffSpec
+} from "@openpkg-ts/spec";
 function diffSpecWithDocs(oldSpec, newSpec, options = {}) {
   const baseDiff = diffSpec(oldSpec, newSpec);
   const memberChanges = diffMemberChanges(oldSpec, newSpec, baseDiff.breaking);
+  const categorizedBreaking = categorizeBreakingChanges(baseDiff.breaking, oldSpec, newSpec, memberChanges);
   if (!options.markdownFiles?.length) {
     return {
       ...baseDiff,
-      memberChanges: memberChanges.length > 0 ? memberChanges : undefined
+      memberChanges: memberChanges.length > 0 ? memberChanges : undefined,
+      categorizedBreaking: categorizedBreaking.length > 0 ? categorizedBreaking : undefined
     };
   }
   const newExportNames = newSpec.exports?.map((e) => e.name) ?? [];
@@ -1558,7 +1602,8 @@ function diffSpecWithDocs(oldSpec, newSpec, options = {}) {
   return {
     ...baseDiff,
     docsImpact,
-    memberChanges: memberChanges.length > 0 ? memberChanges : undefined
+    memberChanges: memberChanges.length > 0 ? memberChanges : undefined,
+    categorizedBreaking: categorizedBreaking.length > 0 ? categorizedBreaking : undefined
   };
 }
 function hasDocsImpact(diff) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@doccov/sdk",
-  "version": "0.5.6",
+  "version": "0.5.7",
   "description": "DocCov SDK - Documentation coverage and drift detection for TypeScript",
   "keywords": [
     "typescript",
@@ -39,7 +39,7 @@
     "dist"
   ],
   "dependencies": {
-    "@openpkg-ts/spec": "^0.3.1",
+    "@openpkg-ts/spec": "^0.4.0",
     "@vercel/sandbox": "^1.0.3",
     "mdast": "^3.0.0",
     "remark-mdx": "^3.1.0",