feat: log a flag to mark first compile done in watch mode (#1330)

Author: fi3ework

packages/core/src/cli/commands.ts

@@ -1,4 +1,4 @@
-import type { LogLevel, RsbuildMode } from '@rsbuild/core';
+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';
@@ -139,12 +139,25 @@ export function runCli(): void {
       try {
         const cliBuild = async () => {
           const { config, watchFiles } = await initConfig(options);
-          await build(config, options);
+
           if (options.watch) {
+            config.plugins = config.plugins || [];
+            config.plugins.push({
+              name: 'rslib:on-after-build',
+              setup(api) {
+                api.onAfterBuild(({ isFirstCompile }) => {
+                  if (isFirstCompile) {
+                    logger.success('build complete, watching for changes...');
+                  }
+                });
+              },
+            } satisfies RsbuildPlugin);
+
             watchFilesForRestart(watchFiles, async () => {
               await cliBuild();
             });
           }
+          await build(config, options);
         };
 
         await cliBuild();

tests/integration/cli/build-watch/build.test.ts

@@ -1,5 +1,6 @@
 import { spawn } from 'node:child_process';
 import path from 'node:path';
+import { stripVTControlCharacters as stripAnsi } from 'node:util';
 import { describe, expect, onTestFinished, test } from '@rstest/core';
 import fse from 'fs-extra';
 import {
@@ -53,7 +54,11 @@ export default defineConfig({
 
     await expectFile(dist1EsmIndexFile);
 
-    process.kill();
+    expect(stripAnsi(process.stdout())).toContain(
+      'build complete, watching for changes',
+    );
+
+    process.child.kill();
   });
 });
 

tests/integration/cli/mf/mf.test.ts

@@ -17,7 +17,7 @@ describe('mf-dev', () => {
     fse.removeSync(distFolder);
     const distPath = join(distFolder, 'index.js');
 
-    const childProcess = runCli('mf-dev --lib mf0', {
+    const { child: childProcess } = runCli('mf-dev --lib mf0', {
       cwd: fixturePath,
       env: {
         ...process.env,
@@ -47,7 +47,7 @@ describe('mf-dev', () => {
     const distPath1 = join(distFolder1, 'index.js');
     const distPath2 = join(distFolder2, 'index.js');
 
-    const childProcess = runCli('mf-dev --lib mf1 --lib mf2', {
+    const { child: childProcess } = runCli('mf-dev --lib mf1 --lib mf2', {
       cwd: fixturePath,
     });
 

tests/integration/plugins/index.test.ts

@@ -16,7 +16,7 @@ test('should run shared plugins only once', async () => {
 
 test('should merge plugins correctly', async () => {
   const fixturePath = join(__dirname, 'mf-dev');
-  const childProcess = runCli('mf-dev', {
+  const { child: childProcess } = runCli('mf-dev', {
     cwd: fixturePath,
   });
 

tests/integration/server/index.test.ts

@@ -23,7 +23,7 @@ describe('server config', async () => {
 
     fse.removeSync(distPath);
 
-    const childProcess = runCli('mf-dev', {
+    const { child: childProcess } = runCli('mf-dev', {
       cwd: fixturePath,
       env: {
         ...process.env,

tests/scripts/shared.ts

@@ -42,7 +42,24 @@ export function runCliSync(command: string, options?: ExecSyncOptions) {
 }
 
 export function runCli(command: string, options?: ExecOptions) {
-  return exec(`node ${rslibBinPath} ${command}`, options);
+  const child = exec(`node ${rslibBinPath} ${command}`, options);
+
+  let stdout = '';
+  let stderr = '';
+
+  child.stdout?.on('data', (data) => {
+    stdout += data.toString();
+  });
+
+  child.stderr?.on('data', (data) => {
+    stderr += data.toString();
+  });
+
+  return {
+    child,
+    stdout: () => stdout,
+    stderr: () => stderr,
+  };
 }
 
 export function getCwdByExample(exampleName: string) {