feat: Show more precise percentage changes (#97)

mister-ben · rschristian · web-flow · commit f2cd8784f679 · 2024-04-22T17:26:15.000-05:00
* feat: Add support for more precise percentage changes

* refactor: Hold off on making it a new option

---------

Co-authored-by: Ryan Christian &lt;rchristian@ryanchristian.dev&gt;
diff --git a/action.yml b/action.yml
@@ -41,4 +41,4 @@ inputs:
     description: 'A custom working directory to execute the action in relative to repo root (defaults to .)'
 runs:
   using: 'node20'
-  main: 'index.js'
+  main: 'index.js'
diff --git a/index.js b/index.js
diff --git a/src/utils.js b/src/utils.js
@@ -52,7 +52,7 @@ export function getDeltaText(delta, originalSize) {
 	} else if (originalSize === -delta) {
 		deltaText += ` (removed)`;
 	} else {
-		const percentage = Math.round((delta / originalSize) * 100);
+		const percentage = Number(((delta / originalSize) * 100).toFixed(2));
 		deltaText += ` (${percentage > 0 ? '+' : ''}${percentage}%)`;
 	}
 	return deltaText;
@@ -151,8 +151,8 @@ export function diffTable(files, { showTotal, collapseUnchanged, omitUnchanged,
 		if (isUnchanged && omitUnchanged) continue;
 
 		const columns = [
-			`\`${filename}\``, 
-			prettyBytes(size), 
+			`\`${filename}\``,
+			prettyBytes(size),
 			getDeltaText(delta, originalSize),
 			iconForDifference(delta, originalSize)
 		];
diff --git a/tests/__snapshots__/utils.spec.js.snap b/tests/__snapshots__/utils.spec.js.snap
@@ -1,15 +1,15 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
 exports[`diffTable 1`] = `
-"**Size Change:** +9 B (0%) 
+"**Size Change:** +9 B (+0.06%) 
 
 **Total Size:** 14.8 kB
 
 | Filename | Size | Change |  |
 | :--- | :---: | :---: | :---: |
 | \`one.js\` | 5 kB | +2.5 kB (+100%) | 🆘 |
-| \`two.js\` | 5 kB | -2.5 kB (-33%) | 🎉 |
-| \`four.js\` | 4.5 kB | +9 B (0%) |  |
+| \`two.js\` | 5 kB | -2.5 kB (-33.33%) | 🎉 |
+| \`four.js\` | 4.5 kB | +9 B (+0.2%) |  |
 
 <details><summary>ℹ️ <strong>View Unchanged</strong></summary>
 
@@ -26,8 +26,8 @@ exports[`diffTable 2`] = `
 "| Filename | Size | Change |  |
 | :--- | :---: | :---: | :---: |
 | \`one.js\` | 5 kB | +2.5 kB (+100%) | 🆘 |
-| \`two.js\` | 5 kB | -2.5 kB (-33%) | 🎉 |
-| \`four.js\` | 4.5 kB | +9 B (0%) |  |
+| \`two.js\` | 5 kB | -2.5 kB (-33.33%) | 🎉 |
+| \`four.js\` | 4.5 kB | +9 B (+0.2%) |  |
 
 <details><summary>ℹ️ <strong>View Unchanged</strong></summary>
 
@@ -41,46 +41,46 @@ exports[`diffTable 2`] = `
 `;
 
 exports[`diffTable 3`] = `
-"**Size Change:** +9 B (0%) 
+"**Size Change:** +9 B (+0.06%) 
 
 **Total Size:** 14.8 kB
 
 | Filename | Size | Change |  |
 | :--- | :---: | :---: | :---: |
 | \`one.js\` | 5 kB | +2.5 kB (+100%) | 🆘 |
-| \`two.js\` | 5 kB | -2.5 kB (-33%) | 🎉 |
+| \`two.js\` | 5 kB | -2.5 kB (-33.33%) | 🎉 |
 | \`three.js\` | 300 B | 0 B |  |
-| \`four.js\` | 4.5 kB | +9 B (0%) |  |"
+| \`four.js\` | 4.5 kB | +9 B (+0.2%) |  |"
 `;
 
 exports[`diffTable 4`] = `
-"**Size Change:** +9 B (0%) 
+"**Size Change:** +9 B (+0.06%) 
 
 **Total Size:** 14.8 kB
 
 | Filename | Size | Change |  |
 | :--- | :---: | :---: | :---: |
 | \`one.js\` | 5 kB | +2.5 kB (+100%) | 🆘 |
-| \`two.js\` | 5 kB | -2.5 kB (-33%) | 🎉 |
-| \`four.js\` | 4.5 kB | +9 B (0%) |  |"
+| \`two.js\` | 5 kB | -2.5 kB (-33.33%) | 🎉 |
+| \`four.js\` | 4.5 kB | +9 B (+0.2%) |  |"
 `;
 
 exports[`diffTable 5`] = `
-"**Size Change:** +9 B (0%) 
+"**Size Change:** +9 B (+0.06%) 
 
 **Total Size:** 14.8 kB
 
 | Filename | Size | Change |  |
 | :--- | :---: | :---: | :---: |
 | \`one.js\` | 5 kB | +2.5 kB (+100%) | 🆘 |
-| \`two.js\` | 5 kB | -2.5 kB (-33%) | 🎉 |
+| \`two.js\` | 5 kB | -2.5 kB (-33.33%) | 🎉 |
 
 <details><summary>ℹ️ <strong>View Unchanged</strong></summary>
 
 | Filename | Size | Change |
 | :--- | :---: | :---: |
 | \`three.js\` | 300 B | 0 B |
-| \`four.js\` | 4.5 kB | +9 B (0%) |
+| \`four.js\` | 4.5 kB | +9 B (+0.2%) |
 
 </details>
 
diff --git a/tests/utils.spec.js b/tests/utils.spec.js
@@ -15,6 +15,8 @@ test('getDeltaText', () => {
 	expect(getDeltaText(-5000, 20000)).toBe('-5 kB (-25%)');
 	expect(getDeltaText(210, 0)).toBe('+210 B (new file)');
 	expect(getDeltaText(0, 0)).toBe('0 B');
+	expect(getDeltaText(4875, 20000)).toBe('+4.88 kB (+24.38%)');
+	expect(getDeltaText(-4875, 20000)).toBe('-4.88 kB (-24.38%)');
 });
 
 test('iconForDifference', () => {
