@rsbuild/core 1.3.19 → 1.3.21

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

@@ -14,7 +14,7 @@ import type { ModifyWebpackChainUtils, ModifyWebpackConfigUtils, RsbuildPlugins
 import type { RsbuildEntry, RsbuildMode, RsbuildTarget } from './rsbuild';
 import type { BundlerPluginInstance, Rspack, RspackRule } from './rspack';
 import type { CSSExtractOptions, CSSLoaderModulesOptions, CSSLoaderOptions, HtmlRspackPlugin, PostCSSLoaderOptions, PostCSSPlugin, StyleLoaderOptions, WebpackConfig } from './thirdParty';
-import type { ConfigChain, ConfigChainAsyncWithContext, ConfigChainMergeContext, ConfigChainWithContext, DeepReadonly, MaybePromise, OneOrMany } from './utils';
+import type { ConfigChain, ConfigChainMergeContext, ConfigChainWithContext, MaybePromise, OneOrMany, TwoLevelReadonly } from './utils';
 export type ToolsSwcConfig = ConfigChain<SwcLoaderOptions>;
 export type ToolsBundlerChainConfig = OneOrMany<(chain: RspackChain, utils: ModifyBundlerChainUtils) => MaybePromise<void>>;
 export type ToolsPostCSSLoaderConfig = ConfigChainWithContext<PostCSSLoaderOptions, {
@@ -26,16 +26,62 @@ export type ToolsHtmlPluginConfig = ConfigChainWithContext<HtmlRspackPlugin.Opti
     entryName: string;
     entryValue: (string | string[] | Rspack.EntryDescription)[];
 }>;
-export type WebpackMerge = <Configuration extends object>(firstConfiguration: Configuration | Configuration[], ...configurations: Configuration[]) => Configuration;
+export type RspackMerge = (firstConfiguration: Rspack.Configuration | Rspack.Configuration[], ...configurations: Rspack.Configuration[]) => Rspack.Configuration;
 export type ModifyRspackConfigUtils = ModifyChainUtils & {
     addRules: (rules: RspackRule | RspackRule[]) => void;
     appendRules: (rules: RspackRule | RspackRule[]) => void;
     prependPlugins: (plugins: BundlerPluginInstance | BundlerPluginInstance[]) => void;
     appendPlugins: (plugins: BundlerPluginInstance | BundlerPluginInstance[]) => void;
     removePlugin: (pluginName: string) => void;
-    mergeConfig: WebpackMerge;
+    mergeConfig: RspackMerge;
 };
-export type ToolsRspackConfig = ConfigChainAsyncWithContext<Rspack.Configuration, ModifyRspackConfigUtils>;
+/**
+ * Narrow the type of Rspack.Configuration to make it easier
+ * to use `tools.rspack` function. These properties are set
+ * by Rsbuild by default so they are non-nullable.
+ *
+ * - With `Rspack.Configuration`, the `plugins` property is nullable:
+ *
+ * ```js
+ * tools: {
+ *   rspack(config) {
+ *     if (!config.plugins) {
+ *       config.plugins = [];
+ *     }
+ *     config.plugins.push(new SomePlugin());
+ *   }
+ * }
+ * ```
+ *
+ * - With `NarrowedRspackConfig`, the `plugins` property is non-nullable:
+ *
+ * ```js
+ * tools: {
+ *   rspack(config) {
+ *     config.plugins.push(new SomePlugin());
+ *   }
+ * }
+ * ```
+ */
+export type NarrowedRspackConfig = Omit<Rspack.Configuration, 'plugins' | 'module' | 'resolve' | 'output'> & {
+    /**
+     * Plugins to use during compilation.
+     */
+    plugins: NonNullable<Rspack.Configuration['plugins']>;
+    /**
+     * Options for module configuration.
+     */
+    module: NonNullable<Rspack.Configuration['module']>;
+    /**
+     * Options for resolving modules.
+     */
+    resolve: NonNullable<Rspack.Configuration['resolve']>;
+    /**
+     * Configuration for the output of the compilation.
+     */
+    output: NonNullable<Rspack.Configuration['output']>;
+};
+export type ToolsRspackConfig = OneOrMany<Rspack.Configuration | ((config: NarrowedRspackConfig, ctx: ModifyRspackConfigUtils) => MaybePromise<Rspack.Configuration | void>)>;
 export type ToolsWebpackConfig = ConfigChainWithContext<WebpackConfig, ModifyWebpackConfigUtils>;
 export type ToolsWebpackChainConfig = OneOrMany<(chain: RspackChain, utils: ModifyWebpackChainUtils) => void>;
 export interface ToolsConfig {
@@ -1327,7 +1373,8 @@ export interface DevConfig {
      */
     lazyCompilation?: boolean | Rspack.LazyCompilationOptions;
 }
-export type NormalizedDevConfig = DevConfig & Required<Pick<DevConfig, 'hmr' | 'liveReload' | 'assetPrefix' | 'writeToDisk' | 'cliShortcuts'>> & {
+export type NormalizedDevConfig = Omit<DevConfig, 'watchFiles'> & Required<Pick<DevConfig, 'hmr' | 'liveReload' | 'assetPrefix' | 'writeToDisk' | 'cliShortcuts'>> & {
+    watchFiles: WatchFiles[];
     client: NormalizedClientConfig;
 };
 export interface ResolveConfig {
@@ -1474,7 +1521,7 @@ export type MergedEnvironmentConfig = {
 /**
  * The normalized Rsbuild environment config.
  */
-export type NormalizedEnvironmentConfig = DeepReadonly<Omit<MergedEnvironmentConfig, 'dev'> & {
+export type NormalizedEnvironmentConfig = TwoLevelReadonly<Omit<MergedEnvironmentConfig, 'dev'> & {
     dev: NormalizedDevConfig;
     server: NormalizedServerConfig;
     _privateMeta?: RsbuildConfigMeta;

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

@@ -13,10 +13,29 @@ export type RsbuildContext = {
     distPath: string;
     /** Absolute path of cache files. */
     cachePath: string;
-    /** Info of dev server  */
+    /**
+     * 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 port number the server is listening on. */
         port: number;
+        /** Whether the server is using HTTPS protocol. */
         https: boolean;
     };
     /**

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

@@ -2,7 +2,7 @@
 import type { RuleSetRule, Configuration as WebpackConfig, WebpackPluginInstance } from 'webpack';
 import type RspackChain from '../../compiled/rspack-chain';
 import type { ChainIdentifier } from '../configChain';
-import type { ModifyRspackConfigUtils, NormalizedConfig, NormalizedEnvironmentConfig, RsbuildConfig, WebpackMerge } from './config';
+import type { ModifyRspackConfigUtils, NarrowedRspackConfig, NormalizedConfig, NormalizedEnvironmentConfig, RsbuildConfig, RspackMerge } from './config';
 import type { RsbuildContext } from './context';
 import type { EnvironmentContext, ModifyBundlerChainFn, ModifyChainUtils, ModifyEnvironmentConfigFn, ModifyHTMLFn, ModifyHTMLTagsFn, ModifyRsbuildConfigFn, OnAfterBuildFn, OnAfterCreateCompilerFn, OnAfterEnvironmentCompileFn, OnAfterStartDevServerFn, OnAfterStartProdServerFn, OnBeforeBuildFn, OnBeforeCreateCompilerFn, OnBeforeEnvironmentCompileFn, OnBeforeStartDevServerFn, OnBeforeStartProdServerFn, OnCloseBuildFn, OnCloseDevServerFn, OnDevCompileDoneFn, OnExitFn } from './hooks';
 import type { RsbuildInstance, RsbuildTarget } from './rsbuild';
@@ -92,7 +92,7 @@ export type AsyncHook<Callback extends (...args: any[]) => T, T = any> = {
      */
     callBatch: (...args: Parameters<Callback>) => Promise<Awaited<ReturnType<Callback>>[]>;
 };
-export type ModifyRspackConfigFn = (config: Rspack.Configuration, utils: ModifyRspackConfigUtils) => MaybePromise<Rspack.Configuration | void>;
+export type ModifyRspackConfigFn = (config: NarrowedRspackConfig, utils: ModifyRspackConfigUtils) => MaybePromise<Rspack.Configuration | void>;
 export type ModifyWebpackChainUtils = ModifyChainUtils & {
     /** @ts-ignore `webpack` type only exists when `@rsbuild/webpack` is installed */
     webpack: typeof import('webpack');
@@ -112,7 +112,7 @@ export type ModifyWebpackConfigUtils = ModifyWebpackChainUtils & {
     prependPlugins: (plugins: WebpackPluginInstance | WebpackPluginInstance[]) => void;
     appendPlugins: (plugins: WebpackPluginInstance | WebpackPluginInstance[]) => void;
     removePlugin: (pluginName: string) => void;
-    mergeConfig: WebpackMerge;
+    mergeConfig: RspackMerge;
 };
 export type ModifyWebpackChainFn = (chain: RspackChain, utils: ModifyWebpackChainUtils) => Promise<void> | void;
 export type ModifyWebpackConfigFn = (config: WebpackConfig, utils: ModifyWebpackConfigUtils) => Promise<WebpackConfig | void> | WebpackConfig | void;

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

@@ -1,8 +1,13 @@
 export type Falsy = false | null | undefined;
 export type OneOrMany<T> = T | T[];
 export type MaybePromise<T> = T | Promise<T>;
-export type DeepReadonly<T> = keyof T extends never ? T : {
-    readonly [k in keyof T]: DeepReadonly<T[k]>;
+/**
+ * Creates a type with readonly properties at the first and second levels only.
+ */
+export type TwoLevelReadonly<T> = keyof T extends never ? T : {
+    readonly [k in keyof T]: T[k] extends object ? {
+        readonly [p in keyof T[k]]: T[k][p];
+    } : T[k];
 };
 export type ConfigChain<T> = OneOrMany<T | ((config: T) => T | void)>;
 export type ConfigChainWithContext<T, Ctx> = OneOrMany<T | ((config: T, ctx: Ctx) => T | void)>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rsbuild/core",
-  "version": "1.3.19",
+  "version": "1.3.21",
   "description": "The Rspack-based build tool.",
   "homepage": "https://rsbuild.dev",
   "bugs": {
@@ -46,17 +46,17 @@
     "types.d.ts"
   ],
   "dependencies": {
-    "@rspack/core": "1.3.9",
+    "@rspack/core": "1.3.11",
     "@rspack/lite-tapable": "~1.0.1",
     "@swc/helpers": "^0.5.17",
     "core-js": "~3.42.0",
     "jiti": "^2.4.2"
   },
   "devDependencies": {
-    "@rslib/core": "0.6.9",
+    "@rslib/core": "0.7.1",
     "@types/connect": "3.4.38",
     "@types/cors": "^2.8.18",
-    "@types/node": "^22.15.17",
+    "@types/node": "^22.15.19",
     "@types/on-finished": "2.3.4",
     "@types/webpack-bundle-analyzer": "4.7.0",
     "@types/ws": "^8.18.1",
@@ -90,7 +90,7 @@
     "style-loader": "3.3.4",
     "tinyglobby": "^0.2.13",
     "typescript": "^5.8.3",
-    "webpack": "^5.98.0",
+    "webpack": "^5.99.8",
     "webpack-bundle-analyzer": "^4.10.2",
     "webpack-merge": "6.0.1",
     "ws": "^8.18.2"

package/dist-types/provider/inspectConfig.d.ts

@@ -1,6 +0,0 @@
-import type { InspectConfigOptions, InspectConfigResult, Rspack } from '../types';
-import { type InitConfigsOptions } from './initConfigs';
-export declare function inspectConfig({ context, pluginManager, rsbuildOptions, bundlerConfigs, inspectOptions, }: InitConfigsOptions & {
-    inspectOptions?: InspectConfigOptions;
-    bundlerConfigs?: Rspack.Configuration[];
-}): Promise<InspectConfigResult<'rspack'>>;