docspack 0.3.0 → 0.4.0

package/src/verify.ts

@@ -196,8 +196,12 @@ async function verifyPackage(
 ): Promise<VerifiedPackage> {
   const empty = { id, checked: 0, matched: 0, unrecognised: 0, findings: [] };
 
-  const declaredLibraries = await documentedLibraries(packageDir, manifest);
-  if (declaredLibraries.length === 0) {
+  const packageLibraries = await documentedLibraries(packageDir, manifest);
+  // A chunk may name its own libraries, which is how a monorepo says that one chunk describes
+  // `@acme/api@1.2.0` and its neighbour describes `@acme/cli@3.0.0`. Those are what that chunk
+  // is checked against; the package's list covers every chunk that names none.
+  const scopes = manifest.chunks.map((chunk) => chunk.documents ?? packageLibraries);
+  if (packageLibraries.length === 0 && scopes.every((scope) => scope.length === 0)) {
     return {
       ...empty,
       status: "skipped",
@@ -205,39 +209,52 @@ async function verifyPackage(
     };
   }
 
-  const documents = declaredLibraries.map(formatDocumentedLibrary);
-  // An entity is fine if any documented library declares it: a monorepo documents eighteen
-  // packages from one surface, and a name belongs to whichever of them exports it.
-  const names = new Set<string>();
-  const missing: string[] = [];
-  for (const library of declaredLibraries) {
+  const documents = [
+    ...new Set([...packageLibraries, ...scopes.flat()].map(formatDocumentedLibrary)),
+  ];
+
+  // One resolution per library, however many chunks name it: reading a type surface is the
+  // expensive part, and a monorepo pack names the same eighteen libraries throughout.
+  const surfaces = new Map<string, ReadonlySet<string>>();
+  const resolve = async (library: DocumentedLibrary): Promise<ReadonlySet<string>> => {
+    const cached = surfaces.get(library.name);
+    if (cached !== undefined) return cached;
+
     const libraryDir =
       (await resolvePackageDir(library.name, packageDir)) ??
       (await resolvePackageDir(library.name, cwd));
     const surface = libraryDir === undefined ? undefined : await readExportSurface(libraryDir);
-    if (surface === undefined || surface.names.size === 0) {
-      missing.push(library.name);
-      continue;
-    }
-    for (const name of surface.names) names.add(name);
-  }
-
-  if (names.size === 0) {
-    return {
-      ...empty,
-      status: "skipped",
-      documents,
-      reason: `${missing.join(", ")} ${missing.length === 1 ? "is" : "are"} not installed, or ship no type declarations`,
-    };
-  }
+    const names = surface?.names ?? new Set<string>();
+    surfaces.set(library.name, names);
+    return names;
+  };
 
-  const declared = new Set([...names].map(normalize));
   const findings: DriftFinding[] = [];
+  const missing = new Set<string>();
   let checked = 0;
   let matched = 0;
   let unrecognised = 0;
+  let readAny = false;
+
+  for (const [index, chunk] of manifest.chunks.entries()) {
+    const scope = scopes[index] ?? packageLibraries;
+    if (scope.length === 0) continue;
+
+    // An entity is fine if any library in scope declares it: a monorepo documents eighteen
+    // packages from one surface, and a name belongs to whichever of them exports it.
+    const names = new Set<string>();
+    for (const library of scope) {
+      const surface = await resolve(library);
+      if (surface.size === 0) {
+        missing.add(library.name);
+        continue;
+      }
+      for (const name of surface) names.add(name);
+    }
+    if (names.size === 0) continue;
+    readAny = true;
 
-  for (const chunk of manifest.chunks) {
+    const declared = new Set([...names].map(normalize));
     for (const entity of chunk.entities) {
       const symbol = checkableSymbol(entity);
       if (symbol === undefined) continue;
@@ -266,11 +283,24 @@ async function verifyPackage(
     }
   }
 
+  if (!readAny) {
+    const unread = [...missing];
+    return {
+      ...empty,
+      status: "skipped",
+      documents,
+      reason:
+        unread.length === 0
+          ? "has no chunk naming a library to check against"
+          : `${unread.join(", ")} ${unread.length === 1 ? "is" : "are"} not installed, or ship no type declarations`,
+    };
+  }
+
   return {
     id,
     status: "verified",
     documents,
-    ...(missing.length === 0 ? {} : { unchecked: missing }),
+    ...(missing.size === 0 ? {} : { unchecked: [...missing] }),
     checked,
     matched,
     unrecognised,