refator: enhance cli behaviour and logs

Author: Timeless0911

packages/core/bin/rslib.js

@@ -13,14 +13,8 @@ if (enableCompileCache) {
 }
 
 async function main() {
-  const { logger, prepareCli, runCli } = await import('../dist/index.js');
-  prepareCli();
-
-  try {
-    runCli();
-  } catch (err) {
-    logger.error(err);
-  }
+  const { runCLI } = await import('../dist/index.js');
+  runCLI();
 }
 
 main();

packages/core/src/cli/commands.ts

@@ -1,15 +1,17 @@
 import type { LogLevel, RsbuildMode, RsbuildPlugin } from '@rsbuild/core';
 import cac, { type CAC } from 'cac';
 import type { ConfigLoader } from '../config';
-import type { Format, Syntax } from '../types/config';
+import type { Format, Syntax } from '../types';
 import { color } from '../utils/color';
 import { logger } from '../utils/logger';
 import { build } from './build';
-import { initConfig } from './initConfig';
+import { init } from './init';
 import { inspect } from './inspect';
 import { startMFDevServer } from './mf';
 import { watchFilesForRestart } from './restart';
 
+export const RSPACK_BUILD_ERROR = 'Rspack build failed.';
+
 export type CommonOptions = {
   root?: string;
   config?: string;
@@ -81,11 +83,12 @@ const applyCommonOptions = (cli: CAC) => {
     );
 };
 
-export function runCli(): void {
+export function setupCommands(): void {
   const cli = cac('rslib');
 
   cli.version(RSLIB_VERSION);
 
+  // Apply common options to all commands
   applyCommonOptions(cli);
 
   const buildDescription = `build the library for production ${color.dim('(default if no command is given)')}`;
@@ -138,7 +141,7 @@ export function runCli(): void {
     .action(async (options: BuildOptions) => {
       try {
         const cliBuild = async () => {
-          const { config, watchFiles } = await initConfig(options);
+          const { config, watchFiles } = await init(options);
 
           if (options.watch) {
             config.plugins = config.plugins || [];
@@ -162,7 +165,11 @@ export function runCli(): void {
 
         await cliBuild();
       } catch (err) {
-        logger.error('Failed to build.');
+        const isRspackError =
+          err instanceof Error && err.message === RSPACK_BUILD_ERROR;
+        if (!isRspackError) {
+          logger.error('Failed to build.');
+        }
         if (err instanceof AggregateError) {
           for (const error of err.errors) {
             logger.error(error);
@@ -182,7 +189,7 @@ export function runCli(): void {
     .action(async (options: InspectOptions) => {
       try {
         // TODO: inspect should output Rslib's config
-        const { config } = await initConfig(options);
+        const { config } = await init(options);
         await inspect(config, {
           lib: options.lib,
           mode: options.mode,
@@ -199,7 +206,7 @@ export function runCli(): void {
   mfDevCommand.action(async (options: MfDevOptions) => {
     try {
       const cliMfDev = async () => {
-        const { config, watchFiles } = await initConfig(options);
+        const { config, watchFiles } = await init(options);
         await startMFDevServer(config, {
           lib: options.lib,
         });

packages/core/src/cli/index.ts

@@ -0,0 +1,54 @@
+import type { LogLevel } from '@rsbuild/core';
+import { isDebug, logger } from '../utils/logger';
+import { setupCommands } from './commands';
+
+function initNodeEnv() {
+  if (!process.env.NODE_ENV) {
+    const command = process.argv[2] ?? '';
+    process.env.NODE_ENV = ['build'].includes(command)
+      ? 'production'
+      : 'development';
+  }
+}
+
+function showGreeting() {
+  // Ensure consistent spacing before the greeting message.
+  // Different package managers handle output formatting differently - some automatically
+  // add a blank line before command output, while others do not.
+  const { npm_execpath, npm_lifecycle_event, NODE_RUN_SCRIPT_NAME } =
+    process.env;
+  const isNpx = npm_lifecycle_event === 'npx';
+  const isBun = npm_execpath?.includes('.bun');
+  const isNodeRun = Boolean(NODE_RUN_SCRIPT_NAME);
+  const prefix = isNpx || isBun || isNodeRun ? '\n' : '';
+  logger.greet(`${prefix}Rslib v${RSLIB_VERSION}\n`);
+}
+
+// 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 runCLI(): void {
+  // make it easier to identify the process via activity monitor or other tools
+  process.title = 'rslib-node';
+
+  initNodeEnv();
+  setupLogLevel();
+  showGreeting();
+
+  try {
+    setupCommands();
+  } catch (err) {
+    logger.error('Failed to start Rslib CLI.');
+    logger.error(err);
+  }
+}

packages/core/src/cli/initConfig.ts packages/core/src/cli/init.tspackages/core/src/cli/initConfig.ts renamed to packages/core/src/cli/init.ts

@@ -105,7 +105,7 @@ export const applyCliOptions = (
   }
 };
 
-export async function initConfig(options: CommonOptions): Promise<{
+export async function init(options: CommonOptions): Promise<{
   config: RslibConfig;
   configFilePath?: string;
   watchFiles: string[];

packages/core/src/cli/prepare.ts

@@ -1,8 +1,12 @@
+/**
+ * The methods and types exported from this file are considered as
+ * the public API of @rslib/core.
+ */
+
+export { runCLI } from './cli';
 export { build } from './cli/build';
-export { runCli } from './cli/commands';
 export { inspect } from './cli/inspect';
 export { startMFDevServer } from './cli/mf';
-export { prepareCli } from './cli/prepare';
 export {
   composeCreateRsbuildConfig as unstable_composeCreateRsbuildConfig,
   defineConfig,