feat: rename hooks function types and export them (#5144)

Author: chenjiahan

packages/core/src/index.ts

@@ -135,6 +135,9 @@ export type {
   PostCSSPlugin,
   PreviewOptions,
   PreconnectOption,
+  ProcessAssetsDescriptor,
+  ProcessAssetsHook,
+  ProcessAssetsHandler,
   ProxyBypass,
   ProxyConfig,
   ProxyFilter,
@@ -144,6 +147,8 @@ export type {
   PublicDirOptions,
   ProgressBarConfig,
   RequestHandler,
+  ResolveHook,
+  ResolveHandler,
   ResolvedCreateRsbuildOptions,
   RsbuildConfig,
   RsbuildContext,
@@ -176,7 +181,7 @@ export type {
   TransformContext,
   TransformDescriptor,
   ToolsConfig,
-  TransformFn,
+  TransformHook,
   TransformHandler,
   TransformImport,
   WatchFiles,

packages/core/src/initPlugins.ts

@@ -14,14 +14,14 @@ import type {
   NormalizedEnvironmentConfig,
   PluginManager,
   ProcessAssetsDescriptor,
-  ProcessAssetsFn,
   ProcessAssetsHandler,
+  ProcessAssetsHook,
   ProcessAssetsStage,
-  ResolveFn,
   ResolveHandler,
+  ResolveHook,
   RsbuildPluginAPI,
-  TransformFn,
   TransformHandler,
+  TransformHook,
 } from './types';
 
 export function getHTMLPathByEntry(
@@ -250,7 +250,7 @@ export function initPluginAPI({
     chain.plugin(pluginName).use(RsbuildCorePlugin);
   });
 
-  const getTransformFn: (environment?: string) => TransformFn =
+  const getTransformHook: (environment?: string) => TransformHook =
     (environment) => (descriptor, handler) => {
       const id = `rsbuild-transform-${transformId++}`;
 
@@ -309,12 +309,12 @@ export function initPluginAPI({
       });
     };
 
-  const setProcessAssets: (environment?: string) => ProcessAssetsFn =
+  const setProcessAssets: (environment?: string) => ProcessAssetsHook =
     (environment) => (descriptor, handler) => {
       processAssetsFns.push({ environment, descriptor, handler });
     };
 
-  const setResolve: (environment?: string) => ResolveFn =
+  const setResolve: (environment?: string) => ResolveHook =
     (environment) => (handler) => {
       resolveFns.push({ environment, handler });
     };
@@ -335,7 +335,7 @@ export function initPluginAPI({
   return (environment?: string) => ({
     context: publicContext,
     expose,
-    transform: getTransformFn(environment),
+    transform: getTransformHook(environment),
     useExposed,
     processAssets: setProcessAssets(environment),
     resolve: setResolve(environment),

packages/core/src/types/plugin.ts

@@ -373,7 +373,7 @@ export type TransformDescriptor = {
   with?: Record<string, Rspack.RuleSetCondition>;
 };
 
-export type TransformFn = (
+export type TransformHook = (
   descriptor: TransformDescriptor,
   handler: TransformHandler,
 ) => void;
@@ -450,9 +450,9 @@ export type ResolveHandler = (context: {
   compilation: Rspack.Compilation;
 }) => Promise<void> | void;
 
-export type ResolveFn = (handler: ResolveHandler) => void;
+export type ResolveHook = (handler: ResolveHandler) => void;
 
-export type ProcessAssetsFn = (
+export type ProcessAssetsHook = (
   descriptor: ProcessAssetsDescriptor,
   handler: ProcessAssetsHandler,
 ) => void;
@@ -607,19 +607,19 @@ export type RsbuildPluginAPI = Readonly<{
    * Modify assets before emitting, the same as Rspack's
    * [compilation.hooks.processAssets](https://rspack.dev/api/plugin-api/compilation-hooks#processassets) hook.
    */
-  processAssets: ProcessAssetsFn;
+  processAssets: ProcessAssetsHook;
   /**
    * Intercept and modify module request information before module resolution begins.
    * The same as Rspack's [normalModuleFactory.hooks.resolve](https://rspack.dev/api/plugin-api/normal-module-factory-hooks#resolve) hook.
    */
-  resolve: ResolveFn;
+  resolve: ResolveHook;
   /**
    * A simplified wrapper around Rspack loaders, `api.transform` lets you
    * easily transform the code of specific modules during the build process.
    * You can match files by module path, query, or other conditions, and
    * apply custom transformations to their contents.
    */
-  transform: TransformFn;
+  transform: TransformHook;
   /**
    * Get the properties or methods exposed by other plugins.
    */

website/docs/en/api/javascript-api/types.mdx

@@ -164,6 +164,6 @@ const rspackConfig: Rspack.Configuration = {};
 - ModifyRsbuildConfigFn
 - ModifyBundlerChainFn
 - ModifyRspackConfigFn
-- TransformFn,
+- TransformHook,
 - TransformHandler
 - more...

website/docs/en/plugins/dev/core.mdx

@@ -346,7 +346,7 @@ Intercept and modify module request information before module resolution begins.
 - **Type:**
 
 ```ts
-function ResolveFn(handler: ResolveHandler): void;
+function ResolveHook(handler: ResolveHandler): void;
 ```
 
 ### Example

website/docs/zh/api/javascript-api/types.mdx

@@ -164,6 +164,6 @@ const rspackConfig: Rspack.Configuration = {};
 - ModifyRsbuildConfigFn
 - ModifyBundlerChainFn
 - ModifyRspackConfigFn
-- TransformFn,
+- TransformHook,
 - TransformHandler
 - more...

website/docs/zh/plugins/dev/core.mdx

@@ -344,7 +344,7 @@ api.transform(
 - **类型：**
 
 ```ts
-function ResolveFn(handler: ResolveHandler): void;
+function ResolveHook(handler: ResolveHandler): void;
 ```
 
 ### 示例