feat: add new onAfterDevCompile plugin hook (#5882)

chenjiahan · web-flow · commit 5474f64b2254 · 2025-08-19T13:56:44.000+08:00
diff --git a/e2e/cases/output/manifest-environment/index.test.ts b/e2e/cases/output/manifest-environment/index.test.ts
@@ -93,7 +93,7 @@ test('should allow to access manifest data in environment context after dev buil
         {
           name: 'test',
           setup(api: RsbuildPluginAPI) {
-            api.onDevCompileDone(({ environments }) => {
+            api.onAfterDevCompile(({ environments }) => {
               if (environments.web.manifest) {
                 webManifest = environments.web.manifest;
               }
diff --git a/e2e/cases/plugin-api/plugin-hooks-environment/index.test.ts b/e2e/cases/plugin-api/plugin-hooks-environment/index.test.ts
@@ -60,16 +60,19 @@ const createPlugin = () => {
         names.push('BeforeStartProdServer');
       });
       api.onCloseDevServer(() => {
-        names.push('OnCloseDevServer');
+        names.push('CloseDevServer');
       });
       api.onAfterStartProdServer(() => {
         names.push('AfterStartProdServer');
       });
       api.onBeforeDevCompile(() => {
         names.push('BeforeDevCompile');
       });
+      api.onAfterDevCompile(() => {
+        names.push('AfterDevCompile');
+      });
       api.onDevCompileDone(() => {
-        names.push('OnDevCompileDone');
+        names.push('DevCompileDone');
       });
     },
   };
@@ -176,7 +179,7 @@ rspackOnlyTest(
     expect(names.filter((name) => name.includes('DevServer'))).toEqual([
       'BeforeStartDevServer',
       'AfterStartDevServer',
-      'OnCloseDevServer',
+      'CloseDevServer',
     ]);
 
     // compile is async, so the execution order of AfterStartDevServer and the compile hooks is uncertain
@@ -197,8 +200,9 @@ rspackOnlyTest(
       'ModifyHTMLTags web',
       'ModifyHTML web',
       'AfterEnvironmentCompile web',
-      'OnDevCompileDone',
-      'OnCloseDevServer',
+      'AfterDevCompile',
+      'DevCompileDone',
+      'CloseDevServer',
     ]);
 
     expect(
@@ -218,8 +222,9 @@ rspackOnlyTest(
       'ModifyHTMLTags node',
       'ModifyHTML node',
       'AfterEnvironmentCompile node',
-      'OnDevCompileDone',
-      'OnCloseDevServer',
+      'AfterDevCompile',
+      'DevCompileDone',
+      'CloseDevServer',
     ]);
 
     process.env.NODE_ENV = 'test';
diff --git a/e2e/cases/plugin-api/plugin-hooks/index.test.ts b/e2e/cases/plugin-api/plugin-hooks/index.test.ts
@@ -38,7 +38,7 @@ rspackOnlyTest(
       'ModifyHTML',
       'AfterEnvironmentCompile',
       'AfterBuild',
-      'OnCloseBuild',
+      'CloseBuild',
     ]);
   },
 );
@@ -75,7 +75,7 @@ rspackOnlyTest(
       'ModifyHTML',
       'AfterEnvironmentCompile',
       'AfterBuild',
-      'OnCloseBuild',
+      'CloseBuild',
     ]);
   },
 );
@@ -106,7 +106,7 @@ rspackOnlyTest(
     expect(hooks.filter((name) => name.includes('DevServer'))).toEqual([
       'BeforeStartDevServer',
       'AfterStartDevServer',
-      'OnCloseDevServer',
+      'CloseDevServer',
     ]);
 
     // compile is async, so the execution order of AfterStartDevServer and the compile hooks is uncertain
@@ -123,8 +123,9 @@ rspackOnlyTest(
       'ModifyHTMLTags',
       'ModifyHTML',
       'AfterEnvironmentCompile',
-      'OnDevCompileDone',
-      'OnCloseDevServer',
+      'AfterDevCompile',
+      'DevCompileDone',
+      'CloseDevServer',
     ]);
 
     process.env.NODE_ENV = 'test';
diff --git a/e2e/cases/rspack-profile/dev.mjs b/e2e/cases/rspack-profile/dev.mjs
@@ -22,7 +22,7 @@ async function main() {
     },
   });
 
-  rsbuild.onDevCompileDone(() => {
+  rsbuild.onAfterDevCompile(() => {
     process.exit(0);
   });
 
diff --git a/e2e/helper/jsApi.ts b/e2e/helper/jsApi.ts
@@ -117,7 +117,7 @@ export async function dev({
 
   const wait = waitFirstCompileDone
     ? new Promise<void>((resolve) => {
-        rsbuild.onDevCompileDone(({ isFirstCompile }) => {
+        rsbuild.onAfterDevCompile(({ isFirstCompile }) => {
           if (!isFirstCompile) {
             return;
           }
diff --git a/e2e/helper/utils.ts b/e2e/helper/utils.ts
@@ -238,16 +238,19 @@ export const recordPluginHooks = () => {
         hooks.push('BeforeStartProdServer');
       });
       api.onCloseDevServer(() => {
-        hooks.push('OnCloseDevServer');
+        hooks.push('CloseDevServer');
       });
       api.onAfterStartProdServer(() => {
         hooks.push('AfterStartProdServer');
       });
+      api.onAfterDevCompile(() => {
+        hooks.push('AfterDevCompile');
+      });
       api.onDevCompileDone(() => {
-        hooks.push('OnDevCompileDone');
+        hooks.push('DevCompileDone');
       });
       api.onCloseBuild(() => {
-        hooks.push('OnCloseBuild');
+        hooks.push('CloseBuild');
       });
     },
   };
diff --git a/packages/core/src/createRsbuild.ts b/packages/core/src/createRsbuild.ts
@@ -317,6 +317,7 @@ export async function createRsbuild(
       'onAfterStartProdServer',
       'onCloseDevServer',
       'onBeforeDevCompile',
+      'onAfterDevCompile',
       'onDevCompileDone',
       'onExit',
       'getRsbuildConfig',
diff --git a/packages/core/src/hooks.ts b/packages/core/src/hooks.ts
@@ -15,6 +15,7 @@ import type {
   ModifyWebpackConfigFn,
   OnAfterBuildFn,
   OnAfterCreateCompilerFn,
+  OnAfterDevCompileFn,
   OnAfterEnvironmentCompileFn,
   OnAfterStartDevServerFn,
   OnAfterStartProdServerFn,
@@ -26,7 +27,6 @@ import type {
   OnBeforeStartProdServerFn,
   OnCloseBuildFn,
   OnCloseDevServerFn,
-  OnDevCompileDoneFn,
   OnExitFn,
   Rspack,
 } from './types';
@@ -203,7 +203,7 @@ export function initHooks(): {
   onCloseBuild: AsyncHook<OnCloseBuildFn>;
   onBeforeBuild: AsyncHook<OnBeforeBuildFn>;
   onBeforeDevCompile: AsyncHook<OnBeforeDevCompileFn>;
-  onDevCompileDone: AsyncHook<OnDevCompileDoneFn>;
+  onAfterDevCompile: AsyncHook<OnAfterDevCompileFn>;
   onCloseDevServer: AsyncHook<OnCloseDevServerFn>;
   onAfterStartDevServer: AsyncHook<OnAfterStartDevServerFn>;
   onBeforeStartDevServer: AsyncHook<OnBeforeStartDevServerFn>;
@@ -229,7 +229,7 @@ export function initHooks(): {
     onAfterBuild: createAsyncHook<OnAfterBuildFn>(),
     onBeforeBuild: createAsyncHook<OnBeforeBuildFn>(),
     onBeforeDevCompile: createAsyncHook<OnBeforeDevCompileFn>(),
-    onDevCompileDone: createAsyncHook<OnDevCompileDoneFn>(),
+    onAfterDevCompile: createAsyncHook<OnAfterDevCompileFn>(),
     onCloseDevServer: createAsyncHook<OnCloseDevServerFn>(),
     onAfterStartDevServer: createAsyncHook<OnAfterStartDevServerFn>(),
     onBeforeStartDevServer: createAsyncHook<OnBeforeStartDevServerFn>(),
@@ -500,7 +500,7 @@ export const registerDevHook = ({
     });
 
   const onDone = async (stats: Rspack.Stats | Rspack.MultiStats) => {
-    const p = context.hooks.onDevCompileDone.callBatch({
+    const p = context.hooks.onAfterDevCompile.callBatch({
       isFirstCompile,
       stats,
       environments: context.environments,
diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -123,6 +123,7 @@ export type {
   NormalizedToolsConfig,
   OnAfterBuildFn,
   OnAfterCreateCompilerFn,
+  OnAfterDevCompileFn,
   OnAfterEnvironmentCompileFn,
   OnAfterStartDevServerFn,
   OnAfterStartProdServerFn,
@@ -134,7 +135,6 @@ export type {
   OnBeforeStartProdServerFn,
   OnCloseBuildFn,
   OnCloseDevServerFn,
-  OnDevCompileDoneFn,
   OnExitFn,
   OutputConfig,
   OutputStructure,
diff --git a/packages/core/src/initPlugins.ts b/packages/core/src/initPlugins.ts
@@ -357,7 +357,9 @@ export function initPluginAPI({
     onBeforeBuild: hooks.onBeforeBuild.tap,
     onCloseDevServer: hooks.onCloseDevServer.tap,
     onBeforeDevCompile: hooks.onBeforeDevCompile.tap,
-    onDevCompileDone: hooks.onDevCompileDone.tap,
+    onAfterDevCompile: hooks.onAfterDevCompile.tap,
+    // alias for `onAfterDevCompile`
+    onDevCompileDone: hooks.onAfterDevCompile.tap,
     onAfterCreateCompiler: hooks.onAfterCreateCompiler.tap,
     onAfterStartDevServer: hooks.onAfterStartDevServer.tap,
     onBeforeCreateCompiler: hooks.onBeforeCreateCompiler.tap,
diff --git a/packages/core/src/server/devServer.ts b/packages/core/src/server/devServer.ts
@@ -170,8 +170,8 @@ export async function createDevServer<
     });
   };
 
-  // should register onDevCompileDone hook before startCompile
-  context.hooks.onDevCompileDone.tap(({ stats }) => {
+  // should register onAfterDevCompile hook before startCompile
+  context.hooks.onAfterDevCompile.tap(({ stats }) => {
     lastStats = 'stats' in stats ? stats.stats : [stats];
     if (waitLastCompileDoneResolve) {
       waitLastCompileDoneResolve();
diff --git a/packages/core/src/types/hooks.ts b/packages/core/src/types/hooks.ts
@@ -62,7 +62,7 @@ export type OnAfterBuildFn = (
 
 export type OnCloseDevServerFn = () => MaybePromise<void>;
 
-export type OnDevCompileDoneFn = (params: {
+export type OnAfterDevCompileFn = (params: {
   isFirstCompile: boolean;
   stats: Rspack.Stats | Rspack.MultiStats;
   environments: Record<string, EnvironmentContext>;
@@ -223,7 +223,7 @@ export type EnvironmentContext = {
    * Manifest data. Only available when:
    * - The `output.manifest` config is enabled
    * - The build has completed, accessible in hooks like `onAfterBuild`,
-   * `onDevCompileDone` and `onAfterEnvironmentCompile` or via the environment API
+   * `onAfterDevCompile` and `onAfterEnvironmentCompile` or via the environment API
    */
   manifest?: Record<string, unknown> | ManifestData;
   /**
diff --git a/packages/core/src/types/plugin.ts b/packages/core/src/types/plugin.ts
@@ -25,6 +25,7 @@ import type {
   ModifyRsbuildConfigFn,
   OnAfterBuildFn,
   OnAfterCreateCompilerFn,
+  OnAfterDevCompileFn,
   OnAfterEnvironmentCompileFn,
   OnAfterStartDevServerFn,
   OnAfterStartProdServerFn,
@@ -36,7 +37,6 @@ import type {
   OnBeforeStartProdServerFn,
   OnCloseBuildFn,
   OnCloseDevServerFn,
-  OnDevCompileDoneFn,
   OnExitFn,
 } from './hooks';
 import type {
@@ -620,6 +620,11 @@ export type RsbuildPluginAPI = Readonly<{
    * `rsbuild.startDevServer`, `rsbuild.build`, or `rsbuild.createCompiler`.
    */
   onAfterCreateCompiler: PluginHook<OnAfterCreateCompilerFn>;
+  /**
+   * Called after each development mode build, you can use `isFirstCompile`
+   * to determine whether it is the first build.
+   */
+  onAfterDevCompile: PluginHook<OnAfterDevCompileFn>;
   /**
    * A callback function that is triggered after the compilation of a single environment.
    * You can access the build result information via the
@@ -674,10 +679,11 @@ export type RsbuildPluginAPI = Readonly<{
    */
   onCloseDevServer: PluginHook<OnCloseDevServerFn>;
   /**
-   * Called after each development mode build, you can use `isFirstCompile`
-   * to determine whether it is the first build.
+   * Alias for the `onAfterDevCompile` hook.
+   * @deprecated Use `onAfterDevCompile` instead (added in v1.5.0).
+   * Both hooks have identical functionality.
    */
-  onDevCompileDone: PluginHook<OnDevCompileDoneFn>;
+  onDevCompileDone: PluginHook<OnAfterDevCompileFn>;
   /**
    * Called when the process is going to exit, this hook can only execute
    * synchronous code.
diff --git a/packages/core/src/types/rsbuild.ts b/packages/core/src/types/rsbuild.ts
@@ -329,6 +329,7 @@ export type RsbuildInstance = {
   | 'onCloseBuild'
   | 'onCloseDevServer'
   | 'onBeforeDevCompile'
+  | 'onAfterDevCompile'
   | 'onDevCompileDone'
   | 'onExit'
 >;
diff --git a/packages/core/tests/__snapshots__/hooks.test.ts.snap b/packages/core/tests/__snapshots__/hooks.test.ts.snap
@@ -7,7 +7,7 @@ exports[`initHooks > should init hooks correctly 1`] = `
   "onAfterBuild",
   "onBeforeBuild",
   "onBeforeDevCompile",
-  "onDevCompileDone",
+  "onAfterDevCompile",
   "onCloseDevServer",
   "onAfterStartDevServer",
   "onBeforeStartDevServer",

Original file line number	Diff line number	Diff line change
`@@ -93,7 +93,7 @@ test('should allow to access manifest data in environment context after dev buil`
`93`	`93`	`{`
`94`	`94`	`name: 'test',`
`95`	`95`	`setup(api: RsbuildPluginAPI) {`
`96`		`- api.onDevCompileDone(({ environments }) => {`
	`96`	`+ api.onAfterDevCompile(({ environments }) => {`
`97`	`97`	`if (environments.web.manifest) {`
`98`	`98`	`webManifest = environments.web.manifest;`
`99`	`99`	`}`
Original file line number	Diff line number	Diff line change
`@@ -117,7 +117,7 @@ export async function dev({`
`117`	`117`
`118`	`118`	`const wait = waitFirstCompileDone`
`119`	`119`	`? new Promise<void>((resolve) => {`
`120`		`- rsbuild.onDevCompileDone(({ isFirstCompile }) => {`
	`120`	`+ rsbuild.onAfterDevCompile(({ isFirstCompile }) => {`
`121`	`121`	`if (!isFirstCompile) {`
`122`	`122`	`return;`
`123`	`123`	`}`