feat(report): add gzip option to control gzip compression reporting (#507)

Author: rznn7

src/features/report.ts

@@ -27,6 +27,14 @@ interface SizeInfo {
 }
 
 export interface ReportOptions {
+  /**
+   * Enable/disable gzip-compressed size reporting.
+   * Compressing large output files can be slow, so disabling this may increase build performance for large projects.
+   *
+   * @default true
+   */
+  gzip?: boolean
+
   /**
    * Enable/disable brotli-compressed size reporting.
    * Compressing large output files can be slow, so disabling this may increase build performance for large projects.
@@ -42,14 +50,25 @@ export interface ReportOptions {
   maxCompressSize?: number
 }
 
+const defaultOptions = {
+  gzip: true,
+  brotli: false,
+  maxCompressSize: 1_000_000,
+}
+
 export function ReportPlugin(
-  options: ReportOptions,
+  userOptions: ReportOptions,
   logger: Logger,
   cwd: string,
   cjsDts?: boolean,
   name?: string,
   isMultiFormat?: boolean,
 ): Plugin {
+  const options = {
+    ...defaultOptions,
+    ...userOptions,
+  }
+
   return {
     name: 'tsdown:report',
     async writeBundle(outputOptions, bundle) {
@@ -117,7 +136,7 @@ export function ReportPlugin(
             filenameColor((size.isEntry ? bold : noop)(size.filename)),
           ` `.repeat(filenameLength - size.filename.length),
           dim(size.rawText),
-          size.gzipText && dim`│ gzip: ${size.gzipText}`,
+          options.gzip && size.gzipText && dim`│ gzip: ${size.gzipText}`,
           options.brotli &&
             size.brotliText &&
             dim`│ brotli: ${size.brotliText}`,
@@ -135,7 +154,7 @@ export function ReportPlugin(
 }
 
 async function calcSize(
-  options: ReportOptions,
+  options: Required<ReportOptions>,
   chunk: OutputAsset | OutputChunk,
 ): Promise<SizeInfo> {
   debug(`Calculating size for`, chunk.fileName)
@@ -147,12 +166,13 @@ async function calcSize(
 
   let gzip: number = Infinity
   let brotli: number = Infinity
-  if (raw > (options.maxCompressSize ?? 1_000_000)) {
+  if (raw > options.maxCompressSize) {
     debug(chunk.fileName, 'file size exceeds limit, skip gzip/brotli')
   } else {
-    gzip = (await gzipAsync(content)).length
-    debug('[gzip]', chunk.fileName, gzip)
-
+    if (options.gzip) {
+      gzip = (await gzipAsync(content)).length
+      debug('[gzip]', chunk.fileName, gzip)
+    }
     if (options.brotli) {
       brotli = (await brotliCompressAsync(content)).length
       debug('[brotli]', chunk.fileName, brotli)