@rsbuild/core 1.2.15 → 1.2.17

package/dist/index.js.LICENSE.txt

@@ -0,0 +1,20 @@
+/*!
+ * is-plain-object <https://github.com/jonschlinkert/is-plain-object>
+ *
+ * Copyright (c) 2014-2017, Jon Schlinkert.
+ * Released under the MIT License.
+ */
+
+/*!
+ * isobject <https://github.com/jonschlinkert/isobject>
+ *
+ * Copyright (c) 2014-2017, Jon Schlinkert.
+ * Released under the MIT License.
+ */
+
+/*!
+ * shallow-clone <https://github.com/jonschlinkert/shallow-clone>
+ *
+ * Copyright (c) 2015-present, Jon Schlinkert.
+ * Released under the MIT License.
+ */

package/dist-types/configChain.d.ts

@@ -1,6 +1,5 @@
 import RspackChain from '../compiled/rspack-chain/index.js';
 import type { InternalContext, ModifyBundlerChainUtils } from './types';
-export declare function getBundlerChain(): RspackChain;
 export declare function modifyBundlerChain(context: InternalContext, utils: ModifyBundlerChainUtils): Promise<RspackChain>;
 export declare const CHAIN_ID: {
     /** Predefined rules */

package/dist-types/helpers/path.d.ts

@@ -1,4 +1,5 @@
 export declare function getAbsolutePath(base: string, filepath: string): string;
+export declare function getRelativePath(base: string, filepath: string): string;
 export declare function getCommonParentPath(paths: string[]): string;
 export declare const getCompiledPath: (packageName: string) => string;
 /**

package/dist-types/server/overlay.d.ts

@@ -1,2 +1,2 @@
-export declare function convertLinksInHtml(text: string): string;
-export declare function genOverlayHTML(errors: string[]): string;
+export declare function convertLinksInHtml(text: string, root?: string): string;
+export declare function genOverlayHTML(errors: string[], root?: string): string;

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

@@ -25,13 +25,14 @@ 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 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: typeof import('../../compiled/webpack-merge/index.js').merge;
+    mergeConfig: WebpackMerge;
     rspack: typeof rspack;
 };
 export type ToolsRspackConfig = ConfigChainAsyncWithContext<Rspack.Configuration, ModifyRspackConfigUtils>;
@@ -457,7 +458,7 @@ export interface PerformanceConfig {
     /**
      * Configure the chunk splitting strategy.
      */
-    chunkSplit?: RsbuildChunkSplit;
+    chunkSplit?: ChunkSplit;
     /**
      * Analyze the size of output files.
      */
@@ -497,7 +498,7 @@ export interface PerformanceConfig {
 }
 export interface NormalizedPerformanceConfig extends PerformanceConfig {
     printFileSize: PrintFileSizeOptions | boolean;
-    chunkSplit: RsbuildChunkSplit;
+    chunkSplit: ChunkSplit;
 }
 export type SplitChunks = Configuration extends {
     optimization?: {
@@ -522,7 +523,7 @@ export interface SplitCustom extends BaseSplitRules {
     strategy: 'custom';
     splitChunks?: SplitChunks;
 }
-export type RsbuildChunkSplit = BaseChunkSplit | SplitBySize | SplitCustom;
+export type ChunkSplit = BaseChunkSplit | SplitBySize | SplitCustom;
 export type DistPathConfig = {
     /**
      * The root directory of all files.

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

@@ -111,12 +111,38 @@ export type ModifyRsbuildConfigFn = (config: RsbuildConfig, utils: ModifyRsbuild
 export type ModifyEnvironmentConfigFn = (config: MergedEnvironmentConfig, utils: ModifyEnvironmentConfigUtils) => MaybePromise<MergedEnvironmentConfig | void>;
 export type EnvironmentContext = {
     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;
 };
 export type ModifyChainUtils = {

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

@@ -1,7 +1,7 @@
 import type { RuleSetRule, Configuration as WebpackConfig, WebpackPluginInstance } from 'webpack';
 import type RspackChain from '../../compiled/rspack-chain/index.js';
 import type { ChainIdentifier } from '../configChain';
-import type { ModifyRspackConfigUtils, NormalizedConfig, NormalizedEnvironmentConfig, RsbuildConfig } from './config';
+import type { ModifyRspackConfigUtils, NormalizedConfig, NormalizedEnvironmentConfig, RsbuildConfig, WebpackMerge } from './config';
 import type { RsbuildContext } from './context';
 import type { EnvironmentContext, ModifyBundlerChainFn, ModifyChainUtils, ModifyEnvironmentConfigFn, ModifyHTMLTagsFn, ModifyRsbuildConfigFn, OnAfterBuildFn, OnAfterCreateCompilerFn, OnAfterEnvironmentCompileFn, OnAfterStartDevServerFn, OnAfterStartProdServerFn, OnBeforeBuildFn, OnBeforeCreateCompilerFn, OnBeforeEnvironmentCompileFn, OnBeforeStartDevServerFn, OnBeforeStartProdServerFn, OnCloseBuildFn, OnCloseDevServerFn, OnDevCompileDoneFn, OnExitFn } from './hooks';
 import type { RsbuildInstance, RsbuildTarget } from './rsbuild';
@@ -110,7 +110,7 @@ export type ModifyWebpackConfigUtils = ModifyWebpackChainUtils & {
     prependPlugins: (plugins: WebpackPluginInstance | WebpackPluginInstance[]) => void;
     appendPlugins: (plugins: WebpackPluginInstance | WebpackPluginInstance[]) => void;
     removePlugin: (pluginName: string) => void;
-    mergeConfig: typeof import('../../compiled/webpack-merge/index.js').merge;
+    mergeConfig: WebpackMerge;
 };
 export type ModifyWebpackChainFn = (chain: RspackChain, utils: ModifyWebpackChainUtils) => Promise<void> | void;
 export type ModifyWebpackConfigFn = (config: WebpackConfig, utils: ModifyWebpackConfigUtils) => Promise<WebpackConfig | void> | WebpackConfig | void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rsbuild/core",
-  "version": "1.2.15",
+  "version": "1.2.17",
   "description": "The Rspack-based build tool.",
   "homepage": "https://rsbuild.dev",
   "bugs": {
@@ -53,12 +53,12 @@
     "jiti": "^2.4.2"
   },
   "devDependencies": {
-    "@rslib/core": "0.5.2",
+    "@rslib/core": "0.5.3",
     "@types/connect": "3.4.38",
-    "@types/node": "^22.13.8",
+    "@types/node": "^22.13.10",
     "@types/on-finished": "2.3.4",
     "@types/webpack-bundle-analyzer": "4.7.0",
-    "@types/ws": "^8.5.14",
+    "@types/ws": "^8.18.0",
     "browserslist-load-config": "1.0.0",
     "cac": "^6.7.14",
     "chokidar": "^4.0.3",

package/compiled/webpack-merge/index.d.ts

@@ -1,31 +0,0 @@
-declare function mergeUnique(key: string, uniques: string[], getter: (a: object) => string): (a: [], b: [], k: string) => false | any[];
-
-type Key = string;
-type Customize = (a: any, b: any, key: Key) => any;
-interface ICustomizeOptions {
-    customizeArray?: Customize;
-    customizeObject?: Customize;
-}
-declare enum CustomizeRule {
-    Match = "match",
-    Merge = "merge",
-    Append = "append",
-    Prepend = "prepend",
-    Replace = "replace"
-}
-type CustomizeRuleString = "match" | "merge" | "append" | "prepend" | "replace";
-
-declare function merge<Configuration extends object>(firstConfiguration: Configuration | Configuration[], ...configurations: Configuration[]): Configuration;
-declare function mergeWithCustomize<Configuration extends object>(options: ICustomizeOptions): (firstConfiguration: Configuration | Configuration[], ...configurations: Configuration[]) => Configuration;
-declare function customizeArray(rules: {
-    [s: string]: CustomizeRule | CustomizeRuleString;
-}): (a: any, b: any, key: Key) => any;
-type Rules = {
-    [s: string]: CustomizeRule | CustomizeRuleString | Rules;
-};
-declare function mergeWithRules(rules: Rules): (firstConfiguration: object | object[], ...configurations: object[]) => object;
-declare function customizeObject(rules: {
-    [s: string]: CustomizeRule | CustomizeRuleString;
-}): (a: any, b: any, key: Key) => any;
-
-export { CustomizeRule, customizeArray, customizeObject, merge as default, merge, mergeWithCustomize, mergeWithRules, mergeUnique as unique };