Improve Markdown comment #160

camchenry · 2022-08-03T17:44:22Z

Description

This PR tries to improve the appearance of the comment that is posted on the GitHub PR. The main concern being addressed is that the changes are hard to read and take up a bit too much space.

Changes made

Each row gets a unique emoji to summarize how it changed (added, removed, larger, smaller, etc.)
There are now two tables generated: summary and detailed
- Summary: shows the file name, and how much it changed by
- Detailed: shows the file, old size, new size, and the delta (how much it changed)
File names are shown with a code tag, to make it easier to scan
Instead of printing out Bytes in a file size, it is now shortened to just B for consistency
Files prefixed with ./ or / are trimmed out to make it slightly shorter

Before

After

github-actions · 2022-08-03T17:44:41Z

Bundle Stats-With chunk and module information

Hey there, this message comes from a GitHub action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Files count	Type	Total bundle size	% Changed
2	bundled	1.98 MB	0%

Changeset

File	Δ
`src/client/this/file/has/a/long/name/so-that-it-will-hopefully-wrap.tsx`	🆕 +2.72 KB
`src/client/this-file-was-added.ts`	🆕 +1.46 KB
`src/client/this-is-another-file-with-a-long-name-to-test-the-table-sizing.tsx`	🆕 +1.04 KB
`src/client/helpers/this-file-is-much-larger.ts`	📈 +11.66 KB (+865.77%)
`src/client/this-file-grew-larger.tsx`	📈 +200 B (+35.59%)
`src/client/helpers/this-file-grew-smaller.ts`	📉 -200 B (-7.94%)
`src/client/this-file-is-much-smaller.tsx`	📉 -11.66 KB (-99.92%)
`src/client/routes.tsx`	🔥 -2.72 KB (-100%)
`src/client/this-file-will-be-deleted.ts`	🔥 -1.46 KB (-100%)
`src/client/render-memex.tsx`	🔥 -1.04 KB (-100%)

View detailed changes

File	Old	New	Δ
`src/client/this/file/has/a/long/name/so-that-it-will-hopefully-wrap.tsx`	0 B	2.72 KB	🆕 +2.72 KB
`src/client/this-file-was-added.ts`	0 B	1.46 KB	🆕 +1.46 KB
`src/client/this-is-another-file-with-a-long-name-to-test-the-table-sizing.tsx`	0 B	1.04 KB	🆕 +1.04 KB
`src/client/helpers/this-file-is-much-larger.ts`	1.35 KB	13.01 KB	📈 +11.66 KB (+865.77%)
`src/client/this-file-grew-larger.tsx`	562 B	762 B	📈 +200 B (+35.59%)
`src/client/helpers/this-file-grew-smaller.ts`	2.46 KB	2.26 KB	📉 -200 B (-7.94%)
`src/client/this-file-is-much-smaller.tsx`	11.67 KB	10 B	📉 -11.66 KB (-99.92%)
`src/client/routes.tsx`	2.72 KB	0 B	🔥 -2.72 KB (-100%)
`src/client/this-file-will-be-deleted.ts`	1.46 KB	0 B	🔥 -1.46 KB (-100%)
`src/client/render-memex.tsx`	1.04 KB	0 B	🔥 -1.04 KB (-100%)

View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

No assets were bigger

Smaller

No assets were smaller

Unchanged

Asset	Type	File Size	% Changed
app.bundle.js	bundled	1.98 MB	0%
manifest.json	bundled	91 B	0%

github-actions · 2022-08-03T17:44:43Z

Bundle Stats

Hey there, this message comes from a GitHub action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Files count	Type	Total bundle size	% Changed
7 -> 2	bundled gzip	1.34 MB -> 1.29 MB (-53.65 KB) 386.44 KB -> N/A	-3.91%

View detailed bundle breakdown

Added

No assets were added

Removed

Asset	Type	File Size	% Changed
296.chunk.js	bundled gzip	124.57 KB -> 0 B (-124.57 KB) 35.05 KB -> 0 B	-100%
288.chunk.js	bundled gzip	57.24 KB -> 0 B (-57.24 KB) 16.33 KB -> 0 B	-100%
920.chunk.js	bundled gzip	54.98 KB -> 0 B (-54.98 KB) 17.08 KB -> 0 B	-100%
912.chunk.js	bundled gzip	44.37 KB -> 0 B (-44.37 KB) 14.31 KB -> 0 B	-100%
699.chunk.js	bundled gzip	26.39 KB -> 0 B (-26.39 KB) 6.14 KB -> 0 B	-100%

Bigger

Asset	Type	File Size	% Changed
app.bundle.js	bundled gzip	1.04 MB -> 1.29 MB (+254.35 KB) 297.38 KB -> N/A	+23.91%

Smaller

Asset	Type	File Size	% Changed
manifest.json	bundled gzip	551 B -> 91 B (-460 B) 151 B -> N/A	-83.48%

Unchanged

No assets were unchanged

github-actions · 2022-08-03T17:44:44Z

Bundle Stats-Flipped around

Hey there, this message comes from a GitHub action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Files count	Type	Total bundle size	% Changed
2 -> 7	bundled gzip	1.29 MB -> 1.34 MB (+53.65 KB) N/A -> 386.44 KB	+4.07%

View detailed bundle breakdown

Added

Asset	Type	File Size	% Changed
296.chunk.js	bundled gzip	0 B -> 124.57 KB (+124.57 KB) 0 B -> 35.05 KB	-
288.chunk.js	bundled gzip	0 B -> 57.24 KB (+57.24 KB) 0 B -> 16.33 KB	-
920.chunk.js	bundled gzip	0 B -> 54.98 KB (+54.98 KB) 0 B -> 17.08 KB	-
912.chunk.js	bundled gzip	0 B -> 44.37 KB (+44.37 KB) 0 B -> 14.31 KB	-
699.chunk.js	bundled gzip	0 B -> 26.39 KB (+26.39 KB) 0 B -> 6.14 KB	-

Removed

No assets were removed

Bigger

Asset	Type	File Size	% Changed
manifest.json	bundled gzip	91 B -> 551 B (+460 B) N/A -> 151 B	+505.49%

Smaller

Asset	Type	File Size	% Changed
app.bundle.js	bundled gzip	1.29 MB -> 1.04 MB (-254.35 KB) N/A -> 297.38 KB	-19.29%

Unchanged

No assets were unchanged

github-actions · 2022-08-03T17:44:45Z

Bundle Stats-Non existent

Hey there, this message comes from a GitHub action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Files count	Type	Total bundle size	% Changed
0	bundled	0 B	0%

View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

No assets were bigger

Smaller

No assets were smaller

Unchanged

No assets were unchanged

github-actions · 2022-08-03T17:44:46Z

Bundle Stats-No changes

Hey there, this message comes from a GitHub action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Files count	Type	Total bundle size	% Changed
7	bundled gzip	1.34 MB 386.44 KB	0%

View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

No assets were bigger

Smaller

No assets were smaller

Unchanged

Asset	Type	File Size	% Changed
app.bundle.js	bundled gzip	1.04 MB 297.38 KB	0%
296.chunk.js	bundled gzip	124.57 KB 35.05 KB	0%
288.chunk.js	bundled gzip	57.24 KB 16.33 KB	0%
920.chunk.js	bundled gzip	54.98 KB 17.08 KB	0%
912.chunk.js	bundled gzip	44.37 KB 14.31 KB	0%
699.chunk.js	bundled gzip	26.39 KB 6.14 KB	0%
manifest.json	bundled gzip	551 B 151 B	0%

Add more files to the test changeset

b1ad2e9

camchenry added 15 commits August 3, 2022 17:51

Add separate columns for old/new sizes

af99cba

Update tests

bd21e96

Update dist

1441891

Remove separate percentage column, add emoji

de28a48

Update dist

7317592

Update emoji column

5765d80

Remove dedicated emoji column

8688b72

Show file name in code block and strip prefix slash or dot slash

9028967

Only show delta change, hide more info in details

b15a255

Fix table formatting

116b34c

Use break inside of newline

06be616

Generate separate more detailed table

41a63b0

Fix table formatting

6921875

Fix tests

29bcb9b

Update dist

cc6cf8d

camchenry requested review from a team August 3, 2022 21:30

camchenry marked this pull request as ready for review August 3, 2022 21:30

camchenry requested a review from a team as a code owner August 3, 2022 21:30

mattcosta7 approved these changes Aug 3, 2022

View reviewed changes

camchenry merged commit 17b6ac5 into main Aug 4, 2022

camchenry deleted the improve-markdown-comment branch August 4, 2022 15:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve Markdown comment #160

Improve Markdown comment #160

camchenry commented Aug 3, 2022 •

edited

Loading

github-actions bot commented Aug 3, 2022 •

edited

Loading

github-actions bot commented Aug 3, 2022 •

edited

Loading

github-actions bot commented Aug 3, 2022 •

edited

Loading

github-actions bot commented Aug 3, 2022 •

edited

Loading

github-actions bot commented Aug 3, 2022 •

edited

Loading

Improve Markdown comment #160

Improve Markdown comment #160

Conversation

camchenry commented Aug 3, 2022 • edited Loading

Description

Changes made

Before

After

github-actions bot commented Aug 3, 2022 • edited Loading

Bundle Stats-With chunk and module information

github-actions bot commented Aug 3, 2022 • edited Loading

Bundle Stats

github-actions bot commented Aug 3, 2022 • edited Loading

Bundle Stats-Flipped around

github-actions bot commented Aug 3, 2022 • edited Loading

Bundle Stats-Non existent

github-actions bot commented Aug 3, 2022 • edited Loading

Bundle Stats-No changes

camchenry commented Aug 3, 2022 •

edited

Loading

github-actions bot commented Aug 3, 2022 •

edited

Loading

github-actions bot commented Aug 3, 2022 •

edited

Loading

github-actions bot commented Aug 3, 2022 •

edited

Loading

github-actions bot commented Aug 3, 2022 •

edited

Loading

github-actions bot commented Aug 3, 2022 •

edited

Loading