feat: support compilation.chunkGroup[].isInitial()

crates/node_binding/binding.d.ts

@@ -390,6 +390,7 @@ export interface JsChunkGroup {
   chunks: Array<JsChunk>
   index?: number
   name?: string
+  isInitial: boolean
 }
 
 export interface JsChunkPathData {

crates/rspack_binding_values/src/chunk_group.rs

@@ -12,6 +12,7 @@ pub struct JsChunkGroup {
   pub chunks: Vec<JsChunk>,
   pub index: Option<u32>,
   pub name: Option<String>,
+  pub is_initial: bool,
 }
 
 impl JsChunkGroup {
@@ -29,6 +30,7 @@ impl JsChunkGroup {
       inner_parents: cg.parents.iter().map(|ukey| ukey.as_u32()).collect(),
       inner_ukey: cg.ukey.as_u32(),
       name: cg.name().map(|name| name.to_string()),
+      is_initial: cg.is_initial(),
     }
   }
 }

packages/rspack-test-tools/tests/configCases/plugins/compilation-chunk-groups/rspack.config.js

@@ -5,6 +5,7 @@ function plugin(compiler) {
 			expect(chunkGroups.length).toBe(6);
 			expect(chunkGroups.find(i => i.name === 'a').getFiles()).toEqual(['a.js']);
 			expect(chunkGroups.find(i => i.name === 'b').getFiles()).toEqual(['b.js']);
+			expect(chunkGroups.filter(i => i.isInitial()).length).toEqual(2);
 
 			const namedChunkGroups = compilation.namedChunkGroups;
 			expect(Array.from(namedChunkGroups.keys()).length).toBe(2);

packages/rspack/etc/api.md

@@ -929,6 +929,8 @@ export class ChunkGroup {
     // (undocumented)
     get index(): Readonly<number | undefined>;
     // (undocumented)
+    isInitial(): boolean;
+    // (undocumented)
     get name(): Readonly<string | undefined>;
 }
 

packages/rspack/src/ChunkGroup.ts

@@ -41,6 +41,10 @@ export class ChunkGroup {
 		});
 	}
 
+	isInitial(): boolean {
+		return this.#inner.isInitial;
+	}
+
 	get chunks(): ReadonlyArray<Chunk> {
 		return this.#inner.chunks.map(c =>
 			Chunk.__from_binding(c, this.#innerCompilation)

website/docs/en/types/chunk-group.mdx

@@ -2,11 +2,12 @@
 
 ```ts
 type ChunkGroup = {
-  name?: Readonly<string>;
-  index?: Readonly<number>;
-  chunks: ReadonlyArray<Chunk>;
-  getFiles(): ReadonlyArray<string>;
-  getParents(): ReadonlyArray<ChunkGroup>;
+  name?: Readonly<string>; // name of this chunk group
+  index?: Readonly<number>; // creating index of chunk group
+  chunks: ReadonlyArray<Chunk>; // chunks in this chunk group
+  isInitial(): boolean; // whether this chunk group will be loaded on initial page load
+  getFiles(): ReadonlyArray<string>; // the files contained this chunk group
+  getParents(): ReadonlyArray<ChunkGroup>; // returns the parent chunk groups
 };
 ```
 

website/docs/en/types/entrypoint.mdx

@@ -2,12 +2,13 @@
 
 ```ts
 type Entrypoint = {
-  name?: Readonly<string>;
-  index?: Readonly<number>;
-  chunks: ReadonlyArray<Chunk>;
-  getFiles(): ReadonlyArray<string>;
-  getParents(): ReadonlyArray<ChunkGroup>;
-  getRuntimeChunk(): Readonly<Chunk | null>;
+  name?: Readonly<string>; // name of this chunk group
+  index?: Readonly<number>; // creating index of chunk group
+  chunks: ReadonlyArray<Chunk>; // chunks in this chunk group
+  isInitial(): boolean; // whether this chunk group will be loaded on initial page load
+  getFiles(): ReadonlyArray<string>; // the files contained this chunk group
+  getParents(): ReadonlyArray<ChunkGroup>; // returns the parent chunk groups
+  getRuntimeChunk(): Readonly<Chunk | null>; // the chunk containing the webpack bootstrap code
 };
 ```
 

website/docs/zh/types/chunk-group.mdx

@@ -5,6 +5,7 @@ type ChunkGroup = {
   name?: Readonly<string>; // 名称
   index?: Readonly<number>; // 索引序
   chunks: ReadonlyArray<Chunk>; // 包含的 chunk 列表
+  isInitial(): boolean; // 是否在页面初始加载
   getFiles(): ReadonlyArray<string>; // 关联的文件列表
   getParents(): ReadonlyArray<ChunkGroup>; // 父 chunk group 列表
 };

website/docs/zh/types/entrypoint.mdx

@@ -5,9 +5,10 @@ type Entrypoint = {
   name?: Readonly<string>; // 名称
   index?: Readonly<number>; // 索引序
   chunks: ReadonlyArray<Chunk>; // 包含的 chunk 列表
+  isInitial(): boolean; // 是否在页面初始加载
   getFiles(): ReadonlyArray<string>; // 关联的文件列表
   getParents(): ReadonlyArray<ChunkGroup>; // 父 chunk group 列表
-  getRuntimeChunk(): Readonly<Chunk | null>;
+  getRuntimeChunk(): Readonly<Chunk | null>; // 包含 webpack 启动代码的 chunk
 };
 ```