@rsbuild/core 2.0.8 → 2.0.10

package/dist-types/types/context.d.ts

@@ -7,108 +7,79 @@ import type { RsbuildPluginAPI } from './plugin';
 import type { RsbuildStats } from './rsbuild';
 export type BundlerType = 'rspack';
 export type ActionType = 'dev' | 'build' | 'preview';
-/** The public context */
-export type RsbuildContext = {
-    /** The Rsbuild core version. */
-    version: string;
-    /** The root path of current project. */
-    rootPath: string;
-    /** Absolute path of output files. */
-    distPath: string;
-    /** Absolute path of cache files. */
-    cachePath: string;
+/** The public context */ export type RsbuildContext = {
+    /** The Rsbuild core version. */ version: string;
+    /** The root path of current project. */ rootPath: string;
+    /** Absolute path of output files. */ distPath: string;
+    /** Absolute path of cache files. */ cachePath: string;
     /**
-     * Dev server information when running in dev mode.
-     * Available after the dev server has been created.
-     *
-     * @example
-     * ```ts
-     * import { createRsbuild } from '@rsbuild/core';
-     *
-     * async function main() {
-     *   const rsbuild = createRsbuild({
-     *     // ...
-     *   });
-     *   await rsbuild.startDevServer();
-     *   console.log(rsbuild.context.devServer);
-     *   // { hostname: 'localhost', port: 3000, https: false }
-     * }
-     * ```
-     */
-    devServer?: {
-        /** The hostname the server is running on. */
-        hostname: string;
-        /** The actual port number the server is listening on. */
-        port: number;
-        /** Whether the server is using HTTPS protocol. */
-        https: boolean;
+   * Dev server information when running in dev mode.
+   * Available after the dev server has been created.
+   *
+   * @example
+   * ```ts
+   * import { createRsbuild } from '@rsbuild/core';
+   *
+   * async function main() {
+   *   const rsbuild = createRsbuild({
+   *     // ...
+   *   });
+   *   await rsbuild.startDevServer();
+   *   console.log(rsbuild.context.devServer);
+   *   // { hostname: 'localhost', port: 3000, https: false }
+   * }
+   * ```
+   */ devServer?: {
+        /** The hostname the server is running on. */ hostname: string;
+        /** The actual port number the server is listening on. */ port: number;
+        /** Whether the server is using HTTPS protocol. */ https: boolean;
     };
     /**
-     * The current action type.
-     * - dev: will be set when running `rsbuild dev` or `rsbuild.startDevServer()`
-     * - build: will be set when running `rsbuild build` or `rsbuild.build()`
-     * - preview: will be set when running `rsbuild preview` or `rsbuild.preview()`
-     */
-    action?: ActionType;
+   * The current action type.
+   * - dev: will be set when running `rsbuild dev` or `rsbuild.startDevServer()`
+   * - build: will be set when running `rsbuild build` or `rsbuild.build()`
+   * - preview: will be set when running `rsbuild preview` or `rsbuild.preview()`
+   */ action?: ActionType;
     /**
-     * The bundler type, currently only `rspack` is supported.
-     * @deprecated Do not use this field, it will be removed in future versions.
-     */
-    bundlerType: BundlerType;
+   * The bundler type, currently only `rspack` is supported.
+   * @deprecated Do not use this field, it will be removed in future versions.
+   */ bundlerType: BundlerType;
     /**
-     * The name of the framework or tool that is currently invoking Rsbuild,
-     * same as the `callerName` option in the `createRsbuild` method.
-     * @example
-     * - `rslib` is set when Rslib calls Rsbuild.
-     * - `rspress` is set when Rspress calls Rsbuild.
-     */
-    callerName: string;
+   * The name of the framework or tool that is currently invoking Rsbuild,
+   * same as the `callerName` option in the `createRsbuild` method.
+   * @example
+   * - `rslib` is set when Rslib calls Rsbuild.
+   * - `rspress` is set when Rspress calls Rsbuild.
+   */ callerName: string;
 };
 export type BuildStatus = 'idle' | 'building' | 'done';
 export type BuildState = {
     /**
-     * The stats object of the last build.
-     * Available after the build has been done.
-     */
-    stats: RsbuildStats | null;
-    /** Current build status */
-    status: BuildStatus;
-    /** Whether there are build errors */
-    hasErrors: boolean;
-    /** The build time of each environment */
-    time: Record<string, number>;
+   * The stats object of the last build.
+   * Available after the build has been done.
+   */ stats: RsbuildStats | null;
+    /** Current build status */ status: BuildStatus;
+    /** Whether there are build errors */ hasErrors: boolean;
+    /** The build time of each environment */ time: Record<string, number>;
 };
-/** The inner context. */
-export type InternalContext = RsbuildContext & {
-    /** The logger associated with current Rsbuild instance. */
-    logger: Logger;
-    /** All hooks. */
-    hooks: Readonly<Hooks>;
-    /** Current Rsbuild config. */
-    config: Readonly<RsbuildConfig>;
-    /** The original Rsbuild config passed from the createRsbuild method. */
-    originalConfig: Readonly<RsbuildConfig>;
-    /** The normalized Rsbuild config. */
-    normalizedConfig?: NormalizedConfig;
+/** The inner context. */ export type InternalContext = RsbuildContext & {
+    /** The logger associated with current Rsbuild instance. */ logger: Logger;
+    /** All hooks. */ hooks: Readonly<Hooks>;
+    /** Current Rsbuild config. */ config: Readonly<RsbuildConfig>;
+    /** The original Rsbuild config passed from the createRsbuild method. */ originalConfig: Readonly<RsbuildConfig>;
+    /** The normalized Rsbuild config. */ normalizedConfig?: NormalizedConfig;
     /**
-     * Get the plugin API.
-     * When environment is undefined, the global plugin API is returned, which
-     * can be used in all environments.
-     */
-    getPluginAPI?: (environment?: string) => RsbuildPluginAPI;
-    /** Context information for all environments. */
-    environments: Record<string, EnvironmentContext>;
-    /** Array of all environments. */
-    environmentList: EnvironmentContext[];
-    /** Only build specified environment. */
-    specifiedEnvironments?: string[];
-    /** Build state information */
-    buildState: BuildState;
-    /** The socket server instance. */
-    socketServer?: SocketServer;
+   * Get the plugin API.
+   * When environment is undefined, the global plugin API is returned, which
+   * can be used in all environments.
+   */ getPluginAPI?: (environment?: string) => RsbuildPluginAPI;
+    /** Context information for all environments. */ environments: Record<string, EnvironmentContext>;
+    /** Array of all environments. */ environmentList: EnvironmentContext[];
+    /** Only build specified environment. */ specifiedEnvironments?: string[];
+    /** Build state information */ buildState: BuildState;
+    /** The socket server instance. */ socketServer?: SocketServer;
     /**
-     * Pathnames derived from public paths, stripped of `server.base`.
-     * Used for static asset serving.
-     */
-    publicPathnames: string[];
+   * Pathnames derived from public paths, stripped of `server.base`.
+   * Used for static asset serving.
+   */ publicPathnames: string[];
 };

package/dist-types/types/hooks.d.ts

@@ -20,64 +20,54 @@ export type OnCloseBuildFn = () => MaybePromise<void>;
 export type OnBeforeBuildFn = (params: CompileCommonParams & {
     /**
      * Context information for all environments.
-     */
-    environments: Record<string, EnvironmentContext>;
+     */ environments: Record<string, EnvironmentContext>;
     bundlerConfigs?: Rspack.Configuration[];
 }) => MaybePromise<void>;
 export type OnBeforeDevCompileFn = (params: CompileCommonParams & {
     /**
      * Context information for all environments.
-     */
-    environments: Record<string, EnvironmentContext>;
+     */ environments: Record<string, EnvironmentContext>;
     bundlerConfigs?: Rspack.Configuration[];
 }) => MaybePromise<void>;
 export type OnAfterEnvironmentCompileFn = (params: CompileCommonParams & {
     stats?: Rspack.Stats;
     /**
      * The time it takes to build the current environment in milliseconds.
-     */
-    time: number;
+     */ time: number;
     environment: EnvironmentContext;
 }) => MaybePromise<void>;
 export type OnAfterBuildFn = (params: CompileCommonParams & {
     stats?: Rspack.Stats | Rspack.MultiStats;
     /**
      * Context information for all environments.
-     */
-    environments: Record<string, EnvironmentContext>;
+     */ environments: Record<string, EnvironmentContext>;
 }) => MaybePromise<void>;
 export type OnCloseDevServerFn = () => MaybePromise<void>;
 export type OnAfterDevCompileFn = (params: {
     isFirstCompile: boolean;
     stats: Rspack.Stats | Rspack.MultiStats;
     /**
-     * Context information for all environments.
-     */
-    environments: Record<string, EnvironmentContext>;
+   * Context information for all environments.
+   */ environments: Record<string, EnvironmentContext>;
 }) => MaybePromise<void>;
 /**
  * @deprecated Use `OnAfterDevCompileFn` instead.
- */
-export type OnDevCompileDoneFn = OnAfterDevCompileFn;
+ */ export type OnDevCompileDoneFn = OnAfterDevCompileFn;
 export type OnBeforeStartDevServerFn = (params: {
     /**
-     * The dev server instance, the same as the return value of `createDevServer`.
-     */
-    server: RsbuildDevServer;
+   * The dev server instance, the same as the return value of `createDevServer`.
+   */ server: RsbuildDevServer;
     /**
-     * Context information for all environments.
-     */
-    environments: Record<string, EnvironmentContext>;
+   * Context information for all environments.
+   */ environments: Record<string, EnvironmentContext>;
 }) => MaybePromise<(() => MaybePromise<void>) | void>;
 export type OnBeforeStartPreviewServerFn = (params: {
     /**
-     * The preview server instance.
-     */
-    server: RsbuildPreviewServer;
+   * The preview server instance.
+   */ server: RsbuildPreviewServer;
     /**
-     * Context information for all environments.
-     */
-    environments: Record<string, EnvironmentContext>;
+   * Context information for all environments.
+   */ environments: Record<string, EnvironmentContext>;
 }) => MaybePromise<void>;
 export type Routes = {
     entryName: string;
@@ -87,53 +77,45 @@ export type OnAfterStartDevServerFn = (params: {
     port: number;
     routes: Routes;
     /**
-     * Context information for all environments.
-     */
-    environments: Record<string, EnvironmentContext>;
+   * Context information for all environments.
+   */ environments: Record<string, EnvironmentContext>;
 }) => MaybePromise<void>;
 export type OnAfterStartPreviewServerFn = (params: {
     port: number;
     routes: Routes;
     /**
-     * Context information for all environments.
-     */
-    environments: Record<string, EnvironmentContext>;
+   * Context information for all environments.
+   */ environments: Record<string, EnvironmentContext>;
 }) => MaybePromise<void>;
 export type OnBeforeCreateCompilerFn = (params: {
     bundlerConfigs: Rspack.Configuration[];
     /**
-     * Context information for all environments.
-     */
-    environments: Record<string, EnvironmentContext>;
+   * Context information for all environments.
+   */ environments: Record<string, EnvironmentContext>;
 }) => MaybePromise<void>;
 export type OnAfterCreateCompilerFn<Compiler = Rspack.Compiler | Rspack.MultiCompiler> = (params: {
     compiler: Compiler;
     /**
-     * Context information for all environments.
-     */
-    environments: Record<string, EnvironmentContext>;
+   * Context information for all environments.
+   */ environments: Record<string, EnvironmentContext>;
 }) => MaybePromise<void>;
 export type OnExitFn = (context: {
     exitCode: number;
 }) => void;
 export type ModifyHTMLContext = {
     /**
-     * The Compilation object of Rspack.
-     */
-    compilation: Rspack.Compilation;
+   * The Compilation object of Rspack.
+   */ compilation: Rspack.Compilation;
     /**
-     * The Compiler object of Rspack.
-     */
-    compiler: Rspack.Compiler;
+   * The Compiler object of Rspack.
+   */ compiler: Rspack.Compiler;
     /**
-     * The name of the HTML file, relative to the dist directory.
-     * @example 'index.html'
-     */
-    filename: string;
+   * The name of the HTML file, relative to the dist directory.
+   * @example 'index.html'
+   */ filename: string;
     /**
-     * The environment context for current build.
-     */
-    environment: EnvironmentContext;
+   * The environment context for current build.
+   */ environment: EnvironmentContext;
 };
 export type ModifyHTMLFn = (html: string, context: ModifyHTMLContext) => MaybePromise<string>;
 type HTMLTags = {
@@ -142,136 +124,110 @@ type HTMLTags = {
 };
 export type ModifyHTMLTagsContext = Pick<ModifyHTMLContext, 'compilation' | 'compiler' | 'filename' | 'environment'> & {
     /**
-     * URL prefix of assets.
-     * @example 'https://example.com/'
-     */
-    assetPrefix: string;
+   * URL prefix of assets.
+   * @example 'https://example.com/'
+   */ assetPrefix: string;
 };
 export type ModifyHTMLTagsFn = (tags: HTMLTags, context: ModifyHTMLTagsContext) => MaybePromise<HTMLTags>;
 export type ModifyRsbuildConfigUtils = {
-    /** Merge multiple Rsbuild config objects into one. */
-    mergeRsbuildConfig: (...configs: RsbuildConfig[]) => RsbuildConfig;
+    /** Merge multiple Rsbuild config objects into one. */ mergeRsbuildConfig: (...configs: RsbuildConfig[]) => RsbuildConfig;
 };
 type ArrayAtLeastOne<A, B> = [A, ...(A | B)[]] | [...(A | B)[], A];
 export type ModifyEnvironmentConfigUtils = {
-    /** environment name. */
-    name: string;
-    /** Merge multiple Rsbuild environment config objects into one. */
-    mergeEnvironmentConfig: (...configs: ArrayAtLeastOne<MergedEnvironmentConfig, EnvironmentConfig>) => MergedEnvironmentConfig;
+    /** environment name. */ name: string;
+    /** Merge multiple Rsbuild environment config objects into one. */ mergeEnvironmentConfig: (...configs: ArrayAtLeastOne<MergedEnvironmentConfig, EnvironmentConfig>) => MergedEnvironmentConfig;
 };
 export type ModifyRsbuildConfigFn = (config: RsbuildConfig, utils: ModifyRsbuildConfigUtils) => MaybePromise<RsbuildConfig | void>;
 export type ModifyEnvironmentConfigFn = (config: MergedEnvironmentConfig, utils: ModifyEnvironmentConfigUtils) => MaybePromise<MergedEnvironmentConfig | void>;
 export type EnvironmentContext = {
     /**
-     * The index of the current environment.
-     */
-    index: number;
-    /**
-     * The unique name of the current environment is used to distinguish and locate the
-     * environment, corresponds to the key in the `environments` configuration.
-     */
-    name: string;
-    /**
-     * The entry object from the `source.entry` option.
-     */
-    entry: RsbuildEntry;
-    /**
-     * The path information for all HTML assets.
-     * This value is an object, the key is the entry name and the value is the relative
-     * path of the HTML file in the dist directory.
-     */
-    htmlPaths: Record<string, string>;
-    /**
-     * The absolute path of the output directory, corresponding to the `output.distPath.root`
-     * config of Rsbuild.
-     */
-    distPath: string;
-    /**
-     * The browserslist configuration of the current environment.
-     */
-    browserslist: string[];
-    /**
-     * The absolute path of the tsconfig.json file, or `undefined` if the tsconfig.json file
-     * does not exist in current project.
-     */
-    tsconfigPath?: string;
-    /**
-     * The normalized Rsbuild config for the current environment.
-     */
-    config: NormalizedEnvironmentConfig;
-    /**
-     * Manifest data. Only available when:
-     * - The `output.manifest` config is enabled
-     * - The build has completed, accessible in hooks like `onAfterBuild`,
-     * `onAfterDevCompile` and `onAfterEnvironmentCompile` or via the environment API
-     */
-    manifest?: Record<string, unknown> | ManifestData;
-    /**
-     * WebSocket authentication token, used to authenticate WebSocket connections and
-     * prevent unauthorized access. Only available in the development mode, and is
-     * an empty string in the production mode.
-     */
-    webSocketToken: string;
+   * The index of the current environment.
+   */ index: number;
+    /**
+   * The unique name of the current environment is used to distinguish and locate the
+   * environment, corresponds to the key in the `environments` configuration.
+   */ name: string;
+    /**
+   * The entry object from the `source.entry` option.
+   */ entry: RsbuildEntry;
+    /**
+   * The path information for all HTML assets.
+   * This value is an object, the key is the entry name and the value is the relative
+   * path of the HTML file in the dist directory.
+   */ htmlPaths: Record<string, string>;
+    /**
+   * The absolute path of the output directory, corresponding to the `output.distPath.root`
+   * config of Rsbuild.
+   */ distPath: string;
+    /**
+   * The browserslist configuration of the current environment.
+   */ browserslist: string[];
+    /**
+   * The absolute path of the tsconfig.json file, or `undefined` if the tsconfig.json file
+   * does not exist in current project.
+   */ tsconfigPath?: string;
+    /**
+   * The normalized Rsbuild config for the current environment.
+   */ config: NormalizedEnvironmentConfig;
+    /**
+   * Manifest data. Only available when:
+   * - The `output.manifest` config is enabled
+   * - The build has completed, accessible in hooks like `onAfterBuild`,
+   * `onAfterDevCompile` and `onAfterEnvironmentCompile` or via the environment API
+   */ manifest?: Record<string, unknown> | ManifestData;
+    /**
+   * WebSocket authentication token, used to authenticate WebSocket connections and
+   * prevent unauthorized access. Only available in the development mode, and is
+   * an empty string in the production mode.
+   */ webSocketToken: string;
 };
 export type ModifyChainUtils = {
     /**
-     * The value of `process.env.NODE_ENV`
-     */
-    env: string;
+   * The value of `process.env.NODE_ENV`
+   */ env: string;
     /**
-     * A boolean value indicating whether this is a development build.
-     * Set to `true` when the `mode` is `development`.
-     */
-    isDev: boolean;
+   * A boolean value indicating whether this is a development build.
+   * Set to `true` when the `mode` is `development`.
+   */ isDev: boolean;
     /**
-     * A boolean value indicating whether this is a production build.
-     * Set to `true` when the `mode` is `production`.
-     */
-    isProd: boolean;
+   * A boolean value indicating whether this is a production build.
+   * Set to `true` when the `mode` is `production`.
+   */ isProd: boolean;
     /**
-     * The current build target.
-     */
-    target: RsbuildTarget;
+   * The current build target.
+   */ target: RsbuildTarget;
     /**
-     * A boolean value indicating whether the build target is `node`.
-     * Equivalent to `target === 'node'`.
-     */
-    isServer: boolean;
+   * A boolean value indicating whether the build target is `node`.
+   * Equivalent to `target === 'node'`.
+   */ isServer: boolean;
     /**
-     * A boolean value indicating whether the build target is `web-worker`.
-     * Equivalent to `target === 'web-worker'`.
-     */
-    isWebWorker: boolean;
+   * A boolean value indicating whether the build target is `web-worker`.
+   * Equivalent to `target === 'web-worker'`.
+   */ isWebWorker: boolean;
     /**
-     * Predefined chain IDs.
-     */
-    CHAIN_ID: ChainIdentifier;
+   * Predefined chain IDs.
+   */ CHAIN_ID: ChainIdentifier;
     /**
-     * The environment context for current build.
-     */
-    environment: EnvironmentContext;
+   * The environment context for current build.
+   */ environment: EnvironmentContext;
     /**
-     * Context information for all environments.
-     */
-    environments: Record<string, EnvironmentContext>;
+   * Context information for all environments.
+   */ environments: Record<string, EnvironmentContext>;
     /**
-     * The Rspack instance, same as `import { rspack } from '@rsbuild/core'`.
-     */
-    rspack: typeof rspack;
+   * The Rspack instance, same as `import { rspack } from '@rsbuild/core'`.
+   */ rspack: typeof rspack;
     /**
-     * The default export of `html-rspack-plugin`.
-     */
-    HtmlPlugin: typeof HtmlRspackPlugin;
+   * The default export of `html-rspack-plugin`.
+   */ HtmlPlugin: typeof HtmlRspackPlugin;
 };
 export type ModifyBundlerChainUtils = ModifyChainUtils & {
     /**
-     * @deprecated Use `rspack` instead.
-     */
-    bundler: typeof rspack;
+   * @deprecated Use `rspack` instead.
+   */ bundler: typeof rspack;
 };
 export type ModifyBundlerChainFn = (chain: RspackChain, utils: ModifyBundlerChainUtils) => MaybePromise<void>;
 export type CreateAsyncHook<Callback extends (...args: any[]) => any> = {
     tap: (cb: Callback) => void;
     call: (...args: Parameters<Callback>) => Promise<Parameters<Callback>>;
 };
-export {};
+export { };