Function auditPackageDocs

scripts/check-package-docs.mjs:15–47

({ documents, existingPaths, manifests })

};

export function auditPackageDocs({ documents, existingPaths, manifests }) {
  const errors = [];

  for (const [manifestPath, requiredFiles] of Object.entries(packageRequirements)) {
    const publishedFiles = manifests[manifestPath]?.files ?? [];
    for (const requiredFile of requiredFiles) {
      if (!publishedFiles.includes(requiredFile)) {
        errors.push(`${manifestPath} must publish package documentation path ${requiredFile}.`);
      }
    }
  }

  for (const [documentPath, source] of documents) {
    if (/rxjs\.dev|apps\/rxjs\.dev/i.test(source)) {
      errors.push(`${documentPath} must not depend on the separate documentation-site workstream.`);
    }

    for (const target of markdownLinkTargets(source)) {
      if (/^(?:https?:|mailto:|#)/.test(target)) continue;
      if (!target.includes('/') && !/\.[a-z0-9]+(?:#|$)/i.test(target)) continue;
      const [targetPath] = target.split('#');
      if (!targetPath) continue;
      const resolved = path.posix.normalize(path.posix.join(path.posix.dirname(documentPath), decodeURIComponent(targetPath)));
      if (!existingPaths.has(resolved)) errors.push(`${documentPath} has a missing local link: ${target}.`);
      const packageMatch = documentPath.match(/^(packages\/[^/]+)\//);
      if (packageMatch && resolved !== packageMatch[1] && !resolved.startsWith(`${packageMatch[1]}/`)) {
        errors.push(`${documentPath} has a local link outside its package container: ${target}.`);
      }
    }
  }

  return errors;
}

function markdownLinkTargets(source) {
  return [...source.matchAll(/!?\[[^\]]*\]\(([^)]+)\)/g)]