feat: support restart when rslib config changed

Author: 9aoy

packages/core/prebundle.config.mjs

@@ -13,7 +13,11 @@ export default {
   },
   dependencies: [
     'commander',
-    'chokidar',
+    {
+      name: 'chokidar',
+      // strip sourcemap comment
+      prettier: true,
+    },
     {
       name: 'rslog',
       afterBundle(task) {

packages/core/src/cli/build.ts

@@ -1,20 +1,16 @@
 import { type RsbuildInstance, createRsbuild } from '@rsbuild/core';
-import {
-  composeRsbuildEnvironments,
-  loadConfig,
-  pruneEnvironments,
-} from '../config';
+import { composeRsbuildEnvironments, pruneEnvironments } from '../config';
 import { onBeforeRestartServer, watchFilesForRestart } from '../restart';
+import type { RslibConfig } from '../types/config';
 import type { BuildOptions } from './commands';
+import { loadRslibConfig } from './init';
 
 export async function build(
-  options: BuildOptions = {},
+  config: RslibConfig,
+  options: Pick<BuildOptions, 'lib' | 'watch'> & {
+    configFilePath?: string;
+  } = {},
 ): Promise<RsbuildInstance> {
-  const { content: config, filePath: configFilePath } = await loadConfig({
-    path: options?.config,
-    envMode: options?.envMode,
-  });
-
   const environments = await composeRsbuildEnvironments(config);
   const rsbuildInstance = await createRsbuild({
     rsbuildConfig: {
@@ -28,12 +24,17 @@ export async function build(
 
   if (options?.watch) {
     const files: string[] = [];
-    files.push(configFilePath);
+    options.configFilePath && files.push(options?.configFilePath);
 
     onBeforeRestartServer(buildInstance.close);
 
     watchFilesForRestart(files, async () => {
-      await build(options);
+      const { content: rslibConfig, filePath: configFilePath } =
+        await loadRslibConfig(options);
+      await build(rslibConfig, {
+        configFilePath,
+        ...options,
+      });
     });
   } else {
     await buildInstance.close();

packages/core/src/cli/commands.ts

@@ -62,7 +62,13 @@ export function runCli(): void {
     .description('build the library for production')
     .action(async (options: BuildOptions) => {
       try {
-        await build(options);
+        const { content: rslibConfig, filePath: configFilePath } =
+          await loadRslibConfig(options);
+        await build(rslibConfig, {
+          configFilePath,
+          lib: options.lib,
+          watch: options.watch,
+        });
       } catch (err) {
         logger.error('Failed to build.');
         logger.error(err);

packages/plugin-dts/src/index.ts

@@ -1,4 +1,4 @@
-import { fork } from 'node:child_process';
+import { type ChildProcess, fork } from 'node:child_process';
 import { dirname, extname, join } from 'node:path';
 import { fileURLToPath } from 'node:url';
 import { type RsbuildConfig, type RsbuildPlugin, logger } from '@rsbuild/core';
@@ -60,6 +60,7 @@ export const pluginDts = (options: PluginDtsOptions = {}): RsbuildPlugin => ({
 
     const dtsPromises: Promise<TaskResult>[] = [];
     let promisesResult: TaskResult[] = [];
+    let childProcesses: ChildProcess[] = [];
 
     api.onBeforeEnvironmentCompile(
       ({ isWatch, isFirstCompile, environment }) => {
@@ -74,6 +75,8 @@ export const pluginDts = (options: PluginDtsOptions = {}): RsbuildPlugin => ({
           stdio: 'inherit',
         });
 
+        childProcesses.push(childProcess);
+
         // TODO: @microsoft/api-extractor only support single entry to bundle DTS
         // use first element of Record<string, string> type entry config
         const dtsEntry = processSourceEntry(
@@ -141,5 +144,14 @@ export const pluginDts = (options: PluginDtsOptions = {}): RsbuildPlugin => ({
       },
       order: 'post',
     });
+
+    api.onCloseBuild(() => {
+      for (const childProcess of childProcesses) {
+        if (!childProcess.killed) {
+          childProcess.kill();
+        }
+      }
+      childProcesses = [];
+    });
   },
 });

pnpm-lock.yaml

@@ -0,0 +1,50 @@
+import { exec } from 'node:child_process';
+import path from 'node:path';
+import fse from 'fs-extra';
+import { awaitFileExists } from 'test-helper';
+import { describe, test } from 'vitest';
+
+describe('build --watch command', async () => {
+  test('basic', async () => {
+    const distPath = path.join(__dirname, 'dist');
+    await fse.remove(distPath);
+
+    const tempConfigFile = path.join(__dirname, 'test-temp-rslib.config.mjs');
+
+    fse.outputFileSync(
+      tempConfigFile,
+      `import { defineConfig } from '@rslib/core';
+import { generateBundleEsmConfig } from 'test-helper';
+
+export default defineConfig({
+  lib: [generateBundleEsmConfig()],
+});
+  `,
+    );
+
+    const process = exec(`npx rslib build --watch -c ${tempConfigFile}`, {
+      cwd: __dirname,
+    });
+
+    const distEsmIndexFile = path.join(__dirname, 'dist/esm/index.js');
+
+    await awaitFileExists(distEsmIndexFile);
+
+    await fse.remove(distPath);
+
+    fse.outputFileSync(
+      tempConfigFile,
+      `import { defineConfig } from '@rslib/core';
+import { generateBundleEsmConfig } from 'test-helper';
+
+export default defineConfig({
+  lib: [generateBundleEsmConfig()],
+});
+  `,
+    );
+
+    await awaitFileExists(distEsmIndexFile);
+
+    process.kill();
+  });
+});

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

@@ -0,0 +1,6 @@
+{
+  "name": "cli-build-watch-test",
+  "version": "1.0.0",
+  "private": true,
+  "type": "module"
+}

tests/integration/cli/build-watch/package.json

@@ -0,0 +1,13 @@
+import { defineConfig } from '@rslib/core';
+import { generateBundleCjsConfig, generateBundleEsmConfig } from 'test-helper';
+
+export default defineConfig({
+  lib: [
+    generateBundleEsmConfig({
+      dts: true,
+    }),
+    generateBundleCjsConfig({
+      dts: true,
+    }),
+  ],
+});

tests/integration/cli/build-watch/rslib.config.ts

@@ -0,0 +1 @@
+export const foo = 'foo';

tests/integration/cli/build-watch/src/index.ts

@@ -0,0 +1,9 @@
+{
+  "extends": "@rslib/tsconfig/base",
+  "compilerOptions": {
+    "rootDir": "src",
+    "baseUrl": ".",
+    "composite": true
+  },
+  "include": ["src"]
+}

tests/integration/cli/build-watch/tsconfig.json

@@ -61,3 +61,33 @@ export const proxyConsole = (
     },
   };
 };
+
+export const waitFor = async (
+  fn: () => boolean,
+  {
+    maxChecks = 100,
+    interval = 20,
+  }: {
+    maxChecks?: number;
+    interval?: number;
+  } = {},
+) => {
+  let checks = 0;
+
+  while (checks < maxChecks) {
+    if (fn()) {
+      return true;
+    }
+    checks++;
+    await new Promise((resolve) => setTimeout(resolve, interval));
+  }
+
+  return false;
+};
+
+export const awaitFileExists = async (dir: string) => {
+  const result = await waitFor(() => fse.existsSync(dir), { interval: 50 });
+  if (!result) {
+    throw new Error(`awaitFileExists failed: ${dir}`);
+  }
+};