feat(doc-core): add routes for addPages hook (#3753)

* feat: add routes for `addPages` hook

* chore: changeset

Author: sanyuan0704

.changeset/gorgeous-suns-return.md

@@ -0,0 +1,7 @@
+---
+'@modern-js/doc-core': patch
+---
+
+feat(doc-core): add routes for addPages hook
+
+feat(doc-core): 在 addPages 钩子中增加路由入参

packages/cli/doc-core/src/node/PluginDriver.ts

@@ -0,0 +1,129 @@
+import { UserConfig, PageIndexInfo, DocPlugin, RouteMeta } from 'shared/types';
+
+export class PluginDriver {
+  #config: UserConfig;
+
+  #plugins: DocPlugin[];
+
+  #isProd: boolean;
+
+  constructor(config: UserConfig, isProd: boolean) {
+    this.#config = config;
+    this.#isProd = isProd;
+  }
+
+  // The init function is used to initialize the doc plugins and will execute before the build process.
+  async init() {
+    // Clear docPlugins first, for the watch mode
+    this.clearPlugins();
+    const config = this.#config;
+    const enableLastUpdated =
+      config.doc.themeConfig?.lastUpdated ||
+      config.doc.themeConfig?.locales?.some(locale => locale.lastUpdated);
+    const mediumZoomConfig = config.doc.mediumZoom ?? true;
+    if (enableLastUpdated) {
+      const { pluginLastUpdated } = await import('./plugins/lastUpdated');
+      this.addPlugin(pluginLastUpdated());
+    }
+    if (mediumZoomConfig) {
+      const { pluginMediumZoom } = await import(
+        '@modern-js/doc-plugin-medium-zoom'
+      );
+      this.addPlugin(
+        pluginMediumZoom(
+          typeof mediumZoomConfig === 'object' ? mediumZoomConfig : undefined,
+        ),
+      );
+    }
+    (config.doc.plugins || []).forEach(plugin => {
+      this.addPlugin(plugin);
+    });
+  }
+
+  addPlugin(plugin: DocPlugin) {
+    const exsitedIndex = this.#plugins.findIndex(
+      item => item.name === plugin.name,
+    );
+    // Avoid the duplicated plugin
+    if (exsitedIndex !== -1) {
+      throw new Error(`The plugin "${plugin.name}" has been registered`);
+    } else {
+      this.#plugins.push(plugin);
+    }
+  }
+
+  clearPlugins() {
+    this.#plugins = [];
+  }
+
+  async modifyConfig() {
+    let config = this.#config.doc;
+
+    for (const plugin of this.#plugins) {
+      if (typeof plugin.config === 'function') {
+        config = await plugin.config(config || {});
+      }
+    }
+    this.#config.doc = config;
+    return this.#config;
+  }
+
+  async beforeBuild() {
+    return await Promise.all(
+      this.#plugins
+        .filter(plugin => typeof plugin.beforeBuild === 'function')
+        .map(plugin => {
+          return plugin.beforeBuild(this.#config.doc || {}, this.#isProd);
+        }),
+    );
+  }
+
+  async afterBuild() {
+    return await Promise.all(
+      this.#plugins
+        .filter(plugin => typeof plugin.afterBuild === 'function')
+        .map(plugin => {
+          return plugin.afterBuild(this.#config.doc || {}, this.#isProd);
+        }),
+    );
+  }
+
+  async extendPageData(pageData: PageIndexInfo) {
+    await Promise.all(
+      this.#plugins
+        .filter(plugin => typeof plugin.extendPageData === 'function')
+        .map(plugin => {
+          return plugin.extendPageData(pageData);
+        }),
+    );
+  }
+
+  async addPages(routes: RouteMeta[]) {
+    // addPages hooks
+    const result = await Promise.all(
+      this.#plugins
+        .filter(plugin => typeof plugin.addPages === 'function')
+        .map(plugin => {
+          return plugin.addPages(this.#config.doc || {}, this.#isProd, routes);
+        }),
+    );
+
+    return result.flat();
+  }
+
+  globalUIComponents(): string[] {
+    const result = this.#plugins.map(plugin => {
+      return plugin.globalUIComponents || [];
+    });
+
+    return result.flat();
+  }
+
+  globalStyles(): string[] {
+    return this.#plugins
+      .filter(plugin => typeof plugin.globalStyles === 'string')
+      .map(plugin => {
+        return plugin.globalStyles;
+      });
+  }
+}

packages/cli/doc-core/src/node/build.ts

@@ -12,8 +12,8 @@ import {
 } from './constants';
 import { createModernBuilder } from './createBuilder';
 import { writeSearchIndex } from './searchIndex';
-import { modifyConfig, beforeBuild, afterBuild, loadPlugins } from './hooks';
 import { logger } from './utils';
+import { PluginDriver } from './PluginDriver';
 import { APPEARANCE_KEY, normalizeSlash } from '@/shared/utils';
 import type { Route } from '@/node/route/RouteService';
 
@@ -30,11 +30,15 @@ const CHECK_DARK_LIGHT_SCRIPT = `
 </script>
 `;
 
-export async function bundle(rootDir: string, config: UserConfig) {
+export async function bundle(
+  rootDir: string,
+  config: UserConfig,
+  pluginDriver: PluginDriver,
+) {
   try {
     const [clientBuilder, ssrBuilder] = await Promise.all([
-      createModernBuilder(rootDir, config, false),
-      createModernBuilder(rootDir, config, true, {
+      createModernBuilder(rootDir, config, pluginDriver, false),
+      createModernBuilder(rootDir, config, pluginDriver, true, {
         output: {
           distPath: {
             root: `${config.doc?.outDir ?? OUTPUT_DIR}/ssr`,
@@ -136,21 +140,11 @@ export async function renderPages(config: UserConfig) {
 }
 
 export async function build(rootDir: string, config: UserConfig) {
-  const isProd = true;
-  await loadPlugins(config);
-
-  const modifiedConfig = await modifyConfig({
-    config,
-  });
-
-  await beforeBuild({
-    config: modifiedConfig,
-    isProd,
-  });
-  await bundle(rootDir, modifiedConfig);
+  const pluginDriver = new PluginDriver(config, true);
+  await pluginDriver.init();
+  const modifiedConfig = await pluginDriver.modifyConfig();
+  await pluginDriver.beforeBuild();
+  await bundle(rootDir, modifiedConfig, pluginDriver);
   await renderPages(modifiedConfig);
-  await afterBuild({
-    config: modifiedConfig,
-    isProd,
-  });
+  await pluginDriver.afterBuild();
 }

packages/cli/doc-core/src/node/createBuilder.ts

@@ -23,6 +23,8 @@ import { builderDocVMPlugin, runtimeModuleIDs } from './runtimeModule';
 import { serveSearchIndexMiddleware } from './searchIndex';
 import { checkLinks } from './mdx/remarkPlugins/checkDeadLink';
 import { detectReactVersion, resolveReactAlias } from './utils';
+import { initRouteService } from './route/init';
+import { PluginDriver } from './PluginDriver';
 
 const require = createRequire(import.meta.url);
 
@@ -184,6 +186,7 @@ async function createInternalBuildConfig(
 export async function createModernBuilder(
   rootDir: string,
   config: UserConfig,
+  pluginDriver: PluginDriver,
   isSSR = false,
   extraBuilderConfig?: BuilderConfig,
 ): Promise<BuilderInstance<BuilderRspackProvider>> {
@@ -194,9 +197,13 @@ export async function createModernBuilder(
     TEMP_DIR,
     isSSR ? 'ssr-runtime' : 'client-runtime',
   );
-
   await fs.ensureDir(runtimeTempDir);
-
+  const routeService = await initRouteService({
+    config,
+    runtimeTempDir,
+    scanDir: userRoot,
+    pluginDriver,
+  });
   const { createBuilder } = await import('@modern-js/builder');
   const { builderRspackProvider } = await import(
     '@modern-js/builder-rspack-provider'
@@ -226,7 +233,14 @@ export async function createModernBuilder(
   });
 
   builder.addPlugins([
-    builderDocVMPlugin(userRoot, config, isSSR, runtimeTempDir),
+    builderDocVMPlugin({
+      userRoot,
+      config,
+      isSSR,
+      runtimeTempDir,
+      routeService,
+      pluginDriver,
+    }),
   ]);
 
   return builder;

packages/cli/doc-core/src/node/dev.ts

@@ -2,7 +2,7 @@ import { UserConfig } from 'shared/types';
 import { removeLeadingSlash } from '../shared/utils';
 import { createModernBuilder } from './createBuilder';
 import { writeSearchIndex } from './searchIndex';
-import { modifyConfig, beforeBuild, afterBuild, loadPlugins } from './hooks';
+import { PluginDriver } from './PluginDriver';
 
 interface ServerInstance {
   close: () => Promise<void>;
@@ -14,16 +14,19 @@ export async function dev(
 ): Promise<ServerInstance> {
   const base = config.doc?.base ?? '';
   const isProd = false;
-  await loadPlugins(config);
+  const pluginDriver = new PluginDriver(config, isProd);
+  await pluginDriver.init();
+
   try {
-    const modifiedConfig = await modifyConfig({
-      config,
-    });
-    await beforeBuild({
-      config: modifiedConfig,
-      isProd,
-    });
-    const builder = await createModernBuilder(rootDir, modifiedConfig);
+    const modifiedConfig = await pluginDriver.modifyConfig();
+    await pluginDriver.beforeBuild();
+    const builder = await createModernBuilder(
+      rootDir,
+      modifiedConfig,
+      pluginDriver,
+      false,
+      {},
+    );
     const { server } = await builder.startDevServer({
       printURLs: urls => {
         return urls.map(({ label, url }) => ({
@@ -33,10 +36,7 @@ export async function dev(
       },
     });
 
-    await afterBuild({
-      config: modifiedConfig,
-      isProd,
-    });
+    await pluginDriver.afterBuild();
     return server;
   } finally {
     await writeSearchIndex(config);