@rsbuild/core 2.1.7 → 2.1.9

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 = {
@@ -883,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;
@@ -1499,6 +1501,13 @@ 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;
     /**

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

@@ -1,11 +1,11 @@
-import type { Hooks } from '../hooks';
-import type { RestartManager } from '../helpers/restartManager';
-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 = {
@@ -24,7 +24,7 @@ export type ActionType = 'dev' | 'build' | 'preview';
    * import { createRsbuild } from '@rsbuild/core';
    *
    * async function main() {
-   *   const rsbuild = createRsbuild({
+   *   const rsbuild = await createRsbuild({
    *     // ...
    *   });
    *   await rsbuild.startDevServer();

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,15 +102,31 @@ 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 current Rsbuild action being restarted.
-   */ action: 'dev' | 'build';
-    /**
    * 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 = {
@@ -188,8 +204,8 @@ export type EnvironmentContext = {
    */ 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.
+   * prevent unauthorized access. It contains a token when running the `dev` action
+   * and is an empty string for other actions.
    */ webSocketToken: string;
 };
 export type ModifyChainUtils = {

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, OnRestartFn } 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;

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

@@ -1,15 +1,15 @@
 import type { Compiler, MultiCompiler } from '@rspack/core';
-import type { LoadConfigResult } from '../loadConfig';
-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 { RestartFn } from './hooks';
-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.
@@ -52,8 +52,9 @@ export type InitConfigsOptions = Pick<RsbuildContext, 'action'>;
 export type InspectConfigOptions = {
     /**
    * Inspect the config in the specified mode.
-   * Available options: 'development' or 'production'.
-   * @default 'development'
+   * Available options: 'development', 'production', or 'none'.
+   * @default Inferred from `process.env.NODE_ENV`: 'development' when unset,
+   * 'development' or 'production' when matching, otherwise 'none'.
    */ mode?: RsbuildMode;
     /**
    * Enables verbose mode to display the complete function
@@ -62,7 +63,7 @@ export type InspectConfigOptions = {
    */ verbose?: boolean;
     /**
    * Specify the output path for inspection results.
-   * @default 'output.distPath.root'
+   * @default '<context.distPath>/.rsbuild'
    */ outputPath?: string;
     /**
    * Whether to write the inspection results to disk.

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 {