docs(reference): generate reference pages for APIs exposed from subpath exports (#8392)

sapphi-red · sapphi-red · commit d6b4a284caa2 · 2026-02-20T06:07:10.000Z
Updated the reference generation script so that the reference pages for the APIs exposed from subpath exports are generated.
diff --git a/docs/.vitepress/scripts/generate-reference.ts b/docs/.vitepress/scripts/generate-reference.ts
@@ -1,17 +1,36 @@
-import { copyFile, rm } from 'node:fs/promises';
+import { copyFile, readFile, rm } from 'node:fs/promises';
 import path from 'node:path';
 import { Application, type TypeDocOptions } from 'typedoc';
 import type { PluginOptions } from 'typedoc-plugin-markdown';
+
+const root = path.resolve(import.meta.dirname, '../../..');
+
 console.log('📚 Generating reference...');
 
+const exportPaths = await discoverExports();
+const allEntryPoints = exportPaths.map((p) => p.replaceAll('\\', '/'));
+
 // Generate API documentation
-await runTypedoc();
+await runTypedoc(allEntryPoints);
 console.log('✅ Reference generated successfully!');
 
 await rm('reference/index.md', { force: true });
 await copyFile('.vitepress/theme/components/api.index.md', 'reference/index.md');
 console.log('📚 New index added successfully');
 
+async function discoverExports(): Promise<string[]> {
+  const excludedExports = new Set(['./experimental', './parallelPlugin']);
+
+  const pkgJsonPath = path.join(root, 'packages/rolldown/package.json');
+  const pkgJson: { exports: Record<string, { dev?: string }> } = JSON.parse(
+    await readFile(pkgJsonPath, 'utf-8'),
+  );
+  return Object.entries(pkgJson.exports).flatMap(([key, entry]) => {
+    if (excludedExports.has(key) || !entry.dev) return [];
+    return path.join(root, 'packages/rolldown', entry.dev);
+  });
+}
+
 type TypedocVitepressThemeOptions = {
   docsRoot?: string;
   sidebar?: any;
@@ -20,20 +39,19 @@ type TypedocVitepressThemeOptions = {
 /**
  * Run TypeDoc with the specified tsconfig
  */
-async function runTypedoc(): Promise<void> {
-  const root = path.resolve(import.meta.dirname, '../../..');
-
+async function runTypedoc(entryPoints: string[]): Promise<void> {
   const options: TypeDocOptions & PluginOptions & TypedocVitepressThemeOptions = {
     tsconfig: path.join(root, 'packages/rolldown/tsconfig.json'),
     plugin: [
       'typedoc-plugin-markdown',
       'typedoc-vitepress-theme',
+      'typedoc-plugin-merge-modules',
       path.join(import.meta.dirname, 'extract-options-plugin.ts'),
       path.join(import.meta.dirname, 'custom-theme-plugin.ts'),
     ],
     theme: 'customTheme',
     out: './reference',
-    entryPoints: [path.join(root, 'packages/rolldown/src/index.ts').replaceAll('\\', '/')],
+    entryPoints,
     readme: 'none',
     excludeInternal: true,
 
diff --git a/docs/package.json b/docs/package.json
@@ -18,6 +18,7 @@
     "oxc-minify": "catalog:",
     "typedoc": "^0.28.14",
     "typedoc-plugin-markdown": "^4.9.0",
+    "typedoc-plugin-merge-modules": "^7.0.0",
     "typedoc-vitepress-theme": "^1.1.2",
     "vitepress": "catalog:",
     "vitepress-plugin-group-icons": "catalog:",
diff --git a/knip.jsonc b/knip.jsonc
@@ -29,7 +29,7 @@
         ".vitepress/scripts/extract-options-plugin.ts", // used as a string path in TypeDoc plugin config
         ".vitepress/scripts/custom-theme-plugin.ts", // used as a string path in TypeDoc plugin config
       ],
-      "ignoreDependencies": ["typedoc-vitepress-theme"],
+      "ignoreDependencies": ["typedoc-plugin-merge-modules", "typedoc-vitepress-theme"],
     },
     "packages/bench": {
       "entry": ["vue-entry.js"],
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
