refactor: migrate inspectConfig functionality to a dedicated file (#5265)

Author: chenjiahan

packages/compat/webpack/src/initConfigs.ts

@@ -6,7 +6,6 @@ import {
   type RsbuildProviderHelpers,
   logger,
 } from '@rsbuild/core';
-import { inspectConfig } from './inspectConfig.js';
 import type { WebpackConfig } from './types.js';
 import { generateWebpackConfig } from './webpackConfig.js';
 
@@ -48,13 +47,13 @@ export async function initConfigs({
         verbose: true,
         writeToDisk: true,
       };
-      await inspectConfig({
+      await helpers.inspectConfig<'webpack'>({
         context,
+        bundler: 'webpack',
         pluginManager,
         inspectOptions,
         rsbuildOptions,
         bundlerConfigs: webpackConfigs,
-        helpers,
       });
     };
 

packages/compat/webpack/src/inspectConfig.ts

@@ -2,7 +2,6 @@ import type { CreateCompiler, RsbuildProvider } from '@rsbuild/core';
 import { build } from './build.js';
 import { createCompiler as baseCreateCompiler } from './createCompiler.js';
 import { initConfigs } from './initConfigs.js';
-import { inspectConfig } from './inspectConfig.js';
 import { pluginAdaptor } from './plugin.js';
 
 export const webpackProvider: RsbuildProvider<'webpack'> = async ({
@@ -88,12 +87,22 @@ export const webpackProvider: RsbuildProvider<'webpack'> = async ({
     },
 
     async inspectConfig(inspectOptions) {
-      return await inspectConfig({
+      const bundlerConfigs = (
+        await initConfigs({
+          context,
+          pluginManager,
+          rsbuildOptions,
+          helpers,
+        })
+      ).webpackConfigs;
+
+      return await helpers.inspectConfig<'webpack'>({
         context,
         pluginManager,
+        bundler: 'webpack',
+        bundlerConfigs,
         rsbuildOptions,
         inspectOptions,
-        helpers,
       });
     },
   };

packages/compat/webpack/src/provider.ts

@@ -2,7 +2,6 @@ import fs from 'node:fs';
 import { createRequire } from 'node:module';
 import { dirname, isAbsolute, join } from 'node:path';
 import { pathToFileURL } from 'node:url';
-import RspackChain from '../compiled/rspack-chain';
 import {
   ASSETS_DIST_DIR,
   CSS_DIST_DIR,
@@ -28,16 +27,12 @@ import {
   getNodeEnv,
   isFileExists,
   isObject,
-  upperFirst,
 } from './helpers';
 import { logger } from './logger';
 import { mergeRsbuildConfig } from './mergeConfig';
 import type {
-  InspectConfigOptions,
-  InspectConfigResult,
   NormalizedConfig,
   NormalizedDevConfig,
-  NormalizedEnvironmentConfig,
   NormalizedHtmlConfig,
   NormalizedOutputConfig,
   NormalizedPerformanceConfig,
@@ -46,13 +41,11 @@ import type {
   NormalizedServerConfig,
   NormalizedSourceConfig,
   NormalizedToolsConfig,
-  PluginManager,
   PublicDir,
   PublicDirOptions,
   RsbuildConfig,
   RsbuildEntry,
   RsbuildMode,
-  RsbuildPlugin,
 } from './types';
 
 const require = createRequire(import.meta.url);
@@ -532,160 +525,6 @@ export async function loadConfig({
   };
 }
 
-const normalizePluginObject = (plugin: RsbuildPlugin): RsbuildPlugin => {
-  const { setup: _, ...rest } = plugin;
-  return {
-    ...rest,
-    // use empty `setup` function as it's not meaningful in inspect config
-    setup() {},
-  };
-};
-
-export const getRsbuildInspectConfig = ({
-  normalizedConfig,
-  inspectOptions,
-  pluginManager,
-}: {
-  normalizedConfig: NormalizedConfig;
-  inspectOptions: InspectConfigOptions;
-  pluginManager: PluginManager;
-}): {
-  rawRsbuildConfig: string;
-  rsbuildConfig: InspectConfigResult['origin']['rsbuildConfig'];
-  rawEnvironmentConfigs: Array<{
-    name: string;
-    content: string;
-  }>;
-  environmentConfigs: InspectConfigResult['origin']['environmentConfigs'];
-} => {
-  const { environments, ...rsbuildConfig } = normalizedConfig;
-
-  const debugConfig: Omit<NormalizedConfig, 'environments'> = {
-    ...rsbuildConfig,
-    plugins: pluginManager.getPlugins().map(normalizePluginObject),
-  };
-
-  const rawRsbuildConfig = stringifyConfig(debugConfig, inspectOptions.verbose);
-  const environmentConfigs: Record<string, NormalizedEnvironmentConfig> = {};
-
-  const rawEnvironmentConfigs: Array<{
-    name: string;
-    content: string;
-  }> = [];
-
-  for (const [name, config] of Object.entries(environments)) {
-    const debugConfig = {
-      ...config,
-      plugins: pluginManager
-        .getPlugins({ environment: name })
-        .map(normalizePluginObject),
-    };
-    rawEnvironmentConfigs.push({
-      name,
-      content: stringifyConfig(debugConfig, inspectOptions.verbose),
-    });
-    environmentConfigs[name] = debugConfig;
-  }
-
-  return {
-    rsbuildConfig,
-    rawRsbuildConfig,
-    environmentConfigs: environments,
-    rawEnvironmentConfigs,
-  };
-};
-
-export async function outputInspectConfigFiles({
-  rawBundlerConfigs,
-  rawEnvironmentConfigs,
-  inspectOptions,
-  configType,
-}: {
-  configType: string;
-  rawEnvironmentConfigs: Array<{
-    name: string;
-    content: string;
-  }>;
-  rawBundlerConfigs: Array<{
-    name: string;
-    content: string;
-  }>;
-  inspectOptions: InspectConfigOptions & {
-    outputPath: string;
-  };
-}): Promise<void> {
-  const { outputPath } = inspectOptions;
-
-  const files = [
-    ...rawEnvironmentConfigs.map(({ name, content }) => {
-      if (rawEnvironmentConfigs.length === 1) {
-        const outputFile = 'rsbuild.config.mjs';
-        const outputFilePath = join(outputPath, outputFile);
-
-        return {
-          path: outputFilePath,
-          label: 'Rsbuild config',
-          content,
-        };
-      }
-      const outputFile = `rsbuild.config.${name}.mjs`;
-      const outputFilePath = join(outputPath, outputFile);
-
-      return {
-        path: outputFilePath,
-        label: `Rsbuild config (${name})`,
-        content,
-      };
-    }),
-    ...rawBundlerConfigs.map(({ name, content }) => {
-      const outputFile = `${configType}.config.${name}.mjs`;
-      let outputFilePath = join(outputPath, outputFile);
-
-      // if filename is conflict, add a random id to the filename.
-      if (fs.existsSync(outputFilePath)) {
-        outputFilePath = outputFilePath.replace(/\.mjs$/, `.${Date.now()}.mjs`);
-      }
-
-      return {
-        path: outputFilePath,
-        label: `${upperFirst(configType)} Config (${name})`,
-        content,
-      };
-    }),
-  ];
-
-  await fs.promises.mkdir(outputPath, { recursive: true });
-
-  await Promise.all(
-    files.map(async (item) => {
-      return fs.promises.writeFile(item.path, `export default ${item.content}`);
-    }),
-  );
-
-  const fileInfos = files
-    .map(
-      (item) =>
-        `  - ${color.bold(color.yellow(item.label))}: ${color.underline(
-          item.path,
-        )}`,
-    )
-    .join('\n');
-
-  logger.success(
-    `config inspection completed, generated files: \n\n${fileInfos}\n`,
-  );
-}
-
-export function stringifyConfig(config: unknown, verbose?: boolean): string {
-  // webpackChain.toString can be used as a common stringify method
-  const stringify = RspackChain.toString as (
-    config: unknown,
-    options: { verbose?: boolean },
-  ) => string;
-
-  return stringify(config, { verbose });
-}
-
 export const normalizePublicDirs = (
   publicDir?: PublicDir,
 ): Required<PublicDirOptions>[] => {

packages/core/src/config.ts

@@ -98,13 +98,12 @@ export async function updateEnvironmentContext(
   context.environments ||= {};
 
   for (const [index, [name, config]] of Object.entries(configs).entries()) {
-    const { tsconfigPath } = config.source;
     const browserslist = await getBrowserslistByEnvironment(
       context.rootPath,
       config,
     );
 
-    const entry = config.source.entry ?? {};
+    const { entry = {}, tsconfigPath } = config.source;
     const htmlPaths = getEnvironmentHTMLPaths(entry, config);
 
     const environmentContext: EnvironmentContext = {