feat: split chunks overall filename (#9243)

crates/node_binding/binding.d.ts

@@ -2213,6 +2213,7 @@ export interface RawSplitChunkSizes {
 export interface RawSplitChunksOptions {
   fallbackCacheGroup?: RawFallbackCacheGroupOptions
   name?: string | false | Function
+  filename?: JsFilename
   cacheGroups?: Array<RawCacheGroupOptions>
   /** What kind of chunks should be selected. */
   chunks?: RegExp | 'async' | 'initial' | 'all' | Function

crates/rspack_binding_values/src/raw_options/raw_split_chunks/mod.rs

@@ -33,6 +33,7 @@ pub struct RawSplitChunksOptions {
   #[napi(ts_type = "string | false | Function")]
   #[debug(skip)]
   pub name: Option<RawChunkOptionName>,
+  pub filename: Option<JsFilename>,
   pub cache_groups: Option<Vec<RawCacheGroupOptions>>,
   /// What kind of chunks should be selected.
   #[napi(ts_type = "RegExp | 'async' | 'initial' | 'all' | Function")]
@@ -107,6 +108,8 @@ impl From<RawSplitChunksOptions> for rspack_plugin_split_chunks::PluginOptions {
 
     let mut cache_groups = vec![];
 
+    let overall_filename = raw_opts.filename.map(Filename::from);
+
     let overall_chunk_filter = raw_opts.chunks.map(create_chunks_filter);
 
     let overall_min_chunks = raw_opts.min_chunks.unwrap_or(1);
@@ -214,7 +217,10 @@ impl From<RawSplitChunksOptions> for rspack_plugin_split_chunks::PluginOptions {
             automatic_name_delimiter: v
               .automatic_name_delimiter
               .unwrap_or(overall_automatic_name_delimiter.clone()),
-            filename: v.filename.map(Filename::from),
+            filename: v
+              .filename
+              .map(Filename::from)
+              .or_else(|| overall_filename.clone()),
             reuse_existing_chunk: v.reuse_existing_chunk.unwrap_or(false),
             max_async_requests: v.max_async_requests.unwrap_or(f64::INFINITY),
             max_initial_requests: v.max_initial_requests.unwrap_or(f64::INFINITY),

packages/rspack-test-tools/tests/configCases/split-chunks/custom-filename-overall/a.js

@@ -0,0 +1,26 @@
+import "./shared1";
+import "./common1";
+
+it("should be able to load the split chunk on demand (shared)", () => {
+	return import(/* webpackChunkName: "theName" */ "./shared2");
+});
+
+it("should be able to load the split chunk on demand (common)", () => {
+	return Promise.all([
+		import(/* webpackChunkName: "otherName1" */ "./common2"),
+		import(/* webpackChunkName: "otherName2" */ "./common3")
+	]);
+});
+
+it("should have files", async () => {
+	const fs = require("fs");
+	const path = require("path");
+	const files = await fs.promises.readdir(__dirname);
+	expect(files).toContain("shared-shared-shared1_js.js");
+	expect(files).toContain("shared-shared-shared2_js.js");
+	expect(files).toContain("splitted-chunks");
+	const innerFiles = await fs.promises.readdir(path.resolve(__dirname, "splitted-chunks"));
+	expect(innerFiles).toContain("common-common1_js.js");
+	expect(innerFiles).toContain("common-common2_js.js");
+	expect(innerFiles).toContain("common-common3_js.js");
+});

packages/rspack-test-tools/tests/configCases/split-chunks/custom-filename-overall/b.js

@@ -0,0 +1,5 @@
+import "./shared1";
+import "./shared2";
+import "./common1";
+import "./common2";
+import "./common3";

packages/rspack-test-tools/tests/configCases/split-chunks/custom-filename-overall/rspack.config.js

@@ -0,0 +1,31 @@
+/** @type {import("@rspack/core").Configuration} */
+module.exports = {
+	mode: "development",
+	entry: {
+		a: "./a",
+		b: "./b"
+	},
+	output: {
+		filename: "[name].js",
+		libraryTarget: "commonjs2"
+	},
+	optimization: {
+		chunkIds: "named",
+		splitChunks: {
+			filename: "splitted-chunks/[name].js",
+			cacheGroups: {
+				shared: {
+					chunks: "all",
+					test: /shared/,
+					filename: "shared-[name].js",
+					enforce: true
+				},
+				common: {
+					chunks: "all",
+					test: /common/,
+					enforce: true
+				}
+			}
+		}
+	}
+};

packages/rspack-test-tools/tests/configCases/split-chunks/custom-filename-overall/test.config.js

@@ -0,0 +1,6 @@
+/** @type {import("../../../..").TConfigCaseConfig} */
+module.exports = {
+	findBundle: function (i, options) {
+		return ["a.js"];
+	}
+};

packages/rspack/etc/core.api.md

@@ -4260,7 +4260,6 @@ export type OptimizationSplitChunksCacheGroup = {
     test?: string | RegExp | ((module: Module) => unknown);
     priority?: number;
     enforce?: boolean;
-    filename?: Filename;
     reuseExistingChunk?: boolean;
     type?: string | RegExp;
     idHint?: string;
@@ -7147,6 +7146,7 @@ export const rspackOptions: z.ZodObject<{
             minChunks: z.ZodOptional<z.ZodNumber>;
             usedExports: z.ZodOptional<z.ZodBoolean>;
             name: z.ZodOptional<z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodLiteral<false>]>, z.ZodFunction<z.ZodTuple<[z.ZodType<Module, z.ZodTypeDef, Module>, z.ZodArray<z.ZodType<Chunk, z.ZodTypeDef, Chunk>, "many">, z.ZodString], z.ZodUnknown>, z.ZodOptional<z.ZodString>>]>>;
+            filename: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodFunction<z.ZodTuple<[z.ZodType<PathData, z.ZodTypeDef, PathData>, z.ZodOptional<z.ZodType<JsAssetInfo, z.ZodTypeDef, JsAssetInfo>>], z.ZodUnknown>, z.ZodString>]>>;
             minSize: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodRecord<z.ZodString, z.ZodNumber>]>>;
             maxSize: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodRecord<z.ZodString, z.ZodNumber>]>>;
             maxAsyncSize: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodRecord<z.ZodString, z.ZodNumber>]>>;
@@ -7160,6 +7160,7 @@ export const rspackOptions: z.ZodObject<{
                 minChunks: z.ZodOptional<z.ZodNumber>;
                 usedExports: z.ZodOptional<z.ZodBoolean>;
                 name: z.ZodOptional<z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodLiteral<false>]>, z.ZodFunction<z.ZodTuple<[z.ZodType<Module, z.ZodTypeDef, Module>, z.ZodArray<z.ZodType<Chunk, z.ZodTypeDef, Chunk>, "many">, z.ZodString], z.ZodUnknown>, z.ZodOptional<z.ZodString>>]>>;
+                filename: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodFunction<z.ZodTuple<[z.ZodType<PathData, z.ZodTypeDef, PathData>, z.ZodOptional<z.ZodType<JsAssetInfo, z.ZodTypeDef, JsAssetInfo>>], z.ZodUnknown>, z.ZodString>]>>;
                 minSize: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodRecord<z.ZodString, z.ZodNumber>]>>;
                 maxSize: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodRecord<z.ZodString, z.ZodNumber>]>>;
                 maxAsyncSize: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodRecord<z.ZodString, z.ZodNumber>]>>;
@@ -7170,7 +7171,6 @@ export const rspackOptions: z.ZodObject<{
                 test: z.ZodOptional<z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodType<RegExp, z.ZodTypeDef, RegExp>]>, z.ZodFunction<z.ZodTuple<[z.ZodType<Module, z.ZodTypeDef, Module>], z.ZodUnknown>, z.ZodUnknown>]>>;
                 priority: z.ZodOptional<z.ZodNumber>;
                 enforce: z.ZodOptional<z.ZodBoolean>;
-                filename: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodFunction<z.ZodTuple<[z.ZodType<PathData, z.ZodTypeDef, PathData>, z.ZodOptional<z.ZodType<JsAssetInfo, z.ZodTypeDef, JsAssetInfo>>], z.ZodUnknown>, z.ZodString>]>>;
                 reuseExistingChunk: z.ZodOptional<z.ZodBoolean>;
                 type: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodType<RegExp, z.ZodTypeDef, RegExp>]>>;
                 idHint: z.ZodOptional<z.ZodString>;
@@ -7244,6 +7244,7 @@ export const rspackOptions: z.ZodObject<{
         }, "strict", z.ZodTypeAny, {
             chunks?: RegExp | "initial" | "async" | "all" | ((args_0: Chunk, ...args: unknown[]) => boolean) | undefined;
             name?: string | false | ((args_0: Module, args_1: Chunk[], args_2: string, ...args: unknown[]) => string | undefined) | undefined;
+            filename?: string | ((args_0: PathData, args_1: JsAssetInfo | undefined, ...args: unknown[]) => string) | undefined;
             usedExports?: boolean | undefined;
             defaultSizeTypes?: string[] | undefined;
             cacheGroups?: Record<string, false | {
@@ -7288,6 +7289,7 @@ export const rspackOptions: z.ZodObject<{
         }, {
             chunks?: RegExp | "initial" | "async" | "all" | ((args_0: Chunk, ...args: unknown[]) => boolean) | undefined;
             name?: string | false | ((args_0: Module, args_1: Chunk[], args_2: string, ...args: unknown[]) => string | undefined) | undefined;
+            filename?: string | ((args_0: PathData, args_1: JsAssetInfo | undefined, ...args: unknown[]) => string) | undefined;
             usedExports?: boolean | undefined;
             defaultSizeTypes?: string[] | undefined;
             cacheGroups?: Record<string, false | {
@@ -7371,6 +7373,7 @@ export const rspackOptions: z.ZodObject<{
         splitChunks?: false | {
             chunks?: RegExp | "initial" | "async" | "all" | ((args_0: Chunk, ...args: unknown[]) => boolean) | undefined;
             name?: string | false | ((args_0: Module, args_1: Chunk[], args_2: string, ...args: unknown[]) => string | undefined) | undefined;
+            filename?: string | ((args_0: PathData, args_1: JsAssetInfo | undefined, ...args: unknown[]) => string) | undefined;
             usedExports?: boolean | undefined;
             defaultSizeTypes?: string[] | undefined;
             cacheGroups?: Record<string, false | {
@@ -7439,6 +7442,7 @@ export const rspackOptions: z.ZodObject<{
         splitChunks?: false | {
             chunks?: RegExp | "initial" | "async" | "all" | ((args_0: Chunk, ...args: unknown[]) => boolean) | undefined;
             name?: string | false | ((args_0: Module, args_1: Chunk[], args_2: string, ...args: unknown[]) => string | undefined) | undefined;
+            filename?: string | ((args_0: PathData, args_1: JsAssetInfo | undefined, ...args: unknown[]) => string) | undefined;
             usedExports?: boolean | undefined;
             defaultSizeTypes?: string[] | undefined;
             cacheGroups?: Record<string, false | {
@@ -9067,6 +9071,7 @@ export const rspackOptions: z.ZodObject<{
         splitChunks?: false | {
             chunks?: RegExp | "initial" | "async" | "all" | ((args_0: Chunk, ...args: unknown[]) => boolean) | undefined;
             name?: string | false | ((args_0: Module, args_1: Chunk[], args_2: string, ...args: unknown[]) => string | undefined) | undefined;
+            filename?: string | ((args_0: PathData, args_1: JsAssetInfo | undefined, ...args: unknown[]) => string) | undefined;
             usedExports?: boolean | undefined;
             defaultSizeTypes?: string[] | undefined;
             cacheGroups?: Record<string, false | {
@@ -9674,6 +9679,7 @@ export const rspackOptions: z.ZodObject<{
         splitChunks?: false | {
             chunks?: RegExp | "initial" | "async" | "all" | ((args_0: Chunk, ...args: unknown[]) => boolean) | undefined;
             name?: string | false | ((args_0: Module, args_1: Chunk[], args_2: string, ...args: unknown[]) => string | undefined) | undefined;
+            filename?: string | ((args_0: PathData, args_1: JsAssetInfo | undefined, ...args: unknown[]) => string) | undefined;
             usedExports?: boolean | undefined;
             defaultSizeTypes?: string[] | undefined;
             cacheGroups?: Record<string, false | {
@@ -10149,6 +10155,7 @@ type SharedOptimizationSplitChunksCacheGroup = {
     minChunks?: number;
     usedExports?: boolean;
     name?: false | OptimizationSplitChunksName;
+    filename?: Filename;
     minSize?: OptimizationSplitChunksSizes;
     maxSize?: OptimizationSplitChunksSizes;
     maxAsyncSize?: OptimizationSplitChunksSizes;

packages/rspack/src/config/types.ts

@@ -2149,6 +2149,9 @@ type SharedOptimizationSplitChunksCacheGroup = {
 	 * */
 	name?: false | OptimizationSplitChunksName;
 
+	/** Allows to override the filename when and only when it's an initial chunk. */
+	filename?: Filename;
+
 	/**
 	 * Minimum size, in bytes, for a chunk to be generated.
 	 *
@@ -2202,9 +2205,6 @@ export type OptimizationSplitChunksCacheGroup = {
 	 */
 	enforce?: boolean;
 
-	/** Allows to override the filename when and only when it's an initial chunk. */
-	filename?: Filename;
-
 	/**
 	 * Whether to reuse existing chunks when possible.
 	 * @default false

packages/rspack/src/config/zod.ts

@@ -1206,6 +1206,7 @@ const sharedOptimizationSplitChunksCacheGroup = {
 	minChunks: z.number().min(1).optional(),
 	usedExports: z.boolean().optional(),
 	name: optimizationSplitChunksName.optional(),
+	filename: filename.optional(),
 	minSize: optimizationSplitChunksSizes.optional(),
 	maxSize: optimizationSplitChunksSizes.optional(),
 	maxAsyncSize: optimizationSplitChunksSizes.optional(),
@@ -1226,7 +1227,6 @@ const optimizationSplitChunksCacheGroup = z.strictObject({
 		.optional(),
 	priority: z.number().optional(),
 	enforce: z.boolean().optional(),
-	filename: filename.optional(),
 	reuseExistingChunk: z.boolean().optional(),
 	type: z.string().or(z.instanceof(RegExp)).optional(),
 	idHint: z.string().optional(),

website/docs/en/plugins/webpack/split-chunks-plugin.mdx

@@ -223,6 +223,33 @@ If the `splitChunks.name` matches an [entry point](/config/entry) name, the entr
 
 :::
 
+### splitChunks.filename
+
+#### splitChunks.cacheGroups.\{cacheGroup\}.filename
+
+- **Type:** `string | function`
+
+Allows to override the filename when and only when it's an initial chunk. All placeholders available in output.filename are also available here.
+
+```js title="rspack.config.mjs"
+export default {
+  //...
+  optimization: {
+    splitChunks: {
+      cacheGroups: {
+        defaultVendors: {
+          filename: 'vendors-[name].js',
+          // or
+          filename: (pathData, assetInfo) => {
+            return `${pathData.chunk.name}-bundle.js`;
+          },
+        },
+      },
+    },
+  },
+};
+```
+
 ### splitChunks.usedExports
 
 <ApiMeta addedVersion="1.0.0" />
@@ -323,31 +350,6 @@ Tells Rspack to ignore `splitChunks.minSize`, splitChunks`.minChunks`, `splitChu
 
 Sets the hint for chunk id. It will be added to chunk's filename.
 
-#### splitChunks.cacheGroups.\{cacheGroup\}.filename
-
-- **Type:** `string | function`
-
-Allows to override the filename when and only when it's an initial chunk. All placeholders available in output.filename are also available here.
-
-```js title="rspack.config.mjs"
-export default {
-  //...
-  optimization: {
-    splitChunks: {
-      cacheGroups: {
-        defaultVendors: {
-          filename: 'vendors-[name].js',
-          // or
-          filename: (pathData, assetInfo) => {
-            return `${pathData.chunk.name}-bundle.js`;
-          },
-        },
-      },
-    },
-  },
-};
-```
-
 #### splitChunks.cacheGroups.\{cacheGroup\}.reuseExistingChunk
 
 - **Type:** `boolean`

website/docs/zh/plugins/webpack/split-chunks-plugin.mdx

@@ -213,6 +213,33 @@ export default {
 
 :::
 
+### splitChunks.filename
+
+#### splitChunks.cacheGroups.\{cacheGroup\}.filename
+
+- **类型：** `string | function`
+
+仅在初始 chunk 时才允许覆盖文件名。 也可以在 output.filename 中使用所有占位符。
+
+```js title="rspack.config.mjs"
+export default {
+  //...
+  optimization: {
+    splitChunks: {
+      cacheGroups: {
+        defaultVendors: {
+          filename: 'vendors-[name].js',
+          // or
+          filename: (pathData, assetInfo) => {
+            return `${pathData.chunk.name}-bundle.js`;
+          },
+        },
+      },
+    },
+  },
+};
+```
+
 ### splitChunks.usedExports
 
 <ApiMeta addedVersion="1.0.0" />
@@ -313,31 +340,6 @@ export default {
 
 设置 chunk id 的提示。 它将被添加到 chunk 的文件名中。
 
-#### splitChunks.cacheGroups.\{cacheGroup\}.filename
-
-- **类型：** `string | function`
-
-仅在初始 chunk 时才允许覆盖文件名。 也可以在 output.filename 中使用所有占位符。
-
-```js title="rspack.config.mjs"
-export default {
-  //...
-  optimization: {
-    splitChunks: {
-      cacheGroups: {
-        defaultVendors: {
-          filename: 'vendors-[name].js',
-          // or
-          filename: (pathData, assetInfo) => {
-            return `${pathData.chunk.name}-bundle.js`;
-          },
-        },
-      },
-    },
-  },
-};
-```
-
 #### splitChunks.cacheGroups.\{cacheGroup\}.reuseExistingChunk
 
 - **类型：** `boolean`