feat(core): add showDiff option to printFileSize #6635
Conversation
…ize comparison Add a new `showDiff` option to performance.printFileSize that displays file size changes compared to the previous build. This helps developers track how their changes affect bundle sizes over time.
✅ Deploy Preview for rsbuild ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
|
There was a problem hiding this comment.
Pull request overview
This PR adds a new showDiff option to performance.printFileSize that displays file size changes between builds. The feature helps developers track how their changes affect bundle sizes by showing color-coded differences (red for increases, green for decreases, "NEW" for new files) in a dedicated "Diff" column. The implementation caches build sizes in node_modules/.cache/rsbuild/ and uses hash normalization to match files across builds. The feature is opt-in and disabled by default.
Key changes:
- Adds
showDiffboolean option toPrintFileSizeOptionstype - Implements file size caching mechanism with hash normalization for cross-build file matching
- Updates output formatting to include a conditional "Diff" column with color-coded size changes
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
website/docs/en/config/performance/print-file-size.mdx |
Documents the new showDiff option with examples showing the diff column output |
packages/core/tests/fileSize.test.ts |
Adds comprehensive test coverage for the normalizeFileName function and updates asset exclusion tests |
packages/core/src/types/config.ts |
Adds showDiff boolean property to PrintFileSizeOptions interface |
packages/core/src/plugins/fileSize.ts |
Implements core diff functionality including cache management, file name normalization, and diff column rendering |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
chenjiahan
left a comment
chenjiahan
left a comment
There was a problem hiding this comment.
I feel that create-react-app's logging style is more concise. It does not add an extra “Diff” column but instead shows size changes in parentheses right after the existing size.
This makes the format more flexible, so we could also show the diff for the gzip size if we want.
| return path.join( | ||
| rootPath, | ||
| 'node_modules', | ||
| '.cache', |
There was a problem hiding this comment.
Use api.context.cachePath to replace rootPath/node_modules/.cache, see https://rsbuild.rs/api/javascript-api/instance#contextcachepath
| const sign = diffSize > 0 ? '+' : '-'; | ||
| diffText = `${sign}${diffStr}`; | ||
| } else { | ||
| diffText = '0 kB'; |
There was a problem hiding this comment.
Can we omit the 0 kB? It seems like unnecessary information.
3 participants
Add showDiff option to printFileSize for build-to-build size comparison
Add a new
showDiffoption to performance.printFileSize that displays file size changes compared to the previous build. This helps developers track how their changes affect bundle sizes over time.Summary
Adds a showDiff option to performance.printFileSize that displays file size changes between builds. Shows color-coded differences (red for increases, green for decreases, "NEW" for new files) in a dedicated "Diff" column. Caches previous build sizes in node_modules/.cache/rsbuild/ for comparison, with automatic hash normalization to match files across builds. Opt-in feature (disabled by default).
E.G.
Related Links
#6100
Checklist