@mui/internal-bundle-size-checker 1.0.9-canary.34 → 1.0.9-canary.36

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mui/internal-bundle-size-checker",
-  "version": "1.0.9-canary.34",
+  "version": "1.0.9-canary.36",
   "description": "Bundle size checker for MUI packages.",
   "type": "module",
   "main": "./src/index.js",
@@ -38,7 +38,7 @@
     "@types/micromatch": "^4.0.9",
     "@types/yargs": "^17.0.33"
   },
-  "gitSha": "4c0f0d55b88cdb008a066a7de077b7a20def6245",
+  "gitSha": "8414c835c34f6f7df03a518b69f1662e0aeec0a6",
   "scripts": {
     "typescript": "tsc -p tsconfig.json",
     "test": "pnpm -w test --project @mui/internal-bundle-size-checker"

package/src/builder.js

@@ -75,7 +75,7 @@ async function createViteConfig(entry, args) {
       emptyOutDir: true,
       rollupOptions: {
         input: '/index.tsx',
-        external: externalsArray,
+        external: (id) => externalsArray.some((ext) => id === ext || id.startsWith(`${ext}/`)),
         plugins: [
           ...(args.analyze
             ? [
@@ -108,7 +108,7 @@ async function createViteConfig(entry, args) {
     },
 
     define: {
-      'process.env.NODE_ENV': JSON.stringify(process.env.NODE_ENV || 'production'),
+      'process.env.NODE_ENV': JSON.stringify('production'),
     },
     logLevel: args.verbose ? 'info' : 'silent',
     // Add plugins to handle virtual entry points
@@ -180,7 +180,7 @@ function walkDependencyTree(chunkKey, manifest, visited = new Set()) {
  * Process vite output to extract bundle sizes
  * @param {import('vite').Rollup.RollupOutput['output']} output - The Vite output
  * @param {string} entryName - The entry name
- * @returns {Promise<Map<string, { parsed: number, gzip: number }>>} - Map of bundle names to size information
+ * @returns {Promise<Map<string, SizeSnapshotEntry>>} - Map of bundle names to size information
  */
 async function processBundleSizes(output, entryName) {
   const chunksByFileName = new Map(output.map((chunk) => [chunk.fileName, chunk]));
@@ -223,20 +223,24 @@ async function processBundleSizes(output, entryName) {
     const gzipBuffer = await gzipAsync(fileContent, { level: zlib.constants.Z_BEST_COMPRESSION });
     const gzipSize = Buffer.byteLength(gzipBuffer);
 
+    if (chunk.isEntry) {
+      return null;
+    }
+
     // Use chunk key as the name, or fallback to entry name for main chunk
-    const chunkName = chunk.name === '_virtual_entry' ? entryName : chunkKey;
+    const chunkName = chunk.name === '_virtual_entry' ? entryName : chunk.name || chunkKey;
     return /** @type {const} */ ([chunkName, { parsed, gzip: gzipSize }]);
   });
 
   const chunkEntries = await Promise.all(chunkPromises);
-  return new Map(chunkEntries);
+  return new Map(/** @type {[string, SizeSnapshotEntry][]} */ (chunkEntries.filter(Boolean)));
 }
 
 /**
  * Get sizes for a vite bundle
  * @param {ObjectEntry} entry - The entry configuration
  * @param {CommandLineArgs} args - Command line arguments
- * @returns {Promise<Map<string, { parsed: number, gzip: number }>>}
+ * @returns {Promise<Map<string, SizeSnapshotEntry>>}
  */
 export async function getBundleSizes(entry, args) {
   // Create vite configuration

package/src/cli.js

@@ -6,11 +6,28 @@ import fs from 'node:fs/promises';
 import yargs from 'yargs';
 import { Piscina } from 'piscina';
 import micromatch from 'micromatch';
+import envCi from 'env-ci';
 import { loadConfig } from './configLoader.js';
 import { uploadSnapshot } from './uploadSnapshot.js';
 import { renderMarkdownReport } from './renderMarkdownReport.js';
 import { octokit } from './github.js';
 import { getCurrentRepoInfo } from './git.js';
+import { notifyPr } from './notifyPr.js';
+
+/**
+ */
+function getCiInfo() {
+  const ciInfo = envCi();
+  if (!ciInfo.isCi) {
+    return null;
+  }
+  switch (ciInfo.name) {
+    case 'CircleCI':
+      return ciInfo;
+    default:
+      throw new Error(`Unsupported CI environment: ${ciInfo.name}`);
+  }
+}
 
 /**
  * @typedef {import('./sizeDiff.js').SizeSnapshot} SizeSnapshot
@@ -25,7 +42,7 @@ const rootDir = process.cwd();
  * creates size snapshot for every bundle
  * @param {CommandLineArgs} args
  * @param {NormalizedBundleSizeCheckerConfig} config - The loaded configuration
- * @returns {Promise<Array<[string, { parsed: number, gzip: number }]>>}
+ * @returns {Promise<Array<[string, SizeSnapshotEntry]>>}
  */
 async function getBundleSizes(args, config) {
   const worker = new Piscina({
@@ -75,6 +92,51 @@ async function getBundleSizes(args, config) {
   return sizeArrays.flat();
 }
 
+/**
+ * Posts initial "in progress" PR comment with CircleCI build information
+ * @returns {Promise<void>}
+ */
+async function postInitialPrComment() {
+  // /** @type {envCi.CircleCiEnv} */
+  const ciInfo = getCiInfo();
+
+  if (!ciInfo || !ciInfo.isPr) {
+    return;
+  }
+
+  // In CI PR builds, all required info must be present
+  if (!ciInfo.slug || !ciInfo.pr) {
+    throw new Error('PR commenting enabled but repository information missing in CI PR build');
+  }
+
+  const prNumber = Number(ciInfo.pr);
+  const circleBuildNum = process.env.CIRCLE_BUILD_NUM;
+  const circleBuildUrl = process.env.CIRCLE_BUILD_URL;
+
+  if (!circleBuildNum || !circleBuildUrl) {
+    throw new Error(
+      'PR commenting enabled but CircleCI environment variables missing in CI PR build',
+    );
+  }
+
+  try {
+    // eslint-disable-next-line no-console
+    console.log('Posting initial PR comment...');
+
+    const initialComment = `## Bundle size report
+
+Bundle size will be reported once [CircleCI build #${circleBuildNum}](${circleBuildUrl}) finishes.`;
+
+    await notifyPr(ciInfo.slug, prNumber, 'bundle-size-report', initialComment);
+
+    // eslint-disable-next-line no-console
+    console.log(`Initial PR comment posted for PR #${prNumber}`);
+  } catch (/** @type {any} */ error) {
+    console.error('Failed to post initial PR comment:', error.message);
+    // Don't fail the build for comment failures
+  }
+}
+
 /**
  * Report command handler
  * @param {ReportCommandArgs} argv - Command line arguments
@@ -114,7 +176,7 @@ async function reportCommand(argv) {
   };
 
   // Generate and print the markdown report
-  const report = await renderMarkdownReport(prInfo, undefined, {
+  const report = await renderMarkdownReport(prInfo, {
     getMergeBase: getMergeBaseFromGithubApi,
   });
   // eslint-disable-next-line no-console
@@ -132,6 +194,11 @@ async function run(argv) {
 
   const config = await loadConfig(rootDir);
 
+  // Post initial PR comment if enabled and in CI environment
+  if (config && config.comment) {
+    await postInitialPrComment();
+  }
+
   // eslint-disable-next-line no-console
   console.log(`Starting bundle size snapshot creation with ${concurrency} workers...`);
 
@@ -164,6 +231,54 @@ async function run(argv) {
     // eslint-disable-next-line no-console
     console.log('No upload configuration provided, skipping upload.');
   }
+
+  // Post PR comment if enabled and in CI environment
+  if (config && config.comment) {
+    const ciInfo = getCiInfo();
+
+    // Skip silently if not in CI or not a PR
+    if (!ciInfo || !ciInfo.isPr) {
+      return;
+    }
+
+    // In CI PR builds, all required info must be present
+    if (!ciInfo.slug || !ciInfo.pr) {
+      throw new Error('PR commenting enabled but repository information missing in CI PR build');
+    }
+
+    const prNumber = Number(ciInfo.pr);
+
+    // eslint-disable-next-line no-console
+    console.log('Generating PR comment with bundle size changes...');
+
+    // Get tracked bundles from config
+    const trackedBundles = config.entrypoints
+      .filter((entry) => entry.track === true)
+      .map((entry) => entry.id);
+
+    // Get PR info for renderMarkdownReport
+    const { data: prInfo } = await octokit.pulls.get({
+      owner: ciInfo.slug.split('/')[0],
+      repo: ciInfo.slug.split('/')[1],
+      pull_number: prNumber,
+    });
+
+    // Generate markdown report
+    const report = await renderMarkdownReport(prInfo, {
+      track: trackedBundles.length > 0 ? trackedBundles : undefined,
+    });
+
+    // Post or update PR comment
+    await notifyPr(
+      ciInfo.slug,
+      prNumber,
+      'bundle-size-report',
+      `## Bundle size report\n\n${report}`,
+    );
+
+    // eslint-disable-next-line no-console
+    console.log(`PR comment posted/updated for PR #${prNumber}`);
+  }
 }
 
 yargs(process.argv.slice(2))

package/src/configLoader.js

@@ -2,9 +2,11 @@
  * Utility to load the bundle-size-checker configuration
  */
 
-import fs from 'node:fs';
+import fs from 'node:fs/promises';
 import path from 'node:path';
 import envCi from 'env-ci';
+import * as module from 'node:module';
+import * as url from 'node:url';
 
 /**
  * Attempts to load and parse a single config file
@@ -14,10 +16,6 @@ import envCi from 'env-ci';
  */
 async function loadConfigFile(configPath) {
   try {
-    if (!fs.existsSync(configPath)) {
-      return null;
-    }
-
     // Dynamic import for ESM
     const configUrl = new URL(`file://${configPath}`);
     const { default: config } = await import(configUrl.href);
@@ -35,9 +33,12 @@ async function loadConfigFile(configPath) {
     }
 
     return resolvedConfig;
-  } catch (error) {
-    console.error(`Error loading config from ${configPath}:`, error);
-    throw error; // Re-throw to indicate failure
+  } catch (/** @type {any} */ error) {
+    if (error.code === 'ERR_MODULE_NOT_FOUND') {
+      return null;
+    }
+
+    throw error;
   }
 }
 
@@ -80,59 +81,128 @@ export function applyUploadConfigDefaults(uploadConfig, ciInfo) {
   };
 }
 
+/**
+ * @param {{ [s: string]: any; } | ArrayLike<any>} exportsObj
+ * @returns {string[]} Array of export paths
+ */
+function findExports(exportsObj) {
+  const paths = [];
+  for (const [key, value] of Object.entries(exportsObj)) {
+    if (key.startsWith('.')) {
+      paths.push(key);
+    } else {
+      paths.push(...findExports(value));
+    }
+  }
+  return paths;
+}
+
+/**
+ * @param {import("fs").PathLike | fs.FileHandle} pkgJson
+ * @returns {Promise<string[]>}
+ */
+async function findExportedPaths(pkgJson) {
+  const pkgContent = await fs.readFile(pkgJson, 'utf8');
+  const { exports = {} } = JSON.parse(pkgContent);
+  return findExports(exports);
+}
+
+/**
+ * Checks if the given import source is a top-level package
+ * @param {string} importSrc - The import source string
+ * @returns {boolean} - True if it's a top-level package, false otherwise
+ */
+function isPackageTopLevel(importSrc) {
+  const parts = importSrc.split('/');
+  return parts.length === 1 || (parts.length === 2 && parts[0].startsWith('@'));
+}
+
 /**
  * Normalizes entries to ensure they have a consistent format and ids are unique
  * @param {EntryPoint[]} entries - The array of entries from the config
- * @returns {ObjectEntry[]} - Normalized entries with uniqueness enforced
+ * @param {string} configPath - The path to the configuration file
+ * @returns {Promise<ObjectEntry[]>} - Normalized entries with uniqueness enforced
  */
-function normalizeEntries(entries) {
+async function normalizeEntries(entries, configPath) {
   const usedIds = new Set();
 
-  return entries.map((entry) => {
-    if (typeof entry === 'string') {
-      // Transform string entries into object entries
-      const [importSrc, importName] = entry.split('#');
-      if (importName) {
-        // For entries like '@mui/material#Button', create an object with import and importedNames
-        entry = {
-          id: entry,
-          import: importSrc,
-          importedNames: [importName],
-        };
-      } else {
-        // For entries like '@mui/material', create an object with import only
-        entry = {
-          id: entry,
-          import: importSrc,
-        };
-      }
-    }
+  const result = (
+    await Promise.all(
+      entries.map(async (entry) => {
+        if (typeof entry === 'string') {
+          entry = { id: entry };
+        }
 
-    if (!entry.id) {
-      throw new Error('Object entries must have an id property');
-    }
+        entry = { ...entry };
 
-    if (!entry.code && !entry.import) {
-      throw new Error(`Entry "${entry.id}" must have either code or import property defined`);
-    }
+        if (!entry.id) {
+          throw new Error('Object entries must have an id property');
+        }
 
+        if (!entry.code && !entry.import) {
+          // Transform string entries into object entries
+          const [importSrc, importName] = entry.id.split('#');
+          entry.import = importSrc;
+          if (importName) {
+            entry.importedNames = [importName];
+          }
+          if (isPackageTopLevel(entry.import) && !entry.importedNames) {
+            entry.track = true;
+          }
+        }
+
+        if (entry.expand) {
+          if (!entry.import || !isPackageTopLevel(entry.import)) {
+            throw new Error(
+              `Entry "${entry.id}": expand can only be used with top-level package imports`,
+            );
+          }
+          if (!module.findPackageJSON) {
+            throw new Error(
+              "Your Node.js version doesn't support `module.findPackageJSON`, which is required to expand entries.",
+            );
+          }
+          const pkgJson = module.findPackageJSON(entry.import, url.pathToFileURL(configPath));
+          if (!pkgJson) {
+            throw new Error(`Can't find package.json for entry "${entry.id}".`);
+          }
+          const exportedPaths = await findExportedPaths(pkgJson);
+
+          const expandedEntries = [];
+          for (const exportPath of exportedPaths) {
+            const importSrc = entry.import + exportPath.slice(1);
+            expandedEntries.push({
+              id: importSrc,
+              import: importSrc,
+              track: isPackageTopLevel(importSrc),
+            });
+          }
+          return expandedEntries;
+        }
+
+        return [entry];
+      }),
+    )
+  ).flat();
+
+  for (const entry of result) {
     if (usedIds.has(entry.id)) {
       throw new Error(`Duplicate entry id found: "${entry.id}". Entry ids must be unique.`);
     }
-
     usedIds.add(entry.id);
+  }
 
-    return entry;
-  });
+  return result;
 }
 
 /**
  * Apply default values to the configuration using CI environment
  * @param {BundleSizeCheckerConfigObject} config - The loaded configuration
- * @returns {NormalizedBundleSizeCheckerConfig} Configuration with defaults applied
+ * @param {string} configPath - The path to the configuration file
+ * @returns {Promise<NormalizedBundleSizeCheckerConfig>} Configuration with defaults applied
  * @throws {Error} If required fields are missing
  */
-function applyConfigDefaults(config) {
+async function applyConfigDefaults(config, configPath) {
   // Get environment CI information
   /** @type {{ branch?: string, isPr?: boolean, prBranch?: string, slug?: string}} */
   const ciInfo = envCi();
@@ -148,8 +218,9 @@ function applyConfigDefaults(config) {
   // Clone the config to avoid mutating the original
   /** @type {NormalizedBundleSizeCheckerConfig} */
   const result = {
-    entrypoints: normalizeEntries(config.entrypoints),
+    entrypoints: await normalizeEntries(config.entrypoints, configPath),
     upload: null, // Default to disabled
+    comment: config.comment !== undefined ? config.comment : true, // Default to enabled
   };
 
   // Handle different types of upload value
@@ -198,7 +269,7 @@ export async function loadConfig(rootDir) {
     const config = await loadConfigFile(configPath);
     if (config) {
       // Apply defaults and return the config
-      return applyConfigDefaults(config);
+      return applyConfigDefaults(config, configPath);
     }
   }
 

package/src/github.js

@@ -7,5 +7,6 @@ import { createActionAuth } from '@octokit/auth-action';
 /** @type {import('@octokit/rest').Octokit} */
 export const octokit = new Octokit({
   authStrategy: process.env.GITHUB_TOKEN ? createActionAuth : undefined,
+  auth: process.env.DANGER_GITHUB_API_TOKEN,
   userAgent: 'bundle-size-checker',
 });

package/src/index.js

@@ -2,14 +2,5 @@
 
 import defineConfig from './defineConfig.js';
 import { loadConfig } from './configLoader.js';
-import { calculateSizeDiff } from './sizeDiff.js';
-import { renderMarkdownReport } from './renderMarkdownReport.js';
-import { fetchSnapshot } from './fetchSnapshot.js';
 
-export { defineConfig, loadConfig, calculateSizeDiff, renderMarkdownReport, fetchSnapshot };
-
-/**
- * @typedef {import('./sizeDiff.js').Size} Size
- * @typedef {import('./sizeDiff.js').SizeSnapshot} SizeSnapshot
- * @typedef {import('./sizeDiff.js').ComparisonResult} ComparisonResult
- */
+export { defineConfig, loadConfig };

package/src/notifyPr.js

@@ -0,0 +1,81 @@
+// @ts-check
+
+import { octokit } from './github.js';
+
+/**
+ * Recursively searches for a comment containing the specified marker.
+ * Searches page-by-page (newest first) and stops when found or no more pages exist.
+ *
+ * @param {string} owner - Repository owner
+ * @param {string} repoName - Repository name
+ * @param {number} prNumber - Pull request number
+ * @param {string} marker - HTML comment marker to search for
+ * @param {number} page - Current page number (default: 1)
+ */
+async function findCommentByMarker(owner, repoName, prNumber, marker, page = 1) {
+  const { data: comments } = await octokit.issues.listComments({
+    owner,
+    repo: repoName,
+    issue_number: prNumber,
+    sort: 'updated',
+    direction: 'desc',
+    per_page: 100,
+    page,
+  });
+
+  // Base case: no comments on this page
+  if (comments.length <= 0) {
+    return null;
+  }
+
+  // Success case: found comment with marker
+  const foundComment = comments.find((comment) => comment.body && comment.body.includes(marker));
+  if (foundComment) {
+    return foundComment;
+  }
+
+  return findCommentByMarker(owner, repoName, prNumber, marker, page + 1);
+}
+
+/**
+ * Creates or updates a comment on a pull request with the specified content.
+ * Uses an HTML comment marker to identify and update existing comments.
+ * Searches page-by-page (newest first) and stops early when comment is found.
+ *
+ * @param {string} repo - The repository in format "owner/repo"
+ * @param {number} prNumber - The pull request number
+ * @param {string} id - Unique identifier to mark the comment for future updates
+ * @param {string} content - The content to post or update in the comment
+ * @returns {Promise<void>}
+ */
+export async function notifyPr(repo, prNumber, id, content) {
+  const [owner, repoName] = repo.split('/');
+
+  if (!owner || !repoName) {
+    throw new Error(`Invalid repo format. Expected "owner/repo", got "${repo}"`);
+  }
+
+  const marker = `<!-- bundle-size-checker-id: ${id} -->`;
+  const commentBody = `${marker}\n${content}`;
+
+  // Search for existing comment with our marker
+  const existingComment = await findCommentByMarker(owner, repoName, prNumber, marker);
+
+  if (existingComment) {
+    // Update existing comment
+    await octokit.issues.updateComment({
+      owner,
+      repo: repoName,
+      comment_id: existingComment.id,
+      body: commentBody,
+    });
+  } else {
+    // Create new comment
+    await octokit.issues.createComment({
+      owner,
+      repo: repoName,
+      issue_number: prNumber,
+      body: commentBody,
+    });
+  }
+}

package/src/renderMarkdownReport.js

@@ -196,12 +196,11 @@ export function renderMarkdownReportContent(
  *
  * @param {PrInfo} prInfo
  * @param {Object} [options] - Optional parameters
- * @param {string | null} [options.circleciBuildNumber] - The CircleCI build number
  * @param {string | null} [options.actualBaseCommit] - The actual commit SHA used for comparison (may differ from prInfo.base.sha)
  * @returns {URL}
  */
 function getDetailsUrl(prInfo, options = {}) {
-  const { circleciBuildNumber, actualBaseCommit } = options;
+  const { actualBaseCommit } = options;
   const detailedComparisonUrl = new URL(
     `https://frontend-public.mui.com/size-comparison/${prInfo.base.repo.full_name}/diff`,
   );
@@ -209,16 +208,12 @@ function getDetailsUrl(prInfo, options = {}) {
   detailedComparisonUrl.searchParams.set('baseRef', prInfo.base.ref);
   detailedComparisonUrl.searchParams.set('baseCommit', actualBaseCommit || prInfo.base.sha);
   detailedComparisonUrl.searchParams.set('headCommit', prInfo.head.sha);
-  if (circleciBuildNumber) {
-    detailedComparisonUrl.searchParams.set('circleCIBuildNumber', circleciBuildNumber);
-  }
   return detailedComparisonUrl;
 }
 
 /**
  *
  * @param {PrInfo} prInfo
- * @param {string} [circleciBuildNumber] - The CircleCI build number
  * @param {Object} [options] - Additional options
  * @param {string[]} [options.track] - Array of bundle IDs to track
  * @param {number} [options.fallbackDepth=3] - How many parent commits to try as fallback when base snapshot is missing
@@ -226,7 +221,7 @@ function getDetailsUrl(prInfo, options = {}) {
  * @param {(base: string, head: string) => Promise<string>} [options.getMergeBase] - Custom function to get merge base commit
  * @returns {Promise<string>} Markdown report
  */
-export async function renderMarkdownReport(prInfo, circleciBuildNumber, options = {}) {
+export async function renderMarkdownReport(prInfo, options = {}) {
   let markdownContent = '';
 
   const prCommit = prInfo.head.sha;
@@ -255,7 +250,7 @@ export async function renderMarkdownReport(prInfo, circleciBuildNumber, options
 
   markdownContent += report;
 
-  markdownContent += `\n\n[Details of bundle changes](${getDetailsUrl(prInfo, { circleciBuildNumber, actualBaseCommit })})`;
+  markdownContent += `\n\n[Details of bundle changes](${getDetailsUrl(prInfo, { actualBaseCommit })})`;
 
   return markdownContent;
 }

package/src/renderMarkdownReport.test.js

@@ -248,39 +248,6 @@ describe('renderMarkdownReport', () => {
     `);
   });
 
-  it('should include CircleCI build number in details URL', async () => {
-    const baseSnapshot = {
-      '@mui/material/Button/index.js': { parsed: 15000, gzip: 4500 },
-    };
-
-    const prSnapshot = {
-      '@mui/material/Button/index.js': { parsed: 15000, gzip: 4500 },
-    };
-
-    mockFetchSnapshotWithFallback.mockResolvedValueOnce({
-      snapshot: baseSnapshot,
-      actualCommit: 'abc123',
-    });
-    mockFetchSnapshot.mockResolvedValueOnce(prSnapshot);
-
-    const result = await renderMarkdownReport(mockPrInfo, '12345');
-
-    expect(result).toContain('circleCIBuildNumber=12345');
-    expect(result).toMatchInlineSnapshot(`
-      "**Total Size Change:**  0B<sup>(0.00%)</sup> - **Total Gzip Change:**  0B<sup>(0.00%)</sup>
-      Files: 1 total (0 added, 0 removed, 0 changed)
-
-      <details>
-      <summary>Show details for 1 more bundle</summary>
-
-      **@mui/material/Button/index.js**&emsp;**parsed:**  0B<sup>(0.00%)</sup> **gzip:**  0B<sup>(0.00%)</sup>
-
-      </details>
-
-      [Details of bundle changes](https://frontend-public.mui.com/size-comparison/mui/material-ui/diff?prNumber=42&baseRef=master&baseCommit=abc123&headCommit=def456&circleCIBuildNumber=12345)"
-    `);
-  });
-
   it('should handle no changes', async () => {
     const baseSnapshot = {
       '@mui/material/Button/index.js': { parsed: 15000, gzip: 4500 },
@@ -332,7 +299,7 @@ describe('renderMarkdownReport', () => {
     });
     mockFetchSnapshot.mockResolvedValueOnce(prSnapshot);
 
-    const result = await renderMarkdownReport(mockPrInfo, undefined, {
+    const result = await renderMarkdownReport(mockPrInfo, {
       track: ['@mui/material/Button/index.js', '@mui/material/TextField/index.js'],
     });
 
@@ -367,7 +334,7 @@ describe('renderMarkdownReport', () => {
     });
     mockFetchSnapshot.mockResolvedValueOnce(prSnapshot);
 
-    const result = await renderMarkdownReport(mockPrInfo, undefined, {
+    const result = await renderMarkdownReport(mockPrInfo, {
       track: ['@mui/material/Button/index.js', '@mui/material/TextField/index.js'],
     });
 
@@ -402,7 +369,7 @@ describe('renderMarkdownReport', () => {
     });
     mockFetchSnapshot.mockResolvedValueOnce(prSnapshot);
 
-    const result = await renderMarkdownReport(mockPrInfo, undefined, {
+    const result = await renderMarkdownReport(mockPrInfo, {
       track: ['@mui/material/Button/index.js'],
     });
 
@@ -436,7 +403,7 @@ describe('renderMarkdownReport', () => {
     });
     mockFetchSnapshot.mockResolvedValueOnce(prSnapshot);
 
-    const result = await renderMarkdownReport(mockPrInfo, undefined, {
+    const result = await renderMarkdownReport(mockPrInfo, {
       track: ['@mui/material/Button/index.js', '@mui/material/TextField/index.js'],
     });
 
@@ -469,7 +436,7 @@ describe('renderMarkdownReport', () => {
     });
     mockFetchSnapshot.mockResolvedValueOnce(prSnapshot);
 
-    const result = await renderMarkdownReport(mockPrInfo, undefined, {
+    const result = await renderMarkdownReport(mockPrInfo, {
       track: ['@mui/material/Button/index.js'],
     });
 
@@ -500,7 +467,7 @@ describe('renderMarkdownReport', () => {
     mockFetchSnapshot.mockResolvedValueOnce(prSnapshot);
 
     await expect(
-      renderMarkdownReport(mockPrInfo, undefined, {
+      renderMarkdownReport(mockPrInfo, {
         track: ['@mui/material/Button/index.js', '@mui/material/NonExistent/index.js'],
       }),
     ).rejects.toThrow(
@@ -561,9 +528,7 @@ describe('renderMarkdownReport', () => {
     });
     mockFetchSnapshot.mockResolvedValueOnce(prSnapshot);
 
-    const result = await renderMarkdownReport(mockPrInfo, undefined, {
-      fallbackDepth: 1,
-    });
+    const result = await renderMarkdownReport(mockPrInfo, { fallbackDepth: 1 });
 
     expect(result).toContain(
       'Using snapshot from parent commit parent1 (fallback from merge base abc123)',
@@ -609,9 +574,7 @@ describe('renderMarkdownReport', () => {
     });
     mockFetchSnapshot.mockResolvedValueOnce(prSnapshot);
 
-    const result = await renderMarkdownReport(mockPrInfo, undefined, {
-      getMergeBase: customGetMergeBase,
-    });
+    const result = await renderMarkdownReport(mockPrInfo, { getMergeBase: customGetMergeBase });
 
     // Verify that custom getMergeBase was called instead of default
     expect(customGetMergeBase).toHaveBeenCalledWith('abc123', 'def456');
@@ -631,9 +594,7 @@ describe('renderMarkdownReport', () => {
     mockFetchSnapshot.mockResolvedValueOnce(prSnapshot);
 
     await expect(
-      renderMarkdownReport(mockPrInfo, undefined, {
-        getMergeBase: customGetMergeBase,
-      }),
+      renderMarkdownReport(mockPrInfo, { getMergeBase: customGetMergeBase }),
     ).rejects.toThrow('Custom merge base error');
 
     // Verify that custom getMergeBase was called

package/src/sizeDiff.js

@@ -1,9 +1,4 @@
 /**
- * @description Represents a single bundle size entry
- * @typedef {Object} SizeSnapshotEntry
- * @property {number} parsed
- * @property {number} gzip
- *
  * @description Represents a single bundle size snapshot
  * @typedef {Object.<string, SizeSnapshotEntry>} SizeSnapshot
  *
@@ -36,6 +31,7 @@
  * @property {number} fileCounts.total - Total number of files
  */
 
+/** @type {SizeSnapshotEntry} */
 const nullSnapshot = { parsed: 0, gzip: 0 };
 
 /**

package/src/types.d.ts

@@ -21,6 +21,8 @@ interface ObjectEntry {
   import?: string; // Optional package name to import
   importedNames?: string[]; // Optional array of named imports
   externals?: string[]; // Optional array of packages to exclude from the bundle
+  track?: boolean; // Whether this bundle should be tracked in PR comments (defaults to false)
+  expand?: boolean; // Whether to expand the entry to include all exports
 }
 
 type EntryPoint = StringEntry | ObjectEntry;
@@ -29,6 +31,7 @@ type EntryPoint = StringEntry | ObjectEntry;
 interface BundleSizeCheckerConfigObject {
   entrypoints: EntryPoint[];
   upload?: UploadConfig | boolean | null;
+  comment?: boolean; // Whether to post PR comments (defaults to true)
 }
 
 type BundleSizeCheckerConfig =
@@ -40,6 +43,7 @@ type BundleSizeCheckerConfig =
 interface NormalizedBundleSizeCheckerConfig {
   entrypoints: ObjectEntry[];
   upload: NormalizedUploadConfig | null; // null means upload is disabled
+  comment: boolean; // Whether to post PR comments
 }
 
 // Command line argument types
@@ -70,7 +74,6 @@ interface DiffCommandArgs {
 interface PrCommandArgs {
   prNumber: number;
   output?: 'json' | 'markdown';
-  circleci?: string;
 }
 
 interface PrInfo {
@@ -87,3 +90,8 @@ interface PrInfo {
     sha: string;
   };
 }
+
+interface SizeSnapshotEntry {
+  parsed: number;
+  gzip: number;
+}

package/src/worker.js

@@ -57,7 +57,7 @@ async function getPeerDependencies(packageName) {
 /**
  * Get sizes for a bundle
  * @param {{ entry: ObjectEntry, args: CommandLineArgs, index: number, total: number }} options
- * @returns {Promise<Array<[string, { parsed: number, gzip: number }]>>}
+ * @returns {Promise<Array<[string, SizeSnapshotEntry]>>}
  */
 export default async function getSizes({ entry, args, index, total }) {
   // eslint-disable-next-line no-console -- process monitoring