Function checkPackageDocs

scripts/check-package-docs.mjs:56–82

(root = repositoryRoot)

}

export async function checkPackageDocs(root = repositoryRoot) {
  const documentPaths = [
    'README.md',
    'packages/rxjs/README.md',
    'packages/rxjs/MIGRATION.md',
    'packages/rxjs/CONTRIBUTING.md',
    ...(await markdownFiles(root, 'packages/rxjs/docs')),
    'packages/observable-polyfill/README.md',
    'packages/observable-polyfill/test/wpt/README.md',
    'packages/test/README.md',
    'packages/migrate/README.md',
    ...(await markdownFiles(root, 'packages/migrate/docs')),
    ...(await markdownFiles(root, 'packages/migrate/skill')),
  ];
  const documents = await Promise.all(
    documentPaths.map(async (documentPath) => [documentPath, await readFile(path.join(root, documentPath), 'utf8')])
  );
  const manifestEntries = await Promise.all(
    Object.keys(packageRequirements).map(async (manifestPath) => [
      manifestPath,
      JSON.parse(await readFile(path.join(root, manifestPath), 'utf8')),
    ])
  );
  const existingPaths = new Set(await allPaths(root));
  const errors = auditPackageDocs({ documents, existingPaths, manifests: Object.fromEntries(manifestEntries) });
  if (errors.length > 0) throw new Error(`Package documentation check failed:\n- ${errors.join('\n- ')}`);
}

async function markdownFiles(root, relativeDirectory) {
  const entries = await readdir(path.join(root, relativeDirectory), { withFileTypes: true });