feat(CLI): support logLevel (#1238)

Author: Timeless0911

.vscode/settings.json

@@ -57,11 +57,11 @@
   "json.schemas": [
     {
       "fileMatch": ["**/_meta.json"],
-      "url": "./website/node_modules/rspress/meta-json-schema.json"
+      "url": "./website/node_modules/@rspress/core/meta-json-schema.json"
     },
     {
       "fileMatch": ["**/_nav.json"],
-      "url": "./website/node_modules/rspress/nav-json-schema.json"
+      "url": "./website/node_modules/@rspress/core/nav-json-schema.json"
     }
   ]
 }

packages/core/src/cli/build.ts

@@ -1,6 +1,7 @@
 import { createRsbuild, type RsbuildInstance } from '@rsbuild/core';
 import { composeRsbuildEnvironments, pruneEnvironments } from '../config';
 import type { RslibConfig } from '../types/config';
+import { isDebug } from '../utils/logger';
 import type { BuildOptions } from './commands';
 import { onBeforeRestart } from './restart';
 
@@ -17,6 +18,7 @@ export async function build(
       plugins: config.plugins,
       dev: config.dev,
       server: config.server,
+      logLevel: isDebug() ? 'info' : config.logLevel,
       environments: pruneEnvironments(environments, options.lib),
     },
   });

packages/core/src/cli/commands.ts

@@ -1,4 +1,4 @@
-import type { RsbuildMode } from '@rsbuild/core';
+import type { LogLevel, RsbuildMode } from '@rsbuild/core';
 import cac, { type CAC } from 'cac';
 import type { ConfigLoader } from '../config';
 import { logger } from '../utils/logger';
@@ -15,6 +15,7 @@ export type CommonOptions = {
   envMode?: string;
   lib?: string[];
   configLoader?: ConfigLoader;
+  logLevel?: LogLevel;
 };
 
 export type BuildOptions = CommonOptions & {
@@ -49,6 +50,10 @@ const applyCommonOptions = (cli: CAC) => {
       },
     )
     .option('--env-dir <dir>', 'specify the directory to load `.env` files')
+    .option(
+      '--log-level <level>',
+      'set the log level (info | warn | error | silent)',
+    )
     .option(
       '--lib <id>',
       'specify the library (repeatable, e.g. --lib esm --lib cjs)',

packages/core/src/cli/init.ts

@@ -44,6 +44,10 @@ export async function init(options: CommonOptions): Promise<{
     config.root = root;
   }
 
+  if (options.logLevel) {
+    config.logLevel = options.logLevel;
+  }
+
   return {
     config,
     configFilePath,

packages/core/src/cli/inspect.ts

@@ -1,6 +1,7 @@
 import { createRsbuild, type RsbuildInstance } from '@rsbuild/core';
 import { composeRsbuildEnvironments, pruneEnvironments } from '../config';
 import type { RslibConfig } from '../types/config';
+import { isDebug } from '../utils/logger';
 import type { InspectOptions } from './commands';
 
 export async function inspect(
@@ -16,6 +17,7 @@ export async function inspect(
       plugins: config.plugins,
       dev: config.dev,
       server: config.server,
+      logLevel: isDebug() ? 'info' : config.logLevel,
       environments: pruneEnvironments(environments, options.lib),
     },
   });

packages/core/src/cli/mf.ts

@@ -2,6 +2,7 @@ import type { RsbuildInstance } from '@rsbuild/core';
 import { createRsbuild } from '@rsbuild/core';
 import { composeRsbuildEnvironments, pruneEnvironments } from '../config';
 import type { RslibConfig } from '../types';
+import { isDebug } from '../utils/logger';
 import type { CommonOptions } from './commands';
 import { onBeforeRestart } from './restart';
 
@@ -53,6 +54,7 @@ async function initMFRsbuild(
       plugins: config.plugins,
       dev: config.dev,
       server: config.server,
+      logLevel: isDebug() ? 'info' : config.logLevel,
       environments: selectedEnvironments,
     },
   });

packages/core/src/cli/prepare.ts

@@ -1,4 +1,5 @@
-import { logger } from '../utils/logger';
+import type { LogLevel } from '@rsbuild/core';
+import { isDebug, logger } from '../utils/logger';
 
 function initNodeEnv() {
   if (!process.env.NODE_ENV) {
@@ -9,8 +10,22 @@ function initNodeEnv() {
   }
 }
 
+// ensure log level is set before any log is printed
+function setupLogLevel() {
+  const logLevelIndex = process.argv.findIndex(
+    (item) => item === '--log-level' || item === '--logLevel',
+  );
+  if (logLevelIndex !== -1) {
+    const level = process.argv[logLevelIndex + 1];
+    if (level && ['warn', 'error', 'silent'].includes(level) && !isDebug()) {
+      logger.level = level as LogLevel;
+    }
+  }
+}
+
 export function prepareCli(): void {
   initNodeEnv();
+  setupLogLevel();
 
   // Print a blank line to keep the greet log nice.
   // Some package managers automatically output a blank line, some do not.
@@ -20,7 +35,7 @@ export function prepareCli(): void {
     npm_execpath.includes('npx-cli.js') ||
     npm_execpath.includes('.bun')
   ) {
-    console.log();
+    logger.log();
   }
 
   logger.greet(`  Rslib v${RSLIB_VERSION}\n`);

packages/core/src/config.ts

@@ -73,7 +73,7 @@ import {
   pick,
   readPackageJson,
 } from './utils/helper';
-import { logger } from './utils/logger';
+import { isDebug, logger } from './utils/logger';
 import {
   ESX_TO_BROWSERSLIST,
   transformSyntaxToBrowserslist,
@@ -1804,8 +1804,13 @@ export async function composeCreateRsbuildConfig(
     plugins: sharedPlugins,
     dev: _dev,
     server: _server,
+    logLevel,
     ...sharedRsbuildConfig
   } = rslibConfig;
+  // debug mode should always verbose logs
+  if (logLevel && !isDebug()) {
+    logger.level = logLevel;
+  }
 
   if (!Array.isArray(libConfigsArray) || libConfigsArray.length === 0) {
     throw new Error(

packages/core/src/utils/logger.ts

@@ -21,7 +21,9 @@ export const isDebug = (): boolean => {
   }
 
   const values = process.env.DEBUG.toLocaleLowerCase().split(',');
-  return ['rslib', 'rs*', 'rstack', '*'].some((key) => values.includes(key));
+  return ['rslib', 'rsbuild', 'rs*', 'rstack', '*'].some((key) =>
+    values.includes(key),
+  );
 };
 
 // setup the logger level

packages/core/tests/__snapshots__/config.test.ts.snap

@@ -287,7 +287,8 @@ exports[`Should compose create Rsbuild config correctly > Merge Rsbuild config i
       name: 'rsbuild:nonce',
       setup() {}
     }
-  ]
+  ],
+  logLevel: undefined
 }"
 `;