@benchkit/format 0.1.0

package/dist/format-comparison-markdown.js

@@ -0,0 +1,142 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatComparisonMarkdown = formatComparisonMarkdown;
+const DEFAULT_OPTIONS = {
+    currentLabel: "Current",
+    baselineLabel: "Baseline",
+    maxRegressions: 10,
+    includeDetails: true,
+    footerHref: "https://github.com/strawgate/benchkit",
+};
+function isMonitorEntry(entry) {
+    return entry.benchmark.startsWith("_monitor/");
+}
+function sortAlphabetically(entries) {
+    return [...entries].sort((a, b) => {
+        if (a.benchmark !== b.benchmark)
+            return a.benchmark.localeCompare(b.benchmark);
+        return a.metric.localeCompare(b.metric);
+    });
+}
+function formatNumber(value) {
+    if (Math.abs(value) >= 1000 || Number.isInteger(value)) {
+        return value.toLocaleString("en-US", { maximumFractionDigits: 0 });
+    }
+    return value.toLocaleString("en-US", { maximumFractionDigits: 2 });
+}
+function formatValue(value, unit) {
+    return unit ? `${formatNumber(value)} ${unit}` : formatNumber(value);
+}
+function formatPercent(value) {
+    return `${value > 0 ? "+" : ""}${value.toFixed(2)}%`;
+}
+function directionArrow(entry) {
+    if (entry.status === "stable")
+        return "→";
+    if (entry.direction === "smaller_is_better") {
+        return entry.status === "regressed" ? "↑" : "↓";
+    }
+    return entry.status === "regressed" ? "↓" : "↑";
+}
+function statusLabel(entry) {
+    return `${entry.status} ${directionArrow(entry)}`;
+}
+function formatCurrentRef(ref) {
+    const prMatch = /^refs\/pull\/(\d+)\/merge$/.exec(ref);
+    if (prMatch) {
+        return `PR #${prMatch[1]}`;
+    }
+    return ref;
+}
+function formatHeader(options) {
+    const lines = [];
+    lines.push(`## ${options.title ?? "Benchmark Comparison"}`);
+    if (options.currentCommit || options.currentRef) {
+        const parts = [
+            options.currentCommit ? `commit \`${options.currentCommit.slice(0, 8)}\`` : "",
+            options.currentRef ? `ref \`${formatCurrentRef(options.currentRef)}\`` : "",
+        ].filter(Boolean);
+        lines.push(`Comparing results for ${parts.join(" on ")}.`);
+    }
+    return lines;
+}
+function formatTable(entries, options) {
+    const lines = [
+        `| Benchmark | Metric | ${options.baselineLabel} | ${options.currentLabel} | Δ% | Status |`,
+        "| --- | --- | --- | --- | --- | --- |",
+    ];
+    for (const entry of sortAlphabetically(entries)) {
+        lines.push(`| \`${entry.benchmark}\` | \`${entry.metric}\` | ${formatValue(entry.baseline, entry.unit)} | ${formatValue(entry.current, entry.unit)} | ${formatPercent(entry.percentChange)} | ${statusLabel(entry)} |`);
+    }
+    return lines;
+}
+function groupByMetric(entries) {
+    const grouped = new Map();
+    for (const entry of entries) {
+        const key = entry.metric;
+        const existing = grouped.get(key);
+        if (existing)
+            existing.push(entry);
+        else
+            grouped.set(key, [entry]);
+    }
+    return new Map([...grouped.entries()].sort((a, b) => a[0].localeCompare(b[0])));
+}
+function formatComparisonMarkdown(result, options = {}) {
+    const resolved = { ...DEFAULT_OPTIONS, ...options };
+    const lines = [];
+    lines.push(...formatHeader(options));
+    lines.push("");
+    if (result.entries.length === 0) {
+        lines.push("No comparable baseline data found.");
+        lines.push("");
+        lines.push(`Generated by [benchkit](${resolved.footerHref}).`);
+        return lines.join("\n");
+    }
+    const benchmarkEntries = result.entries.filter((entry) => !isMonitorEntry(entry));
+    const monitorEntries = result.entries.filter((entry) => isMonitorEntry(entry));
+    const regressions = sortAlphabetically(result.entries.filter((entry) => entry.status === "regressed"));
+    if (regressions.length > 0) {
+        lines.push("### Regressions");
+        lines.push("");
+        lines.push(...formatTable(regressions.slice(0, resolved.maxRegressions), resolved));
+        if (regressions.length > resolved.maxRegressions) {
+            lines.push("");
+            lines.push(`Showing ${resolved.maxRegressions} of ${regressions.length} regressions.`);
+        }
+        lines.push("");
+    }
+    else {
+        lines.push("No regressions detected.");
+        lines.push("");
+    }
+    if (benchmarkEntries.length > 0) {
+        lines.push("### Benchmark Metrics");
+        lines.push("");
+        lines.push(...formatTable(benchmarkEntries, resolved));
+        lines.push("");
+    }
+    if (monitorEntries.length > 0) {
+        lines.push("### Monitor Metrics");
+        lines.push("");
+        lines.push(...formatTable(monitorEntries, resolved));
+        lines.push("");
+    }
+    if (resolved.includeDetails) {
+        const grouped = groupByMetric(result.entries);
+        lines.push("<details>");
+        lines.push("<summary>Per-metric detail</summary>");
+        lines.push("");
+        for (const [metric, entries] of grouped.entries()) {
+            lines.push(`#### \`${metric}\``);
+            lines.push("");
+            lines.push(...formatTable(entries, resolved));
+            lines.push("");
+        }
+        lines.push("</details>");
+        lines.push("");
+    }
+    lines.push(`Generated by [benchkit](${resolved.footerHref}).`);
+    return lines.join("\n");
+}
+//# sourceMappingURL=format-comparison-markdown.js.map

package/dist/format-comparison-markdown.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"format-comparison-markdown.js","sourceRoot":"","sources":["../src/format-comparison-markdown.ts"],"names":[],"mappings":";;AAyGA,4DAkEC;AArKD,MAAM,eAAe,GAKjB;IACF,YAAY,EAAE,SAAS;IACvB,aAAa,EAAE,UAAU;IACzB,cAAc,EAAE,EAAE;IAClB,cAAc,EAAE,IAAI;IACpB,UAAU,EAAE,uCAAuC;CACpD,CAAC;AAEF,SAAS,cAAc,CAAC,KAAsB;IAC5C,OAAO,KAAK,CAAC,SAAS,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;AACjD,CAAC;AAED,SAAS,kBAAkB,CAAC,OAA0B;IACpD,OAAO,CAAC,GAAG,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QAChC,IAAI,CAAC,CAAC,SAAS,KAAK,CAAC,CAAC,SAAS;YAAE,OAAO,CAAC,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QAC/E,OAAO,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IAC1C,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,YAAY,CAAC,KAAa;IACjC,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,IAAI,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;QACvD,OAAO,KAAK,CAAC,cAAc,CAAC,OAAO,EAAE,EAAE,qBAAqB,EAAE,CAAC,EAAE,CAAC,CAAC;IACrE,CAAC;IAED,OAAO,KAAK,CAAC,cAAc,CAAC,OAAO,EAAE,EAAE,qBAAqB,EAAE,CAAC,EAAE,CAAC,CAAC;AACrE,CAAC;AAED,SAAS,WAAW,CAAC,KAAa,EAAE,IAAa;IAC/C,OAAO,IAAI,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;AACvE,CAAC;AAED,SAAS,aAAa,CAAC,KAAa;IAClC,OAAO,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC;AACvD,CAAC;AAED,SAAS,cAAc,CAAC,KAAsB;IAC5C,IAAI,KAAK,CAAC,MAAM,KAAK,QAAQ;QAAE,OAAO,GAAG,CAAC;IAC1C,IAAI,KAAK,CAAC,SAAS,KAAK,mBAAmB,EAAE,CAAC;QAC5C,OAAO,KAAK,CAAC,MAAM,KAAK,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;IAClD,CAAC;IACD,OAAO,KAAK,CAAC,MAAM,KAAK,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;AAClD,CAAC;AAED,SAAS,WAAW,CAAC,KAAsB;IACzC,OAAO,GAAG,KAAK,CAAC,MAAM,IAAI,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;AACpD,CAAC;AAED,SAAS,gBAAgB,CAAC,GAAW;IACnC,MAAM,OAAO,GAAG,4BAA4B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACvD,IAAI,OAAO,EAAE,CAAC;QACZ,OAAO,OAAO,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;IAC7B,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAS,YAAY,CAAC,OAAwC;IAC5D,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,CAAC,IAAI,CAAC,MAAM,OAAO,CAAC,KAAK,IAAI,sBAAsB,EAAE,CAAC,CAAC;IAC5D,IAAI,OAAO,CAAC,aAAa,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;QAChD,MAAM,KAAK,GAAG;YACZ,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,YAAY,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE;YAC9E,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,gBAAgB,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE;SAC5E,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAClB,KAAK,CAAC,IAAI,CAAC,yBAAyB,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC7D,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,WAAW,CAAC,OAA0B,EAAE,OAA0F;IACzI,MAAM,KAAK,GAAG;QACZ,0BAA0B,OAAO,CAAC,aAAa,MAAM,OAAO,CAAC,YAAY,kBAAkB;QAC3F,uCAAuC;KACxC,CAAC;IAEF,KAAK,MAAM,KAAK,IAAI,kBAAkB,CAAC,OAAO,CAAC,EAAE,CAAC;QAChD,KAAK,CAAC,IAAI,CACR,OAAO,KAAK,CAAC,SAAS,UAAU,KAAK,CAAC,MAAM,QAAQ,WAAW,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,WAAW,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,aAAa,CAAC,KAAK,CAAC,aAAa,CAAC,MAAM,WAAW,CAAC,KAAK,CAAC,IAAI,CAC5M,CAAC;IACJ,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,aAAa,CAAC,OAA0B;IAC/C,MAAM,OAAO,GAAG,IAAI,GAAG,EAA6B,CAAC;IACrD,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;QAC5B,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,CAAC;QACzB,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAClC,IAAI,QAAQ;YAAE,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;;YAC9B,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;IACjC,CAAC;IACD,OAAO,IAAI,GAAG,CAAC,CAAC,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAClF,CAAC;AAED,SAAgB,wBAAwB,CACtC,MAAwB,EACxB,UAA2C,EAAE;IAE7C,MAAM,QAAQ,GAAG,EAAE,GAAG,eAAe,EAAE,GAAG,OAAO,EAAE,CAAC;IACpD,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,KAAK,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC;IACrC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEf,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAChC,KAAK,CAAC,IAAI,CAAC,oCAAoC,CAAC,CAAC;QACjD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,CAAC,IAAI,CAAC,2BAA2B,QAAQ,CAAC,UAAU,IAAI,CAAC,CAAC;QAC/D,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IAED,MAAM,gBAAgB,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;IAClF,MAAM,cAAc,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;IAC/E,MAAM,WAAW,GAAG,kBAAkB,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,KAAK,WAAW,CAAC,CAAC,CAAC;IAEvG,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3B,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAC9B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC,cAAc,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC;QACpF,IAAI,WAAW,CAAC,MAAM,GAAG,QAAQ,CAAC,cAAc,EAAE,CAAC;YACjD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACf,KAAK,CAAC,IAAI,CAAC,WAAW,QAAQ,CAAC,cAAc,OAAO,WAAW,CAAC,MAAM,eAAe,CAAC,CAAC;QACzF,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;SAAM,CAAC;QACN,KAAK,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;QACvC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IAED,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAChC,KAAK,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;QACpC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAC,CAAC;QACvD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IAED,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC9B,KAAK,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAClC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC,CAAC;QACrD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IAED,IAAI,QAAQ,CAAC,cAAc,EAAE,CAAC;QAC5B,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC9C,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACxB,KAAK,CAAC,IAAI,CAAC,sCAAsC,CAAC,CAAC;QACnD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;YAClD,KAAK,CAAC,IAAI,CAAC,UAAU,MAAM,IAAI,CAAC,CAAC;YACjC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACf,KAAK,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC;YAC9C,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACjB,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACzB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,2BAA2B,QAAQ,CAAC,UAAU,IAAI,CAAC,CAAC;IAC/D,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC"}

package/dist/format-comparison-markdown.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=format-comparison-markdown.test.d.ts.map

package/dist/format-comparison-markdown.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"format-comparison-markdown.test.d.ts","sourceRoot":"","sources":["../src/format-comparison-markdown.test.ts"],"names":[],"mappings":""}

package/dist/format-comparison-markdown.test.js

@@ -0,0 +1,173 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_test_1 = require("node:test");
+const strict_1 = __importDefault(require("node:assert/strict"));
+const format_comparison_markdown_js_1 = require("./format-comparison-markdown.js");
+function makeResult(entries) {
+    return {
+        entries,
+        hasRegression: entries.some((entry) => entry.status === "regressed"),
+    };
+}
+(0, node_test_1.describe)("formatComparisonMarkdown", () => {
+    (0, node_test_1.it)("formats a mixed benchmark and monitor comparison", () => {
+        const result = makeResult([
+            {
+                benchmark: "full-agent-dissect",
+                metric: "events_per_sec",
+                unit: "events/sec",
+                direction: "bigger_is_better",
+                baseline: 13240.5,
+                current: 12500.25,
+                percentChange: -5.59,
+                status: "regressed",
+            },
+            {
+                benchmark: "full-agent-dissect",
+                metric: "service_rss_mb",
+                unit: "MB",
+                direction: "smaller_is_better",
+                baseline: 543.1,
+                current: 520.2,
+                percentChange: -4.22,
+                status: "improved",
+            },
+            {
+                benchmark: "_monitor/system",
+                metric: "cpu_user_pct",
+                unit: "%",
+                direction: "smaller_is_better",
+                baseline: 67.4,
+                current: 71.2,
+                percentChange: 5.64,
+                status: "regressed",
+            },
+        ]);
+        const markdown = (0, format_comparison_markdown_js_1.formatComparisonMarkdown)(result, {
+            title: "PR benchmark comparison",
+            currentCommit: "abcdef1234567890",
+            currentRef: "refs/pull/42/merge",
+            currentLabel: "PR",
+            baselineLabel: "main",
+        });
+        strict_1.default.equal(markdown, `## PR benchmark comparison
+Comparing results for commit \`abcdef12\` on ref \`PR #42\`.
+
+### Regressions
+
+| Benchmark | Metric | main | PR | Δ% | Status |
+| --- | --- | --- | --- | --- | --- |
+| \`_monitor/system\` | \`cpu_user_pct\` | 67.4 % | 71.2 % | +5.64% | regressed ↑ |
+| \`full-agent-dissect\` | \`events_per_sec\` | 13,241 events/sec | 12,500 events/sec | -5.59% | regressed ↓ |
+
+### Benchmark Metrics
+
+| Benchmark | Metric | main | PR | Δ% | Status |
+| --- | --- | --- | --- | --- | --- |
+| \`full-agent-dissect\` | \`events_per_sec\` | 13,241 events/sec | 12,500 events/sec | -5.59% | regressed ↓ |
+| \`full-agent-dissect\` | \`service_rss_mb\` | 543.1 MB | 520.2 MB | -4.22% | improved ↓ |
+
+### Monitor Metrics
+
+| Benchmark | Metric | main | PR | Δ% | Status |
+| --- | --- | --- | --- | --- | --- |
+| \`_monitor/system\` | \`cpu_user_pct\` | 67.4 % | 71.2 % | +5.64% | regressed ↑ |
+
+<details>
+<summary>Per-metric detail</summary>
+
+#### \`cpu_user_pct\`
+
+| Benchmark | Metric | main | PR | Δ% | Status |
+| --- | --- | --- | --- | --- | --- |
+| \`_monitor/system\` | \`cpu_user_pct\` | 67.4 % | 71.2 % | +5.64% | regressed ↑ |
+
+#### \`events_per_sec\`
+
+| Benchmark | Metric | main | PR | Δ% | Status |
+| --- | --- | --- | --- | --- | --- |
+| \`full-agent-dissect\` | \`events_per_sec\` | 13,241 events/sec | 12,500 events/sec | -5.59% | regressed ↓ |
+
+#### \`service_rss_mb\`
+
+| Benchmark | Metric | main | PR | Δ% | Status |
+| --- | --- | --- | --- | --- | --- |
+| \`full-agent-dissect\` | \`service_rss_mb\` | 543.1 MB | 520.2 MB | -4.22% | improved ↓ |
+
+</details>
+
+Generated by [benchkit](https://github.com/strawgate/benchkit).`);
+    });
+    (0, node_test_1.it)("keeps non-PR refs unchanged in the header", () => {
+        const markdown = (0, format_comparison_markdown_js_1.formatComparisonMarkdown)(makeResult([]), {
+            title: "Comparison summary",
+            currentRef: "refs/heads/main",
+        });
+        strict_1.default.match(markdown, /ref `refs\/heads\/main`/);
+    });
+    (0, node_test_1.it)("keeps refs/pull/N/head unchanged in the header", () => {
+        const markdown = (0, format_comparison_markdown_js_1.formatComparisonMarkdown)(makeResult([]), {
+            title: "Comparison summary",
+            currentRef: "refs/pull/42/head",
+        });
+        strict_1.default.match(markdown, /ref `refs\/pull\/42\/head`/);
+    });
+    (0, node_test_1.it)("reports no regressions cleanly", () => {
+        const result = makeResult([
+            {
+                benchmark: "passthrough",
+                metric: "events_per_sec",
+                unit: "events/sec",
+                direction: "bigger_is_better",
+                baseline: 1000,
+                current: 1100,
+                percentChange: 10,
+                status: "improved",
+            },
+        ]);
+        const markdown = (0, format_comparison_markdown_js_1.formatComparisonMarkdown)(result, { includeDetails: false });
+        strict_1.default.match(markdown, /No regressions detected\./);
+        strict_1.default.match(markdown, /### Benchmark Metrics/);
+        strict_1.default.doesNotMatch(markdown, /Per-metric detail/);
+    });
+    (0, node_test_1.it)("handles empty comparisons as no baseline data", () => {
+        const markdown = (0, format_comparison_markdown_js_1.formatComparisonMarkdown)(makeResult([]), {
+            title: "Comparison summary",
+        });
+        strict_1.default.equal(markdown, `## Comparison summary
+
+No comparable baseline data found.
+
+Generated by [benchkit](https://github.com/strawgate/benchkit).`);
+    });
+    (0, node_test_1.it)("limits the regression summary when maxRegressions is set", () => {
+        const result = makeResult([
+            {
+                benchmark: "bench-a",
+                metric: "ns_per_op",
+                unit: "ns/op",
+                direction: "smaller_is_better",
+                baseline: 100,
+                current: 120,
+                percentChange: 20,
+                status: "regressed",
+            },
+            {
+                benchmark: "bench-b",
+                metric: "ns_per_op",
+                unit: "ns/op",
+                direction: "smaller_is_better",
+                baseline: 100,
+                current: 125,
+                percentChange: 25,
+                status: "regressed",
+            },
+        ]);
+        const markdown = (0, format_comparison_markdown_js_1.formatComparisonMarkdown)(result, { maxRegressions: 1 });
+        strict_1.default.match(markdown, /Showing 1 of 2 regressions\./);
+    });
+});
+//# sourceMappingURL=format-comparison-markdown.test.js.map

package/dist/format-comparison-markdown.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"format-comparison-markdown.test.js","sourceRoot":"","sources":["../src/format-comparison-markdown.test.ts"],"names":[],"mappings":";;;;;AAAA,yCAAyC;AACzC,gEAAwC;AACxC,mFAA2E;AAG3E,SAAS,UAAU,CAAC,OAAoC;IACtD,OAAO;QACL,OAAO;QACP,aAAa,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,KAAK,WAAW,CAAC;KACrE,CAAC;AACJ,CAAC;AAED,IAAA,oBAAQ,EAAC,0BAA0B,EAAE,GAAG,EAAE;IACxC,IAAA,cAAE,EAAC,kDAAkD,EAAE,GAAG,EAAE;QAC1D,MAAM,MAAM,GAAG,UAAU,CAAC;YACxB;gBACE,SAAS,EAAE,oBAAoB;gBAC/B,MAAM,EAAE,gBAAgB;gBACxB,IAAI,EAAE,YAAY;gBAClB,SAAS,EAAE,kBAAkB;gBAC7B,QAAQ,EAAE,OAAO;gBACjB,OAAO,EAAE,QAAQ;gBACjB,aAAa,EAAE,CAAC,IAAI;gBACpB,MAAM,EAAE,WAAW;aACpB;YACD;gBACE,SAAS,EAAE,oBAAoB;gBAC/B,MAAM,EAAE,gBAAgB;gBACxB,IAAI,EAAE,IAAI;gBACV,SAAS,EAAE,mBAAmB;gBAC9B,QAAQ,EAAE,KAAK;gBACf,OAAO,EAAE,KAAK;gBACd,aAAa,EAAE,CAAC,IAAI;gBACpB,MAAM,EAAE,UAAU;aACnB;YACD;gBACE,SAAS,EAAE,iBAAiB;gBAC5B,MAAM,EAAE,cAAc;gBACtB,IAAI,EAAE,GAAG;gBACT,SAAS,EAAE,mBAAmB;gBAC9B,QAAQ,EAAE,IAAI;gBACd,OAAO,EAAE,IAAI;gBACb,aAAa,EAAE,IAAI;gBACnB,MAAM,EAAE,WAAW;aACpB;SACF,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,IAAA,wDAAwB,EAAC,MAAM,EAAE;YAChD,KAAK,EAAE,yBAAyB;YAChC,aAAa,EAAE,kBAAkB;YACjC,UAAU,EAAE,oBAAoB;YAChC,YAAY,EAAE,IAAI;YAClB,aAAa,EAAE,MAAM;SACtB,CAAC,CAAC;QAEH,gBAAM,CAAC,KAAK,CACV,QAAQ,EACR;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gEA8C0D,CACzD,CAAC;IACN,CAAC,CAAC,CAAC;IAEH,IAAA,cAAE,EAAC,2CAA2C,EAAE,GAAG,EAAE;QACnD,MAAM,QAAQ,GAAG,IAAA,wDAAwB,EAAC,UAAU,CAAC,EAAE,CAAC,EAAE;YACxD,KAAK,EAAE,oBAAoB;YAC3B,UAAU,EAAE,iBAAiB;SAC9B,CAAC,CAAC;QACH,gBAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,yBAAyB,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,IAAA,cAAE,EAAC,gDAAgD,EAAE,GAAG,EAAE;QACxD,MAAM,QAAQ,GAAG,IAAA,wDAAwB,EAAC,UAAU,CAAC,EAAE,CAAC,EAAE;YACxD,KAAK,EAAE,oBAAoB;YAC3B,UAAU,EAAE,mBAAmB;SAChC,CAAC,CAAC;QACH,gBAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,4BAA4B,CAAC,CAAC;IACvD,CAAC,CAAC,CAAC;IAEH,IAAA,cAAE,EAAC,gCAAgC,EAAE,GAAG,EAAE;QACxC,MAAM,MAAM,GAAG,UAAU,CAAC;YACxB;gBACE,SAAS,EAAE,aAAa;gBACxB,MAAM,EAAE,gBAAgB;gBACxB,IAAI,EAAE,YAAY;gBAClB,SAAS,EAAE,kBAAkB;gBAC7B,QAAQ,EAAE,IAAI;gBACd,OAAO,EAAE,IAAI;gBACb,aAAa,EAAE,EAAE;gBACjB,MAAM,EAAE,UAAU;aACnB;SACF,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,IAAA,wDAAwB,EAAC,MAAM,EAAE,EAAE,cAAc,EAAE,KAAK,EAAE,CAAC,CAAC;QAC7E,gBAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,2BAA2B,CAAC,CAAC;QACpD,gBAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,uBAAuB,CAAC,CAAC;QAChD,gBAAM,CAAC,YAAY,CAAC,QAAQ,EAAE,mBAAmB,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;IAEH,IAAA,cAAE,EAAC,+CAA+C,EAAE,GAAG,EAAE;QACvD,MAAM,QAAQ,GAAG,IAAA,wDAAwB,EAAC,UAAU,CAAC,EAAE,CAAC,EAAE;YACxD,KAAK,EAAE,oBAAoB;SAC5B,CAAC,CAAC;QACH,gBAAM,CAAC,KAAK,CACV,QAAQ,EACR;;;;gEAI0D,CAC3D,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAA,cAAE,EAAC,0DAA0D,EAAE,GAAG,EAAE;QAClE,MAAM,MAAM,GAAG,UAAU,CAAC;YACxB;gBACE,SAAS,EAAE,SAAS;gBACpB,MAAM,EAAE,WAAW;gBACnB,IAAI,EAAE,OAAO;gBACb,SAAS,EAAE,mBAAmB;gBAC9B,QAAQ,EAAE,GAAG;gBACb,OAAO,EAAE,GAAG;gBACZ,aAAa,EAAE,EAAE;gBACjB,MAAM,EAAE,WAAW;aACpB;YACD;gBACE,SAAS,EAAE,SAAS;gBACpB,MAAM,EAAE,WAAW;gBACnB,IAAI,EAAE,OAAO;gBACb,SAAS,EAAE,mBAAmB;gBAC9B,QAAQ,EAAE,GAAG;gBACb,OAAO,EAAE,GAAG;gBACZ,aAAa,EAAE,EAAE;gBACjB,MAAM,EAAE,WAAW;aACpB;SACF,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,IAAA,wDAAwB,EAAC,MAAM,EAAE,EAAE,cAAc,EAAE,CAAC,EAAE,CAAC,CAAC;QACzE,gBAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,8BAA8B,CAAC,CAAC;IACzD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,38 @@
+export type { MetricDirection, BenchkitRunKind, OtlpAggregationTemporality, OtlpAttribute, OtlpAnyValue, OtlpGaugeDataPoint, OtlpHistogramDataPoint, OtlpGaugeMetric, OtlpSumMetric, OtlpHistogramMetric, OtlpMetric, OtlpScopeMetrics, OtlpResource, OtlpResourceMetrics, OtlpMetricsDocument, Sample, MonitorContext, SeriesFile, SeriesEntry, DataPoint, IndexFile, RunEntry, ComparisonResult, ComparisonEntry, ComparisonStatus, FormatComparisonMarkdownOptions, ThresholdConfig, RefIndexEntry, PrIndexEntry, RunSnapshotMetric, RunDetailMetricSnapshot, RunDetailView, MetricSummaryEntry, } from "./types.js";
+/** Parse benchmark output in any supported format (auto-detect, go, native, benchmark-action). */
+export { parseBenchmarks } from "./parse.js";
+export type { Format } from "./parse.js";
+/** Infer the `direction` ("smaller_is_better" / "bigger_is_better") from a metric unit string. */
+export { inferDirection } from "./infer-direction.js";
+/** Convert a benchmark unit string to a normalized metric name (e.g. "ns/op" -> "ns_per_op"). */
+export { unitToMetricName } from "./parser-utils.js";
+/** Parse Go testing/benchmark output text. */
+export { parseGoBench } from "./parse-go.js";
+/** Parse Rust cargo bench (libtest) output text. */
+export { parseRustBench } from "./parse-rust.js";
+/** Parse benchmark-action/github-action-benchmark JSON format. */
+export { parseBenchmarkAction } from "./parse-benchmark-action.js";
+/** Parse Hyperfine JSON format. */
+export { parseHyperfine } from "./parse-hyperfine.js";
+/** Parse pytest-benchmark JSON format. */
+export { parsePytestBenchmark } from "./parse-pytest-benchmark.js";
+/** Parse OTLP metrics JSON. */
+export { parseOtlp, otlpAttributesToRecord, getOtlpMetricKind, getOtlpTemporality, } from "./parse-otlp.js";
+/** OTLP semantic convention constants — attribute names, valid values, reserved keys. */
+export { ATTR_RUN_ID, ATTR_KIND, ATTR_SOURCE_FORMAT, ATTR_REF, ATTR_COMMIT, ATTR_WORKFLOW, ATTR_JOB, ATTR_RUN_ATTEMPT, ATTR_RUNNER, ATTR_SERVICE_NAME, ATTR_SERVICE_VERSION, ATTR_SCENARIO, ATTR_SERIES, ATTR_METRIC_DIRECTION, ATTR_METRIC_ROLE, ATTR_IMPL, ATTR_DATASET, ATTR_TRANSPORT, ATTR_BATCH_SIZE, ATTR_PROCESS, ATTR_PIPELINE, ATTR_VARIANT, REQUIRED_RESOURCE_ATTRIBUTES, RESERVED_DATAPOINT_ATTRIBUTES, VALID_RUN_KINDS, VALID_DIRECTIONS, VALID_METRIC_ROLES, VALID_SOURCE_FORMATS, MONITOR_METRIC_PREFIX, DEFAULT_DATA_BRANCH, } from "./otlp-conventions.js";
+export type { RunKind, Direction, MetricRole, SourceFormat } from "./otlp-conventions.js";
+/** Runtime validators for the benchkit OTLP semantic contract. */
+export { validateRequiredResourceAttributes, validateRequiredDatapointAttributes, validateRunKind, validateDirection, validateMetricRole, validateSourceFormat, isValidRunKind, isValidDirection, isValidMetricRole, isValidSourceFormat, isMonitorMetric, } from "./otlp-validation.js";
+/** Compare a current benchmark run against baseline runs to detect regressions. */
+export { compareRuns } from "./compare.js";
+/** Format a ComparisonResult as markdown for job summaries and PR comments. */
+export { formatComparisonMarkdown } from "./format-comparison-markdown.js";
+/** Retry helpers for push operations. */
+export { computeRetryDelayMs, sleep, DEFAULT_PUSH_RETRY_COUNT, RETRY_DELAY_MIN_MS, RETRY_DELAY_MAX_MS } from "./retry.js";
+/** Build an OtlpMetricsDocument from a simple benchmark input shape. */
+export { buildOtlpResult } from "./build-otlp-result.js";
+export type { OtlpResultMetric, OtlpResultBenchmark, OtlpResultContext, BuildOtlpResultOptions } from "./build-otlp-result.js";
+/** Ergonomic batch wrapper over OtlpMetricsDocument. */
+export { MetricsBatch, seriesKey } from "./metrics-batch.js";
+export type { MetricPoint, ResourceContext } from "./metrics-batch.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,eAAe,EACf,eAAe,EACf,0BAA0B,EAC1B,aAAa,EACb,YAAY,EACZ,kBAAkB,EAClB,sBAAsB,EACtB,eAAe,EACf,aAAa,EACb,mBAAmB,EACnB,UAAU,EACV,gBAAgB,EAChB,YAAY,EACZ,mBAAmB,EACnB,mBAAmB,EACnB,MAAM,EACN,cAAc,EACd,UAAU,EACV,WAAW,EACX,SAAS,EACT,SAAS,EACT,QAAQ,EACR,gBAAgB,EAChB,eAAe,EACf,gBAAgB,EAChB,+BAA+B,EAC/B,eAAe,EACf,aAAa,EACb,YAAY,EACZ,iBAAiB,EACjB,uBAAuB,EACvB,aAAa,EACb,kBAAkB,GACnB,MAAM,YAAY,CAAC;AAEpB,kGAAkG;AAClG,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAC7C,YAAY,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AACzC,kGAAkG;AAClG,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,iGAAiG;AACjG,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AACrD,8CAA8C;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,oDAAoD;AACpD,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACjD,kEAAkE;AAClE,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AACnE,mCAAmC;AACnC,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,0CAA0C;AAC1C,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AACnE,+BAA+B;AAC/B,OAAO,EACL,SAAS,EACT,sBAAsB,EACtB,iBAAiB,EACjB,kBAAkB,GACnB,MAAM,iBAAiB,CAAC;AACzB,yFAAyF;AACzF,OAAO,EACL,WAAW,EACX,SAAS,EACT,kBAAkB,EAClB,QAAQ,EACR,WAAW,EACX,aAAa,EACb,QAAQ,EACR,gBAAgB,EAChB,WAAW,EACX,iBAAiB,EACjB,oBAAoB,EACpB,aAAa,EACb,WAAW,EACX,qBAAqB,EACrB,gBAAgB,EAChB,SAAS,EACT,YAAY,EACZ,cAAc,EACd,eAAe,EACf,YAAY,EACZ,aAAa,EACb,YAAY,EACZ,4BAA4B,EAC5B,6BAA6B,EAC7B,eAAe,EACf,gBAAgB,EAChB,kBAAkB,EAClB,oBAAoB,EACpB,qBAAqB,EACrB,mBAAmB,GACpB,MAAM,uBAAuB,CAAC;AAC/B,YAAY,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAC1F,kEAAkE;AAClE,OAAO,EACL,kCAAkC,EAClC,mCAAmC,EACnC,eAAe,EACf,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,cAAc,EACd,gBAAgB,EAChB,iBAAiB,EACjB,mBAAmB,EACnB,eAAe,GAChB,MAAM,sBAAsB,CAAC;AAC9B,mFAAmF;AACnF,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC3C,+EAA+E;AAC/E,OAAO,EAAE,wBAAwB,EAAE,MAAM,iCAAiC,CAAC;AAC3E,yCAAyC;AACzC,OAAO,EAAE,mBAAmB,EAAE,KAAK,EAAE,wBAAwB,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAC1H,wEAAwE;AACxE,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,YAAY,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AAC/H,wDAAwD;AACxD,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC7D,YAAY,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC"}

package/dist/index.js

@@ -0,0 +1,100 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isValidDirection = exports.isValidRunKind = exports.validateSourceFormat = exports.validateMetricRole = exports.validateDirection = exports.validateRunKind = exports.validateRequiredDatapointAttributes = exports.validateRequiredResourceAttributes = exports.DEFAULT_DATA_BRANCH = exports.MONITOR_METRIC_PREFIX = exports.VALID_SOURCE_FORMATS = exports.VALID_METRIC_ROLES = exports.VALID_DIRECTIONS = exports.VALID_RUN_KINDS = exports.RESERVED_DATAPOINT_ATTRIBUTES = exports.REQUIRED_RESOURCE_ATTRIBUTES = exports.ATTR_VARIANT = exports.ATTR_PIPELINE = exports.ATTR_PROCESS = exports.ATTR_BATCH_SIZE = exports.ATTR_TRANSPORT = exports.ATTR_DATASET = exports.ATTR_IMPL = exports.ATTR_METRIC_ROLE = exports.ATTR_METRIC_DIRECTION = exports.ATTR_SERIES = exports.ATTR_SCENARIO = exports.ATTR_SERVICE_VERSION = exports.ATTR_SERVICE_NAME = exports.ATTR_RUNNER = exports.ATTR_RUN_ATTEMPT = exports.ATTR_JOB = exports.ATTR_WORKFLOW = exports.ATTR_COMMIT = exports.ATTR_REF = exports.ATTR_SOURCE_FORMAT = exports.ATTR_KIND = exports.ATTR_RUN_ID = exports.getOtlpTemporality = exports.getOtlpMetricKind = exports.otlpAttributesToRecord = exports.parseOtlp = exports.parsePytestBenchmark = exports.parseHyperfine = exports.parseBenchmarkAction = exports.parseRustBench = exports.parseGoBench = exports.unitToMetricName = exports.inferDirection = exports.parseBenchmarks = void 0;
+exports.seriesKey = exports.MetricsBatch = exports.buildOtlpResult = exports.RETRY_DELAY_MAX_MS = exports.RETRY_DELAY_MIN_MS = exports.DEFAULT_PUSH_RETRY_COUNT = exports.sleep = exports.computeRetryDelayMs = exports.formatComparisonMarkdown = exports.compareRuns = exports.isMonitorMetric = exports.isValidSourceFormat = exports.isValidMetricRole = void 0;
+/** Parse benchmark output in any supported format (auto-detect, go, native, benchmark-action). */
+var parse_js_1 = require("./parse.js");
+Object.defineProperty(exports, "parseBenchmarks", { enumerable: true, get: function () { return parse_js_1.parseBenchmarks; } });
+/** Infer the `direction` ("smaller_is_better" / "bigger_is_better") from a metric unit string. */
+var infer_direction_js_1 = require("./infer-direction.js");
+Object.defineProperty(exports, "inferDirection", { enumerable: true, get: function () { return infer_direction_js_1.inferDirection; } });
+/** Convert a benchmark unit string to a normalized metric name (e.g. "ns/op" -> "ns_per_op"). */
+var parser_utils_js_1 = require("./parser-utils.js");
+Object.defineProperty(exports, "unitToMetricName", { enumerable: true, get: function () { return parser_utils_js_1.unitToMetricName; } });
+/** Parse Go testing/benchmark output text. */
+var parse_go_js_1 = require("./parse-go.js");
+Object.defineProperty(exports, "parseGoBench", { enumerable: true, get: function () { return parse_go_js_1.parseGoBench; } });
+/** Parse Rust cargo bench (libtest) output text. */
+var parse_rust_js_1 = require("./parse-rust.js");
+Object.defineProperty(exports, "parseRustBench", { enumerable: true, get: function () { return parse_rust_js_1.parseRustBench; } });
+/** Parse benchmark-action/github-action-benchmark JSON format. */
+var parse_benchmark_action_js_1 = require("./parse-benchmark-action.js");
+Object.defineProperty(exports, "parseBenchmarkAction", { enumerable: true, get: function () { return parse_benchmark_action_js_1.parseBenchmarkAction; } });
+/** Parse Hyperfine JSON format. */
+var parse_hyperfine_js_1 = require("./parse-hyperfine.js");
+Object.defineProperty(exports, "parseHyperfine", { enumerable: true, get: function () { return parse_hyperfine_js_1.parseHyperfine; } });
+/** Parse pytest-benchmark JSON format. */
+var parse_pytest_benchmark_js_1 = require("./parse-pytest-benchmark.js");
+Object.defineProperty(exports, "parsePytestBenchmark", { enumerable: true, get: function () { return parse_pytest_benchmark_js_1.parsePytestBenchmark; } });
+/** Parse OTLP metrics JSON. */
+var parse_otlp_js_1 = require("./parse-otlp.js");
+Object.defineProperty(exports, "parseOtlp", { enumerable: true, get: function () { return parse_otlp_js_1.parseOtlp; } });
+Object.defineProperty(exports, "otlpAttributesToRecord", { enumerable: true, get: function () { return parse_otlp_js_1.otlpAttributesToRecord; } });
+Object.defineProperty(exports, "getOtlpMetricKind", { enumerable: true, get: function () { return parse_otlp_js_1.getOtlpMetricKind; } });
+Object.defineProperty(exports, "getOtlpTemporality", { enumerable: true, get: function () { return parse_otlp_js_1.getOtlpTemporality; } });
+/** OTLP semantic convention constants — attribute names, valid values, reserved keys. */
+var otlp_conventions_js_1 = require("./otlp-conventions.js");
+Object.defineProperty(exports, "ATTR_RUN_ID", { enumerable: true, get: function () { return otlp_conventions_js_1.ATTR_RUN_ID; } });
+Object.defineProperty(exports, "ATTR_KIND", { enumerable: true, get: function () { return otlp_conventions_js_1.ATTR_KIND; } });
+Object.defineProperty(exports, "ATTR_SOURCE_FORMAT", { enumerable: true, get: function () { return otlp_conventions_js_1.ATTR_SOURCE_FORMAT; } });
+Object.defineProperty(exports, "ATTR_REF", { enumerable: true, get: function () { return otlp_conventions_js_1.ATTR_REF; } });
+Object.defineProperty(exports, "ATTR_COMMIT", { enumerable: true, get: function () { return otlp_conventions_js_1.ATTR_COMMIT; } });
+Object.defineProperty(exports, "ATTR_WORKFLOW", { enumerable: true, get: function () { return otlp_conventions_js_1.ATTR_WORKFLOW; } });
+Object.defineProperty(exports, "ATTR_JOB", { enumerable: true, get: function () { return otlp_conventions_js_1.ATTR_JOB; } });
+Object.defineProperty(exports, "ATTR_RUN_ATTEMPT", { enumerable: true, get: function () { return otlp_conventions_js_1.ATTR_RUN_ATTEMPT; } });
+Object.defineProperty(exports, "ATTR_RUNNER", { enumerable: true, get: function () { return otlp_conventions_js_1.ATTR_RUNNER; } });
+Object.defineProperty(exports, "ATTR_SERVICE_NAME", { enumerable: true, get: function () { return otlp_conventions_js_1.ATTR_SERVICE_NAME; } });
+Object.defineProperty(exports, "ATTR_SERVICE_VERSION", { enumerable: true, get: function () { return otlp_conventions_js_1.ATTR_SERVICE_VERSION; } });
+Object.defineProperty(exports, "ATTR_SCENARIO", { enumerable: true, get: function () { return otlp_conventions_js_1.ATTR_SCENARIO; } });
+Object.defineProperty(exports, "ATTR_SERIES", { enumerable: true, get: function () { return otlp_conventions_js_1.ATTR_SERIES; } });
+Object.defineProperty(exports, "ATTR_METRIC_DIRECTION", { enumerable: true, get: function () { return otlp_conventions_js_1.ATTR_METRIC_DIRECTION; } });
+Object.defineProperty(exports, "ATTR_METRIC_ROLE", { enumerable: true, get: function () { return otlp_conventions_js_1.ATTR_METRIC_ROLE; } });
+Object.defineProperty(exports, "ATTR_IMPL", { enumerable: true, get: function () { return otlp_conventions_js_1.ATTR_IMPL; } });
+Object.defineProperty(exports, "ATTR_DATASET", { enumerable: true, get: function () { return otlp_conventions_js_1.ATTR_DATASET; } });
+Object.defineProperty(exports, "ATTR_TRANSPORT", { enumerable: true, get: function () { return otlp_conventions_js_1.ATTR_TRANSPORT; } });
+Object.defineProperty(exports, "ATTR_BATCH_SIZE", { enumerable: true, get: function () { return otlp_conventions_js_1.ATTR_BATCH_SIZE; } });
+Object.defineProperty(exports, "ATTR_PROCESS", { enumerable: true, get: function () { return otlp_conventions_js_1.ATTR_PROCESS; } });
+Object.defineProperty(exports, "ATTR_PIPELINE", { enumerable: true, get: function () { return otlp_conventions_js_1.ATTR_PIPELINE; } });
+Object.defineProperty(exports, "ATTR_VARIANT", { enumerable: true, get: function () { return otlp_conventions_js_1.ATTR_VARIANT; } });
+Object.defineProperty(exports, "REQUIRED_RESOURCE_ATTRIBUTES", { enumerable: true, get: function () { return otlp_conventions_js_1.REQUIRED_RESOURCE_ATTRIBUTES; } });
+Object.defineProperty(exports, "RESERVED_DATAPOINT_ATTRIBUTES", { enumerable: true, get: function () { return otlp_conventions_js_1.RESERVED_DATAPOINT_ATTRIBUTES; } });
+Object.defineProperty(exports, "VALID_RUN_KINDS", { enumerable: true, get: function () { return otlp_conventions_js_1.VALID_RUN_KINDS; } });
+Object.defineProperty(exports, "VALID_DIRECTIONS", { enumerable: true, get: function () { return otlp_conventions_js_1.VALID_DIRECTIONS; } });
+Object.defineProperty(exports, "VALID_METRIC_ROLES", { enumerable: true, get: function () { return otlp_conventions_js_1.VALID_METRIC_ROLES; } });
+Object.defineProperty(exports, "VALID_SOURCE_FORMATS", { enumerable: true, get: function () { return otlp_conventions_js_1.VALID_SOURCE_FORMATS; } });
+Object.defineProperty(exports, "MONITOR_METRIC_PREFIX", { enumerable: true, get: function () { return otlp_conventions_js_1.MONITOR_METRIC_PREFIX; } });
+Object.defineProperty(exports, "DEFAULT_DATA_BRANCH", { enumerable: true, get: function () { return otlp_conventions_js_1.DEFAULT_DATA_BRANCH; } });
+/** Runtime validators for the benchkit OTLP semantic contract. */
+var otlp_validation_js_1 = require("./otlp-validation.js");
+Object.defineProperty(exports, "validateRequiredResourceAttributes", { enumerable: true, get: function () { return otlp_validation_js_1.validateRequiredResourceAttributes; } });
+Object.defineProperty(exports, "validateRequiredDatapointAttributes", { enumerable: true, get: function () { return otlp_validation_js_1.validateRequiredDatapointAttributes; } });
+Object.defineProperty(exports, "validateRunKind", { enumerable: true, get: function () { return otlp_validation_js_1.validateRunKind; } });
+Object.defineProperty(exports, "validateDirection", { enumerable: true, get: function () { return otlp_validation_js_1.validateDirection; } });
+Object.defineProperty(exports, "validateMetricRole", { enumerable: true, get: function () { return otlp_validation_js_1.validateMetricRole; } });
+Object.defineProperty(exports, "validateSourceFormat", { enumerable: true, get: function () { return otlp_validation_js_1.validateSourceFormat; } });
+Object.defineProperty(exports, "isValidRunKind", { enumerable: true, get: function () { return otlp_validation_js_1.isValidRunKind; } });
+Object.defineProperty(exports, "isValidDirection", { enumerable: true, get: function () { return otlp_validation_js_1.isValidDirection; } });
+Object.defineProperty(exports, "isValidMetricRole", { enumerable: true, get: function () { return otlp_validation_js_1.isValidMetricRole; } });
+Object.defineProperty(exports, "isValidSourceFormat", { enumerable: true, get: function () { return otlp_validation_js_1.isValidSourceFormat; } });
+Object.defineProperty(exports, "isMonitorMetric", { enumerable: true, get: function () { return otlp_validation_js_1.isMonitorMetric; } });
+/** Compare a current benchmark run against baseline runs to detect regressions. */
+var compare_js_1 = require("./compare.js");
+Object.defineProperty(exports, "compareRuns", { enumerable: true, get: function () { return compare_js_1.compareRuns; } });
+/** Format a ComparisonResult as markdown for job summaries and PR comments. */
+var format_comparison_markdown_js_1 = require("./format-comparison-markdown.js");
+Object.defineProperty(exports, "formatComparisonMarkdown", { enumerable: true, get: function () { return format_comparison_markdown_js_1.formatComparisonMarkdown; } });
+/** Retry helpers for push operations. */
+var retry_js_1 = require("./retry.js");
+Object.defineProperty(exports, "computeRetryDelayMs", { enumerable: true, get: function () { return retry_js_1.computeRetryDelayMs; } });
+Object.defineProperty(exports, "sleep", { enumerable: true, get: function () { return retry_js_1.sleep; } });
+Object.defineProperty(exports, "DEFAULT_PUSH_RETRY_COUNT", { enumerable: true, get: function () { return retry_js_1.DEFAULT_PUSH_RETRY_COUNT; } });
+Object.defineProperty(exports, "RETRY_DELAY_MIN_MS", { enumerable: true, get: function () { return retry_js_1.RETRY_DELAY_MIN_MS; } });
+Object.defineProperty(exports, "RETRY_DELAY_MAX_MS", { enumerable: true, get: function () { return retry_js_1.RETRY_DELAY_MAX_MS; } });
+/** Build an OtlpMetricsDocument from a simple benchmark input shape. */
+var build_otlp_result_js_1 = require("./build-otlp-result.js");
+Object.defineProperty(exports, "buildOtlpResult", { enumerable: true, get: function () { return build_otlp_result_js_1.buildOtlpResult; } });
+/** Ergonomic batch wrapper over OtlpMetricsDocument. */
+var metrics_batch_js_1 = require("./metrics-batch.js");
+Object.defineProperty(exports, "MetricsBatch", { enumerable: true, get: function () { return metrics_batch_js_1.MetricsBatch; } });
+Object.defineProperty(exports, "seriesKey", { enumerable: true, get: function () { return metrics_batch_js_1.seriesKey; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AAoCA,kGAAkG;AAClG,uCAA6C;AAApC,2GAAA,eAAe,OAAA;AAExB,kGAAkG;AAClG,2DAAsD;AAA7C,oHAAA,cAAc,OAAA;AACvB,iGAAiG;AACjG,qDAAqD;AAA5C,mHAAA,gBAAgB,OAAA;AACzB,8CAA8C;AAC9C,6CAA6C;AAApC,2GAAA,YAAY,OAAA;AACrB,oDAAoD;AACpD,iDAAiD;AAAxC,+GAAA,cAAc,OAAA;AACvB,kEAAkE;AAClE,yEAAmE;AAA1D,iIAAA,oBAAoB,OAAA;AAC7B,mCAAmC;AACnC,2DAAsD;AAA7C,oHAAA,cAAc,OAAA;AACvB,0CAA0C;AAC1C,yEAAmE;AAA1D,iIAAA,oBAAoB,OAAA;AAC7B,+BAA+B;AAC/B,iDAKyB;AAJvB,0GAAA,SAAS,OAAA;AACT,uHAAA,sBAAsB,OAAA;AACtB,kHAAA,iBAAiB,OAAA;AACjB,mHAAA,kBAAkB,OAAA;AAEpB,yFAAyF;AACzF,6DA+B+B;AA9B7B,kHAAA,WAAW,OAAA;AACX,gHAAA,SAAS,OAAA;AACT,yHAAA,kBAAkB,OAAA;AAClB,+GAAA,QAAQ,OAAA;AACR,kHAAA,WAAW,OAAA;AACX,oHAAA,aAAa,OAAA;AACb,+GAAA,QAAQ,OAAA;AACR,uHAAA,gBAAgB,OAAA;AAChB,kHAAA,WAAW,OAAA;AACX,wHAAA,iBAAiB,OAAA;AACjB,2HAAA,oBAAoB,OAAA;AACpB,oHAAA,aAAa,OAAA;AACb,kHAAA,WAAW,OAAA;AACX,4HAAA,qBAAqB,OAAA;AACrB,uHAAA,gBAAgB,OAAA;AAChB,gHAAA,SAAS,OAAA;AACT,mHAAA,YAAY,OAAA;AACZ,qHAAA,cAAc,OAAA;AACd,sHAAA,eAAe,OAAA;AACf,mHAAA,YAAY,OAAA;AACZ,oHAAA,aAAa,OAAA;AACb,mHAAA,YAAY,OAAA;AACZ,mIAAA,4BAA4B,OAAA;AAC5B,oIAAA,6BAA6B,OAAA;AAC7B,sHAAA,eAAe,OAAA;AACf,uHAAA,gBAAgB,OAAA;AAChB,yHAAA,kBAAkB,OAAA;AAClB,2HAAA,oBAAoB,OAAA;AACpB,4HAAA,qBAAqB,OAAA;AACrB,0HAAA,mBAAmB,OAAA;AAGrB,kEAAkE;AAClE,2DAY8B;AAX5B,wIAAA,kCAAkC,OAAA;AAClC,yIAAA,mCAAmC,OAAA;AACnC,qHAAA,eAAe,OAAA;AACf,uHAAA,iBAAiB,OAAA;AACjB,wHAAA,kBAAkB,OAAA;AAClB,0HAAA,oBAAoB,OAAA;AACpB,oHAAA,cAAc,OAAA;AACd,sHAAA,gBAAgB,OAAA;AAChB,uHAAA,iBAAiB,OAAA;AACjB,yHAAA,mBAAmB,OAAA;AACnB,qHAAA,eAAe,OAAA;AAEjB,mFAAmF;AACnF,2CAA2C;AAAlC,yGAAA,WAAW,OAAA;AACpB,+EAA+E;AAC/E,iFAA2E;AAAlE,yIAAA,wBAAwB,OAAA;AACjC,yCAAyC;AACzC,uCAA0H;AAAjH,+GAAA,mBAAmB,OAAA;AAAE,iGAAA,KAAK,OAAA;AAAE,oHAAA,wBAAwB,OAAA;AAAE,8GAAA,kBAAkB,OAAA;AAAE,8GAAA,kBAAkB,OAAA;AACrG,wEAAwE;AACxE,+DAAyD;AAAhD,uHAAA,eAAe,OAAA;AAExB,wDAAwD;AACxD,uDAA6D;AAApD,gHAAA,YAAY,OAAA;AAAE,6GAAA,SAAS,OAAA"}

package/dist/infer-direction.d.ts

@@ -0,0 +1,10 @@
+import type { Direction } from "./otlp-conventions.js";
+/**
+ * Infer whether a unit is "bigger_is_better" or "smaller_is_better".
+ *
+ * Common patterns:
+ *  - ops/s, MB/s, throughput, events → bigger is better
+ *  - ns/op, B/op, allocs/op, ms, bytes → smaller is better (default)
+ */
+export declare function inferDirection(unit: string): NonNullable<Direction>;
+//# sourceMappingURL=infer-direction.d.ts.map

package/dist/infer-direction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"infer-direction.d.ts","sourceRoot":"","sources":["../src/infer-direction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAEvD;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,CAAC,SAAS,CAAC,CAenE"}

package/dist/infer-direction.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.inferDirection = inferDirection;
+/**
+ * Infer whether a unit is "bigger_is_better" or "smaller_is_better".
+ *
+ * Common patterns:
+ *  - ops/s, MB/s, throughput, events → bigger is better
+ *  - ns/op, B/op, allocs/op, ms, bytes → smaller is better (default)
+ */
+function inferDirection(unit) {
+    const lower = unit.toLowerCase();
+    if (lower.includes("ops/s") ||
+        lower.includes("op/s") ||
+        lower.includes("/sec") ||
+        lower.includes("mb/s") ||
+        lower.includes("throughput") ||
+        lower.includes("events")) {
+        return "bigger_is_better";
+    }
+    return "smaller_is_better";
+}
+//# sourceMappingURL=infer-direction.js.map

package/dist/infer-direction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"infer-direction.js","sourceRoot":"","sources":["../src/infer-direction.ts"],"names":[],"mappings":";;AASA,wCAeC;AAtBD;;;;;;GAMG;AACH,SAAgB,cAAc,CAAC,IAAY;IACzC,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;IAEjC,IACE,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC;QACvB,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC;QACtB,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC;QACtB,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC;QACtB,KAAK,CAAC,QAAQ,CAAC,YAAY,CAAC;QAC5B,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,EACxB,CAAC;QACD,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IAED,OAAO,mBAAmB,CAAC;AAC7B,CAAC"}

package/dist/infer-direction.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=infer-direction.test.d.ts.map

package/dist/infer-direction.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"infer-direction.test.d.ts","sourceRoot":"","sources":["../src/infer-direction.test.ts"],"names":[],"mappings":""}

package/dist/infer-direction.test.js

@@ -0,0 +1,28 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_test_1 = require("node:test");
+const strict_1 = __importDefault(require("node:assert/strict"));
+const infer_direction_js_1 = require("./infer-direction.js");
+(0, node_test_1.describe)("inferDirection", () => {
+    (0, node_test_1.it)("returns bigger_is_better for throughput units", () => {
+        for (const unit of ["ops/s", "op/s", "req/sec", "MB/s", "throughput", "events"]) {
+            strict_1.default.equal((0, infer_direction_js_1.inferDirection)(unit), "bigger_is_better", `expected bigger_is_better for "${unit}"`);
+        }
+    });
+    (0, node_test_1.it)("returns smaller_is_better for latency and allocation units", () => {
+        for (const unit of ["ns/op", "ms/op", "us/op", "s/op", "B/op", "allocs/op", "bytes", "ms"]) {
+            strict_1.default.equal((0, infer_direction_js_1.inferDirection)(unit), "smaller_is_better", `expected smaller_is_better for "${unit}"`);
+        }
+    });
+    (0, node_test_1.it)("defaults to smaller_is_better for unknown units", () => {
+        strict_1.default.equal((0, infer_direction_js_1.inferDirection)("widgets"), "smaller_is_better");
+    });
+    (0, node_test_1.it)("is case-insensitive", () => {
+        strict_1.default.equal((0, infer_direction_js_1.inferDirection)("OPS/S"), "bigger_is_better");
+        strict_1.default.equal((0, infer_direction_js_1.inferDirection)("Mb/S"), "bigger_is_better");
+    });
+});
+//# sourceMappingURL=infer-direction.test.js.map

package/dist/infer-direction.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"infer-direction.test.js","sourceRoot":"","sources":["../src/infer-direction.test.ts"],"names":[],"mappings":";;;;;AAAA,yCAAyC;AACzC,gEAAwC;AACxC,6DAAsD;AAEtD,IAAA,oBAAQ,EAAC,gBAAgB,EAAE,GAAG,EAAE;IAC9B,IAAA,cAAE,EAAC,+CAA+C,EAAE,GAAG,EAAE;QACvD,KAAK,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,QAAQ,CAAC,EAAE,CAAC;YAChF,gBAAM,CAAC,KAAK,CAAC,IAAA,mCAAc,EAAC,IAAI,CAAC,EAAE,kBAAkB,EAAE,kCAAkC,IAAI,GAAG,CAAC,CAAC;QACpG,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,IAAA,cAAE,EAAC,4DAA4D,EAAE,GAAG,EAAE;QACpE,KAAK,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC;YAC3F,gBAAM,CAAC,KAAK,CAAC,IAAA,mCAAc,EAAC,IAAI,CAAC,EAAE,mBAAmB,EAAE,mCAAmC,IAAI,GAAG,CAAC,CAAC;QACtG,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,IAAA,cAAE,EAAC,iDAAiD,EAAE,GAAG,EAAE;QACzD,gBAAM,CAAC,KAAK,CAAC,IAAA,mCAAc,EAAC,SAAS,CAAC,EAAE,mBAAmB,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;IAEH,IAAA,cAAE,EAAC,qBAAqB,EAAE,GAAG,EAAE;QAC7B,gBAAM,CAAC,KAAK,CAAC,IAAA,mCAAc,EAAC,OAAO,CAAC,EAAE,kBAAkB,CAAC,CAAC;QAC1D,gBAAM,CAAC,KAAK,CAAC,IAAA,mCAAc,EAAC,MAAM,CAAC,EAAE,kBAAkB,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}