feat: Allow hiding by remarks

exoego · Aug 14, 2024 · 84c18c9 · 84c18c9
1 parent 9a376bd
commit 84c18c9
Show file tree

Hide file tree

Showing 4 changed files with 45 additions and 40 deletions.
diff --git a/__tests__/with-base.test.ts b/__tests__/with-base.test.ts
@@ -72,10 +72,10 @@ describe("examples w/ base analysis", () => {
 				expect(comment).toMatch(/✅ {2}-\d+/);
 				expect(comment).toMatch(/✅ {2}No change/i);
 				if (isEven) {
-					expect(comment).not.toMatch(/\d bundles with no change are hidden./i);
+					expect(comment).not.toMatch(/\d bundles are hidden./i);
 					expect(comment).toMatch(/\(Total\) \| - \|.+⚠️/i);
 				} else {
-					expect(comment).toMatch(/\d bundles with no change are hidden./i);
+					expect(comment).toMatch(/\d bundles are hidden./i);
 					expect(comment).not.toMatch(/\(Total\) \| - \|.+⚠️/i);
 				}
 				expect(comment).toMatch(/🆕 Added/i);

diff --git a/dist/index.mjs b/dist/index.mjs
diff --git a/src/compare.ts b/src/compare.ts
@@ -69,7 +69,8 @@ This analysis was generated by [esbuild-bundle-analyzer](https://github.com/exoe
 			...currentStats,
 			baseBytes: baseStats.bytes,
 			tree,
-			remark: Math.sign(diff) ? "increased" : "decreased",
+			remark:
+				diff === 0 ? "no-change" : Math.sign(diff) ? "increased" : "decreased",
 		};
 	});
 	console.log("Comparison done.", comparison);
@@ -80,9 +81,10 @@ This analysis was generated by [esbuild-bundle-analyzer](https://github.com/exoe
 			input.includeSizeComparison,
 			input.percentExtraAttention,
 		);
-		output += noChangesTable(
+		output += hiddenTable(
 			comparison,
-			input.includeSizeComparison.has("no-change"),
+			input.includeSizeComparison,
+			input.percentExtraAttention,
 		);
 		output += fileSizeTable(comparison, input.topNLargestPaths);
 		output += detail(input);
@@ -213,6 +215,7 @@ function buildFileTree(input: Input) {
 }
 
 const spacer = " ";
+
 function filesize(bytes: number): string {
 	const sign = bytes < 0 ? "-" : "";
 	const n = Math.abs(bytes);
@@ -264,7 +267,7 @@ function markdownTable(
 		: [];
 
 	const individualRows = data.filter((d) =>
-		shouldShowBundle(d, sizeComparisonFilters.has("no-change")),
+		shouldShowBundle(d, sizeComparisonFilters.has(d.remark)),
 	);
 	const rows = [...totalRows, ...individualRows]
 		.map((d) => {
@@ -281,24 +284,28 @@ Meta File | Out File  | Size (raw) | Note
 ${rows}`;
 }
 
-function noChangesTable(
+function hiddenTable(
 	data: Array<CompareResult>,
-	showNoChange: boolean,
+	includeSizeComparison: Set<SizeComparisonFilter>,
+	redThreshold: number,
 ): string {
-	const noChangeBundles = data.filter(
-		(d) => !shouldShowBundle(d, showNoChange),
+	const hiddenBundles = data.filter(
+		(d) => !includeSizeComparison.has(d.remark),
 	);
-	const rows = noChangeBundles
+	const rows = hiddenBundles
 		.map((d) => {
-			return `${d.metafile} | ${d.outfile} | ${renderSize(d)} | ✅  No change\n`;
+			return `${d.metafile} | ${d.outfile} | ${renderSize(d)} | ${renderNote(
+				d,
+				redThreshold,
+			)}\n`;
 		})
 		.join("");
-	if (noChangeBundles.length === 0) {
+	if (hiddenBundles.length === 0) {
 		return "";
 	}
 	return `
 <details>
-<summary>${noChangeBundles.length} bundles with no change are hidden.</summary>    
+<summary>${hiddenBundles.length} bundles are hidden since not listed in include_size_comparison.</summary>    
 
 Meta File | Out File  | Size (raw) | Note 
 ----------|----------|-----------:|------
@@ -395,6 +402,7 @@ function renderBar(percent: number, bytes: number): string {
 // Block progression is 1/8 = 0.125
 const blocks = ["", "▏", "▎", "▍", "▌", "▋", "▊", "▉", "█"];
 const progression = 1 / (blocks.length - 1);
+
 function progress(value: number, length = 25, vmin = 0.0, vmax = 1.0) {
 	const v = value * length;
 	const integerPart = Math.floor(v);
@@ -416,14 +424,14 @@ function renderNote(d: CompareResult, redThreshold: number): string {
 	if (d.remark === "added") {
 		return "🆕 Added";
 	}
-	const diff = d.bytes - d.baseBytes;
-	if (diff !== 0) {
-		const percentChange = (diff / d.baseBytes) * 100;
-		return `${renderStatusIndicator(percentChange, redThreshold)}${filesize(
-			diff,
-		)} (${sign(percentChange)}${percentChange.toFixed(1)}%)`;
+	if (d.remark === "no-change") {
+		return "✅  No change";
 	}
-	return "✅  No change";
+	const diff = d.bytes - d.baseBytes;
+	const percentChange = (diff / d.baseBytes) * 100;
+	return `${renderStatusIndicator(percentChange, redThreshold)}${filesize(
+		diff,
+	)} (${sign(percentChange)}${percentChange.toFixed(1)}%)`;
 }
 
 function sign(num: number): string {

diff --git a/src/types.ts b/src/types.ts
@@ -10,14 +10,11 @@ export interface CompareResult {
 	outfile: string;
 	bytes: number;
 	baseBytes: number;
-	remark: "added" | "deleted" | "increased" | "decreased";
+	remark: "added" | "deleted" | "increased" | "decreased" | "no-change";
 	tree: TreeMapNode | undefined;
 }
 
-export type SizeComparisonFilter =
-	| CompareResult["remark"]
-	| "total"
-	| "no-change";
+export type SizeComparisonFilter = CompareResult["remark"] | "total";
 
 export interface Input {
 	name: string;