@rsbuild/core 2.1.6 → 2.1.8

package/{dist-types → dist}/types/config.d.ts

@@ -3,20 +3,20 @@ import type { SecureServerSessionOptions } from 'node:http2';
 import type { ServerOptions as HttpsServerOptions } from 'node:https';
 import type { URL } from 'node:url';
 import type { CopyRspackPluginOptions, DefinePluginOptions, Externals, LightningCssMinimizerRspackPluginOptions, ModuleFederationPluginOptions, RuleSetCondition, SwcJsMinimizerRspackPluginOptions, SwcLoaderOptions } from '@rspack/core';
-import type { ChokidarOptions } from '../../compiled/chokidar';
-import type Cors from '../../compiled/cors';
-import type { Options as HttpProxyOptions, Filter as ProxyFilter } from '../../compiled/http-proxy-middleware';
-import type { RspackChain } from '../../compiled/rspack-chain/types';
-import type { FileDescriptor } from '../../compiled/rspack-manifest-plugin';
-import type { HotSend, RsbuildDevServer } from '../server/devServer';
-import type { RsbuildPreviewServer } from '../server/previewServer';
-import type { Logger } from '../logger';
-import type { EnvironmentContext, ModifyBundlerChainUtils, ModifyChainUtils, Routes } from './hooks';
-import type { RsbuildPlugins } from './plugin';
-import type { RsbuildEntry, RsbuildMode, RsbuildTarget } from './rsbuild';
-import type { Rspack, RspackRule } from './rspack';
-import type { Connect, CSSExtractOptions, CSSLoaderModulesOptions, CSSLoaderOptions, HtmlRspackPlugin, LoosePostCSSPlugin, PostCSSLoaderOptions, StyleLoaderOptions } from './thirdParty';
-import type { ConfigChain, ConfigChainAsyncWithContext, ConfigChainWithContext, LiteralUnion, MaybePromise, OneOrMany, Optional, TwoLevelReadonly } from './utils';
+import type { ChokidarOptions } from '../../compiled/chokidar/index.js';
+import type Cors from '../../compiled/cors/index.js';
+import type { Options as HttpProxyOptions, Filter as ProxyFilter } from '../../compiled/http-proxy-middleware/index.js';
+import type { RspackChain } from '../../compiled/rspack-chain/types/index.js';
+import type { FileDescriptor } from '../../compiled/rspack-manifest-plugin/index.js';
+import type { HotSend, RsbuildDevServer } from '../server/devServer.js';
+import type { RsbuildPreviewServer } from '../server/previewServer.js';
+import type { Logger } from '../logger.js';
+import type { EnvironmentContext, ModifyBundlerChainUtils, ModifyChainUtils, Routes, WatchFileEvent } from './hooks.js';
+import type { RsbuildPlugins } from './plugin.js';
+import type { RsbuildEntry, RsbuildMode, RsbuildTarget } from './rsbuild.js';
+import type { Rspack, RspackRule } from './rspack.js';
+import type { Connect, CSSExtractOptions, CSSLoaderModulesOptions, CSSLoaderOptions, HtmlRspackPlugin, LoosePostCSSPlugin, PostCSSLoaderOptions, StyleLoaderOptions } from './thirdParty.js';
+import type { ConfigChain, ConfigChainAsyncWithContext, ConfigChainWithContext, LiteralUnion, MaybePromise, OneOrMany, Optional, TwoLevelReadonly } from './utils.js';
 export type ToolsSwcConfig = ConfigChain<SwcLoaderOptions>;
 export type ToolsBundlerChainConfig = OneOrMany<(chain: RspackChain, utils: ModifyBundlerChainUtils) => MaybePromise<void>>;
 export type ToolsPostCSSContext = {
@@ -870,8 +870,10 @@ export type Minify = boolean | {
        */ js?: boolean | 'always';
     /**
        * Minimizer options of JavaScript, which will be passed to SWC.
+       * When using an array, each item registers a separate minimizer and the first matching item
+       * applies to each JavaScript asset.
        * @default {}
-       */ jsOptions?: SwcJsMinimizerRspackPluginOptions;
+       */ jsOptions?: OneOrMany<SwcJsMinimizerRspackPluginOptions>;
     /**
        * Whether to enable minification for CSS bundles.
        * - `true`: Enabled in production mode.
@@ -881,8 +883,10 @@ export type Minify = boolean | {
        */ css?: boolean | 'always';
     /**
        * Minimizer options of CSS, which will be passed to LightningCSS.
+       * When using an array, each item registers a separate minimizer and the first matching item
+       * applies to each CSS asset.
        * @default inherit from `tools.lightningcssLoader` config
-       */ cssOptions?: LightningCssMinimizerRspackPluginOptions;
+       */ cssOptions?: OneOrMany<LightningCssMinimizerRspackPluginOptions>;
 };
 export type InlineChunkTestFunction = (params: {
     size: number;
@@ -1497,12 +1501,22 @@ export type WatchFiles = {
    * Paths of the files or directories to watch, supports glob syntax.
    */ paths: string | string[];
     /**
+   * File events that trigger the configured action.
+   * - `add`: A file is created.
+   * - `change`: A file is modified.
+   * - `unlink`: A file is deleted.
+   * @default ['add', 'change', 'unlink']
+   */ events?: WatchFileEvent[];
+    /**
    * Watch options passed to [chokidar](https://github.com/paulmillr/chokidar).
    */ options?: ChokidarOptions;
     /**
-   * Specifies whether to reload the page or restart the dev server when files change.
+   * Specifies the action to take when files change.
+   * - `reload-page`: Reload the page.
+   * - `restart`: Trigger a restart request for the dev server or watch build.
+   * - `reload-server`: Deprecated alias for `restart`.
    * @default 'reload-page'
-   */ type?: 'reload-page' | 'reload-server';
+   */ type?: 'reload-page' | 'restart' | 'reload-server';
 };
 export type CliShortcut = {
     /**
@@ -1589,7 +1603,7 @@ export interface DevConfig {
    */ writeToDisk?: WriteToDisk;
     /**
    * Watch specified files and directories for changes. When a file change is detected,
-   * it can trigger a page reload or restart the dev server.
+   * it can trigger a page reload or a restart request for the dev server or watch build.
    * @default undefined
    */ watchFiles?: WatchFiles | WatchFiles[];
     /**
@@ -1649,6 +1663,9 @@ export type RsbuildConfigMeta = {
     /**
    * Path to the rsbuild config file.
    */ configFilePath: string;
+    /**
+   * Paths to files imported by the rsbuild config file.
+   */ configFileDependencies?: string[];
 };
 /**
  * Only some dev options can be defined in the environment config

package/{dist-types → dist}/types/context.d.ts

@@ -1,15 +1,18 @@
-import type { Hooks } from '../hooks';
-import type { Logger } from '../logger';
-import type { SocketServer } from '../server/socketServer';
-import type { NormalizedConfig, RsbuildConfig } from './config';
-import type { EnvironmentContext } from './hooks';
-import type { RsbuildPluginAPI } from './plugin';
-import type { RsbuildStats } from './rsbuild';
+import type { Hooks } from '../hooks.js';
+import type { RestartManager } from '../helpers/restartManager.js';
+import type { Logger } from '../logger.js';
+import type { SocketServer } from '../server/socketServer.js';
+import type { NormalizedConfig, RsbuildConfig } from './config.js';
+import type { EnvironmentContext } from './hooks.js';
+import type { RsbuildPluginAPI } from './plugin.js';
+import type { RsbuildStats } from './rsbuild.js';
 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 to the loaded configuration file. */ configFile?: string;
+    /** Absolute paths of files imported by the configuration file. */ configFileDependencies: readonly string[];
     /** Absolute path of output files. */ distPath: string;
     /** Absolute path of cache files. */ cachePath: string;
     /**
@@ -65,6 +68,7 @@ export type BuildState = {
 /** The inner context. */ export type InternalContext = RsbuildContext & {
     /** The logger associated with current Rsbuild instance. */ logger: Logger;
     /** All hooks. */ hooks: Readonly<Hooks>;
+    /** Manage callbacks for restarting the current Rsbuild instance. */ restartManager: RestartManager;
     /** Current Rsbuild config. */ config: Readonly<RsbuildConfig>;
     /** The original Rsbuild config passed from the createRsbuild method. */ originalConfig: Readonly<RsbuildConfig>;
     /** The normalized Rsbuild config. */ normalizedConfig?: NormalizedConfig;

package/{dist-types → dist}/types/hooks.d.ts

@@ -1,13 +1,13 @@
 import type { rspack } from '@rspack/core';
-import type { ChainIdentifier, ManifestData } from '..';
-import type { RsbuildDevServer } from '../server/devServer';
-import type { RsbuildPreviewServer } from '../server/previewServer';
-import type { RspackChain } from '../types';
-import type { EnvironmentConfig, HtmlBasicTag, MergedEnvironmentConfig, NormalizedEnvironmentConfig, RsbuildConfig } from './config';
-import type { RsbuildEntry, RsbuildTarget } from './rsbuild';
-import type { Rspack } from './rspack';
-import type { HtmlRspackPlugin } from './thirdParty';
-import type { MaybePromise } from './utils';
+import type { ChainIdentifier, ManifestData } from '../index.js';
+import type { RsbuildDevServer } from '../server/devServer.js';
+import type { RsbuildPreviewServer } from '../server/previewServer.js';
+import type { RspackChain } from '../types/index.js';
+import type { EnvironmentConfig, HtmlBasicTag, MergedEnvironmentConfig, NormalizedEnvironmentConfig, RsbuildConfig } from './config.js';
+import type { BuildOptions, RsbuildEntry, RsbuildTarget, StartDevServerOptions } from './rsbuild.js';
+import type { Rspack } from './rspack.js';
+import type { HtmlRspackPlugin } from './thirdParty.js';
+import type { MaybePromise } from './utils.js';
 type CompileCommonParams = {
     isFirstCompile: boolean;
     isWatch: boolean;
@@ -102,6 +102,33 @@ export type OnAfterCreateCompilerFn<Compiler = Rspack.Compiler | Rspack.MultiCom
 export type OnExitFn = (context: {
     exitCode: number;
 }) => void;
+export type WatchFileEvent = 'add' | 'change' | 'unlink';
+export type RestartContext = {
+    /**
+   * The absolute path of the file that triggered the restart.
+   * It is undefined when the restart is manually triggered.
+   */ filePath?: string;
+    /**
+   * The file event that triggered the restart.
+   * It is undefined when the restart is manually triggered.
+   */ event?: WatchFileEvent;
+} & ({
+    /**
+       * The current Rsbuild action being restarted.
+       */ action: 'build';
+    /**
+       * The options passed to `rsbuild.build()`.
+       */ options: BuildOptions;
+} | {
+    /**
+       * The current Rsbuild action being restarted.
+       */ action: 'dev';
+    /**
+       * The options passed to `rsbuild.startDevServer()`.
+       */ options: StartDevServerOptions;
+});
+/** Restart the current Rsbuild task and return whether the restart succeeded. */ export type RestartFn = (context: RestartContext) => MaybePromise<boolean>;
+export type OnRestartFn = (context: RestartContext) => MaybePromise<void>;
 export type ModifyHTMLContext = {
     /**
    * The Compilation object of Rspack.

package/dist/types/index.d.ts

@@ -0,0 +1,8 @@
+export type * from './config.js';
+export type * from './context.js';
+export type * from './hooks.js';
+export type * from './plugin.js';
+export type * from './rsbuild.js';
+export type * from './rspack.js';
+export type * from './thirdParty.js';
+export type * from './utils.js';

package/{dist-types → dist}/types/plugin.d.ts

@@ -1,10 +1,10 @@
-import type { Logger } from '../logger';
-import type { ModifyRspackConfigUtils, NarrowedRspackConfig, NormalizedConfig, NormalizedEnvironmentConfig, RsbuildConfig } from './config';
-import type { RsbuildContext } from './context';
-import type { EnvironmentContext, ModifyBundlerChainFn, ModifyEnvironmentConfigFn, ModifyHTMLFn, ModifyHTMLTagsFn, ModifyRsbuildConfigFn, OnAfterBuildFn, OnAfterCreateCompilerFn, OnAfterDevCompileFn, OnAfterEnvironmentCompileFn, OnAfterStartDevServerFn, OnAfterStartPreviewServerFn, OnBeforeBuildFn, OnBeforeCreateCompilerFn, OnBeforeDevCompileFn, OnBeforeEnvironmentCompileFn, OnBeforeStartDevServerFn, OnBeforeStartPreviewServerFn, OnCloseBuildFn, OnCloseDevServerFn, OnExitFn } from './hooks';
-import type { AddPluginsOptions, RsbuildInstance, RsbuildTarget } from './rsbuild';
-import type { Rspack } from './rspack';
-import type { Falsy, MaybePromise } from './utils';
+import type { Logger } from '../logger.js';
+import type { ModifyRspackConfigUtils, NarrowedRspackConfig, NormalizedConfig, NormalizedEnvironmentConfig, RsbuildConfig } from './config.js';
+import type { RsbuildContext } from './context.js';
+import type { EnvironmentContext, ModifyBundlerChainFn, ModifyEnvironmentConfigFn, ModifyHTMLFn, ModifyHTMLTagsFn, ModifyRsbuildConfigFn, OnAfterBuildFn, OnAfterCreateCompilerFn, OnAfterDevCompileFn, OnAfterEnvironmentCompileFn, OnAfterStartDevServerFn, OnAfterStartPreviewServerFn, OnBeforeBuildFn, OnBeforeCreateCompilerFn, OnBeforeDevCompileFn, OnBeforeEnvironmentCompileFn, OnBeforeStartDevServerFn, OnBeforeStartPreviewServerFn, OnCloseBuildFn, OnCloseDevServerFn, OnExitFn, OnRestartFn } from './hooks.js';
+import type { AddPluginsOptions, RsbuildInstance, RsbuildTarget } from './rsbuild.js';
+import type { Rspack } from './rspack.js';
+import type { Falsy, MaybePromise } from './utils.js';
 type HookOrder = 'pre' | 'post' | 'default';
 export type HookDescriptor<T extends (...args: any[]) => any> = {
     handler: T;
@@ -452,6 +452,9 @@ export type GetNormalizedConfig = {
    * synchronous code.
    */ onExit: PluginHook<OnExitFn>;
     /**
+   * Called when a restart is requested for the dev server or watch build.
+   */ onRestart: PluginHook<OnRestartFn>;
+    /**
    * Modify assets before emitting, the same as Rspack's
    * [compilation.hooks.processAssets](https://rspack.rs/api/plugin-api/compilation-hooks#processassets) hook.
    */ processAssets: ProcessAssetsHook;

package/{dist-types → dist}/types/rsbuild.d.ts

@@ -1,13 +1,15 @@
 import type { Compiler, MultiCompiler } from '@rspack/core';
-import type { LoadEnvOptions } from '../loadEnv';
-import type { Logger } from '../logger';
-import type { RsbuildDevServer } from '../server/devServer';
-import type { StartDevServerResult, StartPreviewServerResult } from '../server/helper';
-import type { NormalizedConfig, NormalizedEnvironmentConfig, RsbuildConfig } from './config';
-import type { RsbuildContext } from './context';
-import type { RsbuildPlugin, RsbuildPluginAPI } from './plugin';
-import type { Rspack } from './rspack';
-import type { Falsy } from './utils';
+import type { LoadConfigResult } from '../loadConfig.js';
+import type { LoadEnvOptions } from '../loadEnv.js';
+import type { Logger } from '../logger.js';
+import type { RsbuildDevServer } from '../server/devServer.js';
+import type { StartDevServerResult, StartPreviewServerResult } from '../server/helper.js';
+import type { NormalizedConfig, NormalizedEnvironmentConfig, RsbuildConfig } from './config.js';
+import type { RsbuildContext } from './context.js';
+import type { RestartFn } from './hooks.js';
+import type { RsbuildPlugin, RsbuildPluginAPI } from './plugin.js';
+import type { Rspack } from './rspack.js';
+import type { Falsy } from './utils.js';
 export type StartDevServerOptions = {
     /**
    * Whether to get port silently and not print any logs.
@@ -90,6 +92,7 @@ export type InspectConfigResult = {
     };
 };
 export type CreateCompiler = () => Promise<Compiler | MultiCompiler>;
+type RsbuildConfigInput = RsbuildConfig | LoadConfigResult;
 export type CreateRsbuildOptions = {
     /**
    * The root path of current project.
@@ -109,18 +112,21 @@ export type CreateRsbuildOptions = {
     /**
    * Alias for `config`.
    * This option will be deprecated in the future.
-   */ rsbuildConfig?: RsbuildConfig | (() => Promise<RsbuildConfig>);
+   */ rsbuildConfig?: RsbuildConfigInput | (() => Promise<RsbuildConfigInput>);
     /**
-   * Rsbuild configurations.
+   * Rsbuild configuration or the result returned by `loadConfig`.
    * Passing a function to load the config asynchronously with custom logic.
-   */ config?: RsbuildConfig | (() => Promise<RsbuildConfig>);
+   */ config?: RsbuildConfigInput | (() => Promise<RsbuildConfigInput>);
     /**
    * Whether to call `loadEnv` to load environment variables and define them
    * as global variables via `source.define`.
    * @default false
    */ loadEnv?: boolean | LoadEnvOptions;
+    /**
+   * Function used to restart the current dev server or watch build.
+   */ restart?: RestartFn;
 };
-export type ResolvedCreateRsbuildOptions = Required<Pick<CreateRsbuildOptions, 'cwd' | 'callerName'>> & Pick<CreateRsbuildOptions, 'loadEnv' | 'environment'> & {
+export type ResolvedCreateRsbuildOptions = Required<Pick<CreateRsbuildOptions, 'cwd' | 'callerName'>> & Pick<CreateRsbuildOptions, 'loadEnv' | 'environment' | 'restart'> & {
     rsbuildConfig: RsbuildConfig;
 };
 export type CreateDevServer = (options?: CreateDevServerOptions) => Promise<RsbuildDevServer>;
@@ -214,7 +220,7 @@ export type RsbuildInstance = {
    * 1. Start a development server that serves your application.
    * 2. Watch for file changes and trigger recompilation.
    */ startDevServer: StartDevServer;
-} & Pick<RsbuildPluginAPI, 'context' | 'expose' | 'getNormalizedConfig' | 'getRsbuildConfig' | 'isPluginExists' | 'modifyEnvironmentConfig' | 'modifyRsbuildConfig' | 'onAfterBuild' | 'onAfterCreateCompiler' | 'onAfterDevCompile' | 'onAfterEnvironmentCompile' | 'onAfterStartDevServer' | 'onAfterStartPreviewServer' | 'onBeforeBuild' | 'onBeforeCreateCompiler' | 'onBeforeDevCompile' | 'onBeforeEnvironmentCompile' | 'onBeforeStartDevServer' | 'onBeforeStartPreviewServer' | 'onCloseBuild' | 'onCloseDevServer' | 'onDevCompileDone' | 'onExit'>;
+} & Pick<RsbuildPluginAPI, 'context' | 'expose' | 'getNormalizedConfig' | 'getRsbuildConfig' | 'isPluginExists' | 'modifyEnvironmentConfig' | 'modifyRsbuildConfig' | 'onAfterBuild' | 'onAfterCreateCompiler' | 'onAfterDevCompile' | 'onAfterEnvironmentCompile' | 'onAfterStartDevServer' | 'onAfterStartPreviewServer' | 'onBeforeBuild' | 'onBeforeCreateCompiler' | 'onBeforeDevCompile' | 'onBeforeEnvironmentCompile' | 'onBeforeStartDevServer' | 'onBeforeStartPreviewServer' | 'onCloseBuild' | 'onCloseDevServer' | 'onDevCompileDone' | 'onExit' | 'onRestart'>;
 export type RsbuildTarget = 'web' | 'node' | 'web-worker';
 export type RsbuildEntryDescription = Rspack.EntryDescription & {
     /**
@@ -231,3 +237,4 @@ export type RsbuildStatsItem = Pick<Rspack.StatsCompilation, 'errors' | 'warning
  */ export type RsbuildStats = RsbuildStatsItem & {
     children: RsbuildStatsItem[];
 };
+export { };

package/{dist-types → dist}/types/rspack.d.ts

@@ -1,6 +1,6 @@
 import type * as Rspack from '@rspack/core';
-import type { RspackChain } from '../../compiled/rspack-chain/types';
-import type { TransformHandler } from './plugin';
+import type { RspackChain } from '../../compiled/rspack-chain/types/index.js';
+import type { TransformHandler } from './plugin.js';
 export type { Rspack, RspackChain };
 declare module '@rspack/core' {
     interface Compiler {

package/{dist-types → dist}/types/thirdParty.d.ts

@@ -1,9 +1,9 @@
 import type { CssExtractRspackLoaderOptions, CssExtractRspackPluginOptions } from '@rspack/core';
-import type * as Connect from '../../compiled/connect-next';
-import type HtmlRspackPlugin from '../../compiled/html-rspack-plugin';
-import type { AcceptedPlugin, ProcessOptions } from '../../compiled/postcss';
-import type { Rspack } from './rspack';
-import type { LiteralUnion } from './utils';
+import type * as Connect from '../../compiled/connect-next/index.js';
+import type HtmlRspackPlugin from '../../compiled/html-rspack-plugin/index.js';
+import type { AcceptedPlugin, ProcessOptions } from '../../compiled/postcss/lib/postcss.js';
+import type { Rspack } from './rspack.js';
+import type { LiteralUnion } from './utils.js';
 export type { Connect };
 export type { HtmlRspackPlugin };
 export interface CSSExtractOptions {