feat: support function type of performance.printFileSize.total (#5915)

Co-authored-by: Copilot <[email protected]>

Author: Timeless0911

e2e/cases/print-file-size/basic/index.test.ts

@@ -296,4 +296,24 @@ dist/static/js/lib-react.[[hash]].js   X.X kB   X.X kB
 
     await rsbuild.close();
   });
+
+  test('printFileSize with custom total function should work', async () => {
+    const rsbuild = await build({
+      cwd,
+      rsbuildConfig: {
+        performance: {
+          printFileSize: {
+            total: ({ assets }) => {
+              return `Generated ${assets.length} files.`;
+            },
+            detail: false,
+          },
+        },
+      },
+    });
+
+    await rsbuild.expectLog('Generated 5 files.');
+
+    await rsbuild.close();
+  });
 });

packages/core/src/plugins/fileSize.ts

@@ -187,6 +187,20 @@ async function printFileSizes(
     : '';
   const totalSizeStr = showTotal ? calcFileSize(totalSize) : '';
 
+  const getCustomTotal = () => {
+    if (typeof options.total === 'function') {
+      return options.total({
+        assets: assets.map((asset) => ({
+          name: asset.name,
+          size: asset.size,
+        })),
+        totalSize,
+        totalGzipSize,
+      });
+    }
+    return null;
+  };
+
   if (showDetail) {
     const maxFileLength = Math.max(
       ...assets.map((a) => (a.folder + path.sep + a.name).length),
@@ -237,27 +251,42 @@ async function printFileSizes(
 
     if (showTotal) {
       logs.push('');
-      let log = '';
-      log += ' '.repeat(maxFileLength - totalSizeLabel.length);
-      log += color.magenta(totalSizeLabel);
-      log += `   ${totalSizeStr}`;
 
-      if (options.compressed) {
-        const colorFn = getAssetColor(totalGzipSize / assets.length);
-        log += ' '.repeat(maxSizeLength - totalSizeStr.length);
-        log += `   ${colorFn(calcFileSize(totalGzipSize))}`;
+      const customTotal = getCustomTotal();
+      if (customTotal) {
+        // Custom total display
+        logs.push(customTotal);
+      } else {
+        // Default total display
+        let log = '';
+        log += ' '.repeat(maxFileLength - totalSizeLabel.length);
+        log += color.magenta(totalSizeLabel);
+        log += `   ${totalSizeStr}`;
+
+        if (options.compressed) {
+          const colorFn = getAssetColor(totalGzipSize / assets.length);
+          log += ' '.repeat(maxSizeLength - totalSizeStr.length);
+          log += `   ${colorFn(calcFileSize(totalGzipSize))}`;
+        }
+
+        logs.push(log);
       }
-
-      logs.push(log);
     }
   } else if (showTotal) {
-    let log = `${color.magenta(totalSizeLabel)} ${totalSizeStr}`;
+    const customTotal = getCustomTotal();
+    if (customTotal) {
+      // Custom total display
+      logs.push(customTotal);
+    } else {
+      // Default total display
+      let log = `${color.magenta(totalSizeLabel)} ${totalSizeStr}`;
 
-    if (options.compressed) {
-      log += color.green(` (${calcFileSize(totalGzipSize)} gzipped)`);
-    }
+      if (options.compressed) {
+        log += color.green(` (${calcFileSize(totalGzipSize)} gzipped)`);
+      }
 
-    logs.push(log);
+      logs.push(log);
+    }
   }
 
   logs.push('');

packages/core/src/types/config.ts

@@ -615,10 +615,16 @@ export type PrintFileSizeAsset = {
 
 export type PrintFileSizeOptions = {
   /**
-   * Whether to print the total size of all static assets.
+   * Whether to print the total size of all static assets, or a function to generate custom total output.
    * @default true
    */
-  total?: boolean;
+  total?:
+    | boolean
+    | ((params: {
+        assets: PrintFileSizeAsset[];
+        totalSize: number;
+        totalGzipSize: number;
+      }) => string);
   /**
    * Whether to print the size of each static asset.
    * @default true

website/docs/en/config/performance/print-file-size.mdx

@@ -6,7 +6,7 @@
 type PrintFileSizeOptions =
   | boolean
   | {
-      total?: boolean;
+      total?: boolean | Function;
       detail?: boolean;
       compressed?: boolean;
       include?: (asset: PrintFileSizeAsset) => boolean;
@@ -50,10 +50,23 @@ You can customize the output format through the options.
 
 ### total
 
-- **Type:** `boolean`
+- **Type:**
+
+```ts
+type Total =
+  | boolean
+  | ((params: {
+      assets: PrintFileSizeAsset[];
+      totalSize: number;
+      totalGzipSize: number;
+    }) => string);
+```
+
 - **Default:** `true`
 
-Whether to output the total size of all static assets.
+Whether to output the total size of all static assets, or provide a function to customize the output format of the total size.
+
+When set to `false`, the total size will not be output:
 
 ```ts
 export default {
@@ -69,6 +82,26 @@ export default {
 If the current build only generates one static asset, the total size will not be printed.
 :::
 
+When set to a function, you can customize the total size output format:
+
+```ts
+export default {
+  performance: {
+    printFileSize: {
+      total: ({ assets, totalSize }) => {
+        return `Generated ${assets.length} files, the total size is ${(totalSize / 1000).toFixed(1)} kB.`;
+      },
+    },
+  },
+};
+```
+
+Function parameters:
+
+- `assets`: Array of static assets, each containing `name` and `size` properties
+- `totalSize`: Total size of all static assets in bytes
+- `totalGzipSize`: Total gzip-compressed size of all static assets in bytes
+
 ### detail
 
 - **Type:** `boolean`

website/docs/zh/config/performance/print-file-size.mdx

@@ -6,7 +6,7 @@
 type PrintFileSizeOptions =
   | boolean
   | {
-      total?: boolean;
+      total?: boolean | Function;
       detail?: boolean;
       compressed?: boolean;
       include?: (asset: PrintFileSizeAsset) => boolean;
@@ -50,10 +50,23 @@ export default {
 
 ### total
 
-- **类型：** `boolean`
+- **类型：**
+
+```ts
+type Total =
+  | boolean
+  | ((params: {
+      assets: PrintFileSizeAsset[];
+      totalSize: number;
+      totalGzipSize: number;
+    }) => string);
+```
+
 - **默认值：** `true`
 
-是否输出所有静态资源的总体积。
+是否输出所有静态资源的总体积，或者提供一个函数来自定义总体积的输出格式。
+
+当设置为 `false` 时，不输出总体积信息：
 
 ```ts
 export default {
@@ -69,6 +82,26 @@ export default {
 如果本次构建只生成了一个静态资源，则不会输出总体积。
 :::
 
+当设置为函数时，可以自定义总体积的输出格式：
+
+```ts
+export default {
+  performance: {
+    printFileSize: {
+      total: ({ assets, totalSize }) => {
+        return `Generated ${assets.length} files, the total size is ${(totalSize / 1000).toFixed(1)} kB.`;
+      },
+    },
+  },
+};
+```
+
+函数参数说明：
+
+- `assets`: 静态资源列表，每个资源包含 `name` 和 `size` 属性
+- `totalSize`: 所有静态资源的体积
+- `totalGzipSize`: 所有静态资源 gzip 压缩后的体积
+
 ### detail
 
 - **类型：** `boolean`