feat(reporter): polish chart output (#40)

* feat(reporter): polish output

* fix

* fix

Author: AugustinMauroy

lib/reporter/chart.js

@@ -1,18 +1,25 @@
 const { platform, arch, cpus, totalmem } = require("node:os");
+const { styleText } = require("../utils/styleText");
 
 const formatter = Intl.NumberFormat(undefined, {
 	notation: "standard",
 	maximumFractionDigits: 2,
 });
 
-function drawBar(label, value, total, length = 30) {
+function drawBar(label, value, total, samples, length = 30) {
 	const percentage = value / total;
 	const filledLength = Math.round(length * percentage);
 	const bar = "█".repeat(filledLength) + "-".repeat(length - filledLength);
 
 	const opsSecReported = value < 100 ? value.toFixed(2) : value.toFixed(0);
+	const displayedOpsSec = styleText(
+		["yellow"],
+		formatter.format(opsSecReported),
+	);
+	const displayedSamples = styleText(["yellow"], samples.toString());
+
 	process.stdout.write(
-		`${label.padEnd(45)} | ${bar} | ${formatter.format(opsSecReported)} ops/sec\n`,
+		`${label.padEnd(45)} | ${bar} | ${displayedOpsSec} ops/sec | ${displayedSamples} samples\n`,
 	);
 }
 
@@ -29,7 +36,7 @@ function chartReport(results) {
 			`CPU Cores: ${environment.hardware}\n\n`,
 	);
 	for (const result of results) {
-		drawBar(result.name, result.opsSec, maxOpsSec);
+		drawBar(result.name, result.opsSec, maxOpsSec, result.histogram.samples);
 	}
 }
 

lib/reporter/text.js

@@ -1,10 +1,4 @@
-const util = require("node:util");
-
-const styleText =
-	typeof util.styleText === "function"
-		? util.styleText
-		: (_style, text) => text;
-
+const { styleText } = require("../utils/styleText");
 const { timer } = require("../clock");
 
 const formatter = Intl.NumberFormat(undefined, {

lib/utils/styleText.js

@@ -0,0 +1,6 @@
+const util = require("node:util");
+
+module.exports.styleText =
+	typeof util.styleText === "function"
+		? util.styleText
+		: (_style, text) => text;

test/reporter.js

@@ -51,6 +51,15 @@ describe("chartReport outputs benchmark results as a bar chart", async (t) => {
 	it("should include ops/sec", () => {
 		assert.ok(output.includes("ops/sec"));
 	});
+
+	it("should include benchmark names", () => {
+		assert.ok(output.includes("single with matcher"));
+		assert.ok(output.includes("multiple replaces"));
+	});
+
+	it("should include sample count", () => {
+		assert.ok(output.includes("samples"));
+	});
 });
 
 describe("htmlReport should create a file", async (t) => {