fix: add pluginEmitRouteFile in uni-builder

packages/builder/uni-builder/package.json

@@ -30,6 +30,7 @@
     "@babel/core": "^7.23.2",
     "@babel/preset-react": "^7.22.15",
     "@babel/types": "^7.23.0",
+    "@modern-js/utils": "workspace:*",
     "@modern-js/server": "workspace:*",
     "@modern-js/prod-server": "workspace:*",
     "@pmmmwh/react-refresh-webpack-plugin": "0.5.10",

packages/builder/uni-builder/src/shared/parseCommonConfig.ts

@@ -36,6 +36,7 @@ import { pluginCheckSyntax } from '@rsbuild/plugin-check-syntax';
 import { pluginCssMinimizer } from '@rsbuild/plugin-css-minimizer';
 import { pluginPostcssLegacy } from './plugins/postcssLegacy';
 import { pluginDevtool } from './plugins/devtools';
+import { pluginEmitRouteFile } from './plugins/emitRouteFile';
 
 const GLOBAL_CSS_REGEX = /\.global\.\w+$/;
 
@@ -237,6 +238,7 @@ export async function parseCommonConfig<B = 'rspack' | 'webpack'>(
     pluginDevtool({
       disableSourceMap: uniBuilderConfig.output?.disableSourceMap,
     }),
+    pluginEmitRouteFile(),
   ];
 
   const checkSyntaxOptions = uniBuilderConfig.security?.checkSyntax;

packages/builder/uni-builder/src/shared/plugins/emitRouteFile.ts

@@ -0,0 +1,34 @@
+import { join } from 'path';
+import { type RsbuildPlugin, isFileExists } from '@rsbuild/shared';
+
+/**
+ * generate a basic route.json for modern.js server
+ */
+export const pluginEmitRouteFile = (): RsbuildPlugin => ({
+  name: 'uni-builder:emit-route-file',
+
+  setup(api) {
+    api.onBeforeStartDevServer(async () => {
+      const { fs, ROUTE_SPEC_FILE } = await import('@modern-js/utils');
+      const routeFilePath = join(api.context.distPath, ROUTE_SPEC_FILE);
+      const htmlPaths = api.getHTMLPaths();
+
+      const routesInfo = Object.entries(htmlPaths).map(
+        ([entryName, filename], index) => ({
+          urlPath: index === 0 ? '/' : `/${entryName}`,
+          entryName,
+          entryPath: filename,
+          isSPA: true,
+        }),
+      );
+
+      // if the framework has already generate a route.json, do nothing
+      if (!(await isFileExists(routeFilePath)) && routesInfo.length) {
+        await fs.outputFile(
+          routeFilePath,
+          JSON.stringify({ routes: routesInfo }, null, 2),
+        );
+      }
+    });
+  },
+});

tests/e2e/builder/scripts/shared.ts

@@ -8,7 +8,6 @@ import type {
   BuilderConfig as UniBuilderConfig,
   CreateUniBuilderOptions,
   StartDevServerOptions,
-  RsbuildPlugin,
 } from '@modern-js/uni-builder';
 
 type CreateBuilderOptions = Omit<
@@ -142,33 +141,6 @@ const updateConfigForTest = <BuilderType>(
   }
 };
 
-// generate a basic route.json for test (modern.js server required)
-const pluginEmitRoute = (): RsbuildPlugin => ({
-  name: 'plugin-emit-route',
-
-  setup(api) {
-    api.onBeforeStartDevServer(async () => {
-      const { fs, ROUTE_SPEC_FILE } = await import('@modern-js/utils');
-      const routeFilePath = join(api.context.distPath, ROUTE_SPEC_FILE);
-      const htmlPaths = api.getHTMLPaths();
-
-      const routesInfo = Object.entries(htmlPaths).map(
-        ([entryName, filename], index) => ({
-          urlPath: index === 0 ? '/' : `/${entryName}`,
-          entryName,
-          entryPath: filename,
-          isSPA: true,
-        }),
-      );
-
-      await fs.outputFile(
-        routeFilePath,
-        JSON.stringify({ routes: routesInfo }, null, 2),
-      );
-    });
-  },
-});
-
 export async function dev<BuilderType = 'webpack'>({
   serverOptions,
   builderConfig = {},
@@ -185,7 +157,6 @@ export async function dev<BuilderType = 'webpack'>({
 
   const builder = await createUniBuilder(options, builderConfig);
 
-  builder.addPlugins([pluginEmitRoute()]);
   return builder.startDevServer({
     serverOptions,
   });