refactor(virtual-module): i18n.json restart -> reload/hmr (#2019)

Author: SoonIter

e2e/fixtures/i18n/doc/zh/_meta.json

@@ -1,7 +1,7 @@
 [
   {
     "text": "Guide",
-    "link": "/guide/"
+    "link": "/guide/basic/install"
   },
   {
     "text": "Api",

packages/cli/src/index.ts

@@ -9,7 +9,7 @@ import { version } from '../package.json';
 import { loadConfigFile, resolveDocRoot } from './config/loadConfigFile';
 import update from './update';
 
-const CONFIG_FILES = ['rspress.config.ts', 'rspress.config.js', 'i18n.json'];
+const CONFIG_FILES = ['rspress.config.ts', 'rspress.config.js'];
 
 const META_FILE = '_meta.json';
 

packages/core/package.json

@@ -104,6 +104,7 @@
     "remark-rehype": "^11.1.1",
     "remark-stringify": "^11.0.0",
     "rimraf": "^6.0.1",
+    "rsbuild-plugin-virtual-module": "0.1.1",
     "tailwindcss": "^3.4.17",
     "typescript": "^5.8.2",
     "vfile": "^5.3.7"

packages/core/src/node/initRsbuild.ts

@@ -14,6 +14,7 @@ import {
   removeLeadingSlash,
   removeTrailingSlash,
 } from '@rspress/shared';
+import { pluginVirtualModule } from 'rsbuild-plugin-virtual-module';
 import type { PluginDriver } from './PluginDriver';
 import {
   CLIENT_ENTRY,
@@ -28,7 +29,8 @@ import {
 import { hintThemeBreakingChange } from './logger/hint';
 import type { RouteService } from './route/RouteService';
 import { initRouteService } from './route/init';
-import { rsbuildPluginDocVM } from './runtimeModule';
+import { type FactoryContext, rsbuildPluginDocVM } from './runtimeModule';
+import { i18nVMPlugin } from './runtimeModule/i18n';
 import { serveSearchIndexMiddleware } from './searchIndex';
 import { detectReactVersion, resolveReactAlias } from './utils';
 import { detectCustomIcon } from './utils/detectCustomIcon';
@@ -95,15 +97,21 @@ async function createInternalBuildConfig(
       enableSSG ? resolveReactAlias(reactVersion, true) : Promise.resolve({}),
     ]);
 
+  const context: Omit<FactoryContext, 'isSSR' | 'alias'> = {
+    userDocRoot,
+    config,
+    runtimeTempDir,
+    routeService,
+    pluginDriver,
+  };
   return {
     plugins: [
       ...(isPluginIncluded(config, PLUGIN_REACT_NAME) ? [] : [pluginReact()]),
-      rsbuildPluginDocVM({
-        userDocRoot,
-        config,
-        runtimeTempDir,
-        routeService,
-        pluginDriver,
+      rsbuildPluginDocVM(context),
+      pluginVirtualModule({
+        virtualModules: {
+          ...i18nVMPlugin(context),
+        },
       }),
     ],
     server: {

packages/core/src/node/runtimeModule/i18n.ts

@@ -1,4 +1,5 @@
 import { join } from 'node:path';
+import type { TransformHandler } from '@rsbuild/core';
 import type { UserConfig } from '@rspress/shared';
 import { logger } from '@rspress/shared/logger';
 import { type FactoryContext, RuntimeModuleID } from '.';
@@ -19,10 +20,20 @@ export function getI18nData(docConfig: UserConfig) {
   }
 }
 
-export function i18nVMPlugin(context: FactoryContext) {
+/**
+ * Generate i18n text for client runtime
+ */
+export function i18nVMPlugin(
+  context: Omit<FactoryContext, 'isSSR' | 'alias'>,
+): Record<string, TransformHandler> {
   const { config } = context;
-  const i18nData = getI18nData(config);
   return {
-    [RuntimeModuleID.I18nText]: `export default ${JSON.stringify(i18nData, null, 2)}`,
+    [RuntimeModuleID.I18nText]: ({ addDependency, addMissingDependency }) => {
+      addDependency(config.i18nSourcePath || DEFAULT_I18N_SOURCE);
+      addMissingDependency(config.i18nSourcePath || DEFAULT_I18N_SOURCE);
+      const i18nData = getI18nData(config);
+
+      return `export default ${JSON.stringify(i18nData, null, 2)}`;
+    },
   };
 }

packages/core/src/node/runtimeModule/index.ts

@@ -5,7 +5,6 @@ import type { PluginDriver } from '../PluginDriver';
 import type { RouteService } from '../route/RouteService';
 import { globalStylesVMPlugin } from './globalStyles';
 import { globalUIComponentsVMPlugin } from './globalUIComponents';
-import { i18nVMPlugin } from './i18n';
 import { routeVMPlugin } from './routeData';
 import { searchHookVMPlugin } from './searchHooks';
 import { siteDataVMPlugin } from './siteData/index';
@@ -42,10 +41,6 @@ export const runtimeModuleFactory: RuntimeModuleFactory[] = [
    * Generate global styles from config and plugins
    */
   globalStylesVMPlugin,
-  /**
-   * Generate i18n text for client runtime
-   */
-  i18nVMPlugin,
   /**
    * Generate search hook module
    */