From 51fb323ddca9372d9de90f02c8da7acf65f03baf Mon Sep 17 00:00:00 2001 From: Timeless0911 <1604889533@qq.com> Date: Mon, 3 Nov 2025 17:24:33 +0800 Subject: [PATCH 1/2] fix: verbose Rslib normalized config only in Rslib debug mode --- packages/core/src/cli/initConfig.ts | 16 ++++++++++++++-- website/docs/en/guide/basic/configure-rslib.mdx | 2 +- website/docs/zh/guide/basic/configure-rslib.mdx | 2 +- 3 files changed, 16 insertions(+), 4 deletions(-) diff --git a/packages/core/src/cli/initConfig.ts b/packages/core/src/cli/initConfig.ts index 11881f905..e05db5e18 100644 --- a/packages/core/src/cli/initConfig.ts +++ b/packages/core/src/cli/initConfig.ts @@ -12,6 +12,15 @@ import { logger } from '../utils/logger'; import type { BuildOptions, CommonOptions } from './commands'; import { onBeforeRestart } from './restart'; +const shouldPrintSerializedRslibConfig = (): boolean => { + if (!process.env.DEBUG) { + return false; + } + + const values = process.env.DEBUG.toLocaleLowerCase().split(','); + return ['rslib'].some((key) => values.includes(key)); +}; + const getEnvDir = (cwd: string, envDir?: string) => { if (envDir) { return path.isAbsolute(envDir) ? envDir : path.resolve(cwd, envDir); @@ -141,8 +150,11 @@ export async function initConfig(options: CommonOptions): Promise<{ applyCliOptions(config, options, root); - logger.debug('Rslib config used to generate Rsbuild environments:'); - logger.debug(`\n${util.inspect(config, { depth: null, colors: true })}`); + // only debug serialized rslib config when DEBUG=rslib + if (shouldPrintSerializedRslibConfig()) { + logger.debug('Rslib config used to generate Rsbuild environments:'); + logger.debug(`\n${util.inspect(config, { depth: null, colors: true })}`); + } return { config, diff --git a/website/docs/en/guide/basic/configure-rslib.mdx b/website/docs/en/guide/basic/configure-rslib.mdx index 03cd8d0a2..34b3cc62a 100644 --- a/website/docs/en/guide/basic/configure-rslib.mdx +++ b/website/docs/en/guide/basic/configure-rslib.mdx @@ -228,5 +228,5 @@ Inspect config succeed, open following files to view the content: - Open the generated `/dist/.rsbuild/rspack.config.esm.mjs` file to see the complete content of the Rspack config. ::: info -If you want to view the normalized Rslib configuration, you need to run [rslib inspect](/guide/basic/cli#rslib-inspect) command. +If you want to view the normalized Rslib configuration, you can add the `DEBUG=rslib` environment variable when building or run the [rslib inspect](/guide/basic/cli#rslib-inspect) command. ::: diff --git a/website/docs/zh/guide/basic/configure-rslib.mdx b/website/docs/zh/guide/basic/configure-rslib.mdx index a4fb6bc3a..6a377af3a 100644 --- a/website/docs/zh/guide/basic/configure-rslib.mdx +++ b/website/docs/zh/guide/basic/configure-rslib.mdx @@ -228,5 +228,5 @@ Inspect config succeed, open following files to view the content: - 打开生成的 `/dist/.rsbuild/rspack.config.esm.mjs` 文件,即可查看 Rspack 配置的完整内容。 ::: info -如果你想查看归一化后的 Rslib 配置,需要运行 [rslib inspect](/guide/basic/cli#rslib-inspect) 命令。 +如果你想查看归一化后的 Rslib 配置,可以在执行构建时添加 `DEBUG=rslib` 环境变量或运行 [rslib inspect](/guide/basic/cli#rslib-inspect) 命令。 ::: From e03c1385e738ed3305e5895c1b24ef116e2dd857 Mon Sep 17 00:00:00 2001 From: Timeless0911 <1604889533@qq.com> Date: Mon, 3 Nov 2025 19:06:36 +0800 Subject: [PATCH 2/2] chore: update --- packages/core/src/cli/initConfig.ts | 13 ++----------- packages/core/src/utils/logger.ts | 10 ++++++---- 2 files changed, 8 insertions(+), 15 deletions(-) diff --git a/packages/core/src/cli/initConfig.ts b/packages/core/src/cli/initConfig.ts index e05db5e18..e21b75e0d 100644 --- a/packages/core/src/cli/initConfig.ts +++ b/packages/core/src/cli/initConfig.ts @@ -8,19 +8,10 @@ import type { RslibConfig, } from '../types'; import { getAbsolutePath } from '../utils/helper'; -import { logger } from '../utils/logger'; +import { isDebugKey, logger } from '../utils/logger'; import type { BuildOptions, CommonOptions } from './commands'; import { onBeforeRestart } from './restart'; -const shouldPrintSerializedRslibConfig = (): boolean => { - if (!process.env.DEBUG) { - return false; - } - - const values = process.env.DEBUG.toLocaleLowerCase().split(','); - return ['rslib'].some((key) => values.includes(key)); -}; - const getEnvDir = (cwd: string, envDir?: string) => { if (envDir) { return path.isAbsolute(envDir) ? envDir : path.resolve(cwd, envDir); @@ -151,7 +142,7 @@ export async function initConfig(options: CommonOptions): Promise<{ applyCliOptions(config, options, root); // only debug serialized rslib config when DEBUG=rslib - if (shouldPrintSerializedRslibConfig()) { + if (isDebugKey(['rslib'])) { logger.debug('Rslib config used to generate Rsbuild environments:'); logger.debug(`\n${util.inspect(config, { depth: null, colors: true })}`); } diff --git a/packages/core/src/utils/logger.ts b/packages/core/src/utils/logger.ts index 5814ffd04..2bb721bbb 100644 --- a/packages/core/src/utils/logger.ts +++ b/packages/core/src/utils/logger.ts @@ -15,15 +15,17 @@ import { type Logger, logger } from 'rslog'; import { color } from './color'; -export const isDebug = (): boolean => { +export const isDebugKey = (keys: string[]): boolean => { if (!process.env.DEBUG) { return false; } const values = process.env.DEBUG.toLocaleLowerCase().split(','); - return ['rslib', 'rsbuild', 'rs*', 'rstack', '*'].some((key) => - values.includes(key), - ); + return keys.some((key) => values.includes(key)); +}; + +export const isDebug = (): boolean => { + return isDebugKey(['rslib', 'rsbuild', 'rs*', 'rstack', '*']); }; // setup the logger level