benchforge 0.1.11 → 0.2.4

package/src/table-util/README.md

@@ -1,70 +0,0 @@
-# TableReport 
-
-Utilities for creating formatted text-based tables.
-Under the hood, TableReport uses the npm [table](https://www.npmjs.com/package/table) library.
-
-### Features
-
-*   **Column Grouping:** Group related columns under a common header.
-*   **Difference Columns:** Automatically generate columns that show the percentage difference between a value and a baseline value.
-*   **Custom Formatting:** Declaratively provide custom formatters for columns.
-*   **Simplified Configuration:** A higher-level API for the `table` library.
-
-## `TableReport.ts`
-
-The `buildTable` function in `TableReport.ts` is the main entry point for creating a table. 
-It takes a configuration object for columns and an array of data records for rows.
-
-### Example
-
-Here's a simplified example of how to use `buildTable`:
-
-```typescript
-import { buildTable, ColumnGroup } from './TableReport';
-import { integer, floatPrecision } from './Formatters';
-
-interface MyData {
-  name: string;
-  value: number;
-  score: number;
-}
-
-const data: MyData[] = [
-  { name: 'test A', value: 123, score: 45.6 },
-  { name: 'test B', value: 456, score: 78.9 },
-];
-
-const baselineData: MyData[] = [
-  { name: 'test A', value: 100, score: 50.0 },
-  { name: 'test B', value: 500, score: 75.0 },
-];
-
-const tableConfig: ColumnGroup<MyData>[] = [
-  {
-    columns: [{ key: 'name', title: 'Name' }],
-  },
-  {
-    groupTitle: 'Metrics',
-    columns: [
-      { key: 'value', title: 'Value', formatter: integer },
-      { key: 'value_diff', title: 'Δ%', diffKey: 'value' },
-      { key: 'score', title: 'Score', formatter: floatPrecision(1) },
-      { key: 'score_diff', title: 'Δ%', diffKey: 'score' },
-    ],
-  },
-];
-
-const table = buildTable(tableConfig, data, baselineData);
-console.log(table);
-```
-
-For a more complex example, see `BenchmarkReport.ts`, specifically the `mostlyFullRow` and `tableConfig` variables.
-
-## `Formatters.ts`
-
-This file contains various utility functions for formatting numbers and strings, such as:
-
-*   `float`, `integer`: Format numbers to a specific precision.
-*   `percent`: Format a number as a percentage.
-*   `diffPercent`, `diffPercentNegative`: Format the percentage difference between two numbers, with color-coding for positive/negative changes.
-*   `bytes`, `duration`, `rate`: Format numbers with appropriate units.

package/src/table-util/TableReport.ts

@@ -1,293 +0,0 @@
-import pico from "picocolors";
-import type { Alignment, SpanningCellConfig, TableUserConfig } from "table";
-import { table } from "table";
-import { diffPercent } from "./Formatters.ts";
-
-/** Related table columns */
-export interface ColumnGroup<T> {
-  groupTitle?: string;
-  columns: AnyColumn<T>[];
-}
-
-export type AnyColumn<T> = Column<T> | DiffColumn<T>;
-
-/** Column with optional formatter */
-export interface Column<T> extends ColumnFormat<T> {
-  formatter?: (value: unknown) => string | null;
-  diffKey?: undefined;
-}
-
-/** Table headers and configuration */
-export interface TableSetup {
-  headerRows: string[][];
-  config: TableUserConfig;
-}
-
-/** Data rows with optional baseline */
-export interface ResultGroup<T extends Record<string, any>> {
-  results: T[];
-
-  baseline?: T;
-}
-
-/** Comparison column against baseline */
-interface DiffColumn<T> extends ColumnFormat<T> {
-  diffFormatter?: (value: unknown, baseline: unknown) => string | null;
-  formatter?: undefined;
-
-  /** Key for comparison value against baseline */
-  diffKey: keyof T;
-}
-
-interface ColumnFormat<T> {
-  key: keyof T;
-  title: string;
-
-  alignment?: Alignment;
-
-  width?: number;
-}
-
-interface Lines {
-  drawHorizontalLine: (index: number, size: number) => boolean;
-  drawVerticalLine: (index: number, size: number) => boolean;
-}
-
-const isTest = process.env.NODE_ENV === "test" || process.env.VITEST === "true";
-const { bold } = isTest ? { bold: (str: string) => str } : pico;
-
-// Regex to strip ANSI escape codes (ESC [ ... m sequences)
-const ansiEscapeRegex = new RegExp(
-  String.fromCharCode(27) + "\\[[0-9;]*m",
-  "g",
-);
-
-/** Build formatted table with column groups and baselines */
-export function buildTable<T extends Record<string, any>>(
-  columnGroups: ColumnGroup<T>[],
-  resultGroups: ResultGroup<T>[],
-  nameKey: keyof T = "name" as keyof T,
-): string {
-  const allRecords = flattenGroups(columnGroups, resultGroups, nameKey);
-  return createTable(columnGroups, allRecords);
-}
-
-/** Convert records to string arrays for table */
-export function toRows<T extends Record<string, any>>(
-  records: T[],
-  groups: ColumnGroup<T>[],
-): string[][] {
-  const allColumns = groups.flatMap(group => group.columns);
-
-  const rawRows = records.map(record =>
-    allColumns.map(col => {
-      const value = record[col.key];
-      return col.formatter ? col.formatter(value) : value;
-    }),
-  );
-
-  return rawRows.map(row => row.map(cell => cell ?? " "));
-}
-
-/** Flatten groups with spacing */
-function flattenGroups<T extends Record<string, any>>(
-  columnGroups: ColumnGroup<T>[],
-  resultGroups: ResultGroup<T>[],
-  nameKey: keyof T,
-): T[] {
-  return resultGroups.flatMap((group, i) => {
-    const groupRecords = addBaseline(columnGroups, group, nameKey);
-
-    const isLast = i === resultGroups.length - 1;
-    return isLast ? groupRecords : [...groupRecords, {} as T];
-  });
-}
-
-/** Convert columns and records to formatted table */
-function createTable<T extends Record<string, any>>(
-  groups: ColumnGroup<T>[],
-  records: T[],
-): string {
-  const dataRows = toRows(records, groups);
-  const { headerRows, config } = setup(groups, dataRows);
-  const allRows = [...headerRows, ...dataRows];
-  return table(allRows, config);
-}
-
-/** Process results with baseline comparisons */
-function addBaseline<T extends Record<string, any>>(
-  columnGroups: ColumnGroup<T>[],
-  group: ResultGroup<T>,
-  nameKey: keyof T,
-): T[] {
-  const { results, baseline } = group;
-
-  if (!baseline) return results;
-
-  const diffResults = results.map(result =>
-    addComparisons(columnGroups, result, baseline),
-  );
-
-  const markedBaseline = {
-    ...baseline,
-    [nameKey]: `--> ${baseline[nameKey]}`,
-  };
-
-  return [...diffResults, markedBaseline];
-}
-
-/** Create headers and table configuration */
-function setup<T>(groups: ColumnGroup<T>[], dataRows: string[][]): TableSetup {
-  const titles = getTitles(groups);
-  const numColumns = titles.length;
-
-  const sectionRows = createGroupHeaders(groups, numColumns);
-  const headerRows = [...sectionRows, titles];
-  const spanningCells = createSectionSpans(groups);
-  const columnWidths = calcColumnWidths(groups, titles, dataRows);
-  const config: TableUserConfig = {
-    spanningCells,
-    columns: columnWidths,
-    ...createLines(groups),
-  };
-
-  return { headerRows, config };
-}
-
-/** Add comparison values for diff columns */
-function addComparisons<T extends Record<string, any>>(
-  groups: ColumnGroup<T>[],
-  mainRecord: T,
-  baselineRecord: T,
-): T {
-  const diffColumns = groups.flatMap(g => g.columns).filter(col => col.diffKey);
-  const updatedMain = { ...mainRecord };
-
-  for (const col of diffColumns) {
-    const dcol = col as DiffColumn<T>;
-    const diffKey = dcol.diffKey;
-    const mainValue = mainRecord[diffKey];
-    const baselineValue = baselineRecord[diffKey];
-    const diffFormat = dcol.diffFormatter ?? diffPercent;
-    const diffStr = diffFormat(mainValue, baselineValue);
-    (updatedMain as any)[col.key] = diffStr;
-  }
-
-  return updatedMain;
-}
-
-/** @return bolded column title strings */
-function getTitles<T>(groups: ColumnGroup<T>[]): string[] {
-  return groups.flatMap(g => g.columns.map(c => bold(c.title || " ")));
-}
-
-/** Create header rows with group titles */
-function createGroupHeaders<T>(
-  groups: ColumnGroup<T>[],
-  numColumns: number,
-): string[][] {
-  if (!groups.some(g => g.groupTitle)) return [];
-
-  const sectionRow = groups.flatMap(g => {
-    const title = g.groupTitle ? [bold(g.groupTitle)] : [];
-    return padWithBlanks(title, g.columns.length);
-  });
-  const blankRow = padWithBlanks([], numColumns);
-  return [sectionRow, blankRow];
-}
-
-/** @return spanning cell configs for group title headers */
-function createSectionSpans<T>(groups: ColumnGroup<T>[]): SpanningCellConfig[] {
-  let col = 0;
-  const alignment: Alignment = "center";
-  return groups.map(g => {
-    const colSpan = g.columns.length;
-    const span = { row: 0, col, colSpan, alignment };
-    col += colSpan;
-    return span;
-  });
-}
-
-/** Calculate column widths based on content, including group titles */
-function calcColumnWidths<T>(
-  groups: ColumnGroup<T>[],
-  titles: string[],
-  dataRows: unknown[][],
-): Record<number, { width: number; wrapWord: boolean }> {
-  // First pass: calculate base widths from titles and data
-  const widths: number[] = [];
-  for (let i = 0; i < titles.length; i++) {
-    const titleW = cellWidth(titles[i]);
-    const maxDataW = dataRows.reduce(
-      (max, row) => Math.max(max, cellWidth(row[i])),
-      0,
-    );
-    widths.push(Math.max(titleW, maxDataW));
-  }
-
-  // Second pass: ensure group titles fit (accounting for column separators)
-  let colIndex = 0;
-  for (const group of groups) {
-    const groupW = cellWidth(group.groupTitle);
-    if (groupW > 0) {
-      const numCols = group.columns.length;
-      const separatorWidth = (numCols - 1) * 3; // " | " between columns
-      const currentWidth = widths
-        .slice(colIndex, colIndex + numCols)
-        .reduce((a, b) => a + b, 0);
-      const needed = groupW - currentWidth - separatorWidth;
-      if (needed > 0) {
-        // Distribute extra width to last column in group
-        widths[colIndex + numCols - 1] += needed;
-      }
-    }
-    colIndex += group.columns.length;
-  }
-
-  // Convert to table config format
-  return Object.fromEntries(
-    widths.map((w, i) => [i, { width: w, wrapWord: false }]),
-  );
-}
-
-/** @return draw functions for horizontal/vertical table borders */
-function createLines<T>(groups: ColumnGroup<T>[]): Lines {
-  const { sectionBorders, headerBottom } = calcBorders(groups);
-
-  function drawVerticalLine(index: number, size: number): boolean {
-    return index === 0 || index === size || sectionBorders.includes(index);
-  }
-  function drawHorizontalLine(index: number, size: number): boolean {
-    return index === 0 || index === size || index === headerBottom;
-  }
-  return { drawHorizontalLine, drawVerticalLine };
-}
-
-/** @return array padded with blank strings to the given length */
-function padWithBlanks(arr: string[], length: number): string[] {
-  if (arr.length >= length) return arr;
-  return [...arr, ...Array(length - arr.length).fill(" ")];
-}
-
-/** Get visible length of a cell value (strips ANSI escape codes) */
-function cellWidth(value: unknown): number {
-  if (value == null) return 0;
-  const str = String(value);
-  return str.replace(ansiEscapeRegex, "").length;
-}
-
-/** Calculate vertical lines between sections and header bottom position */
-function calcBorders<T>(groups: ColumnGroup<T>[]): {
-  sectionBorders: number[];
-  headerBottom: number;
-} {
-  if (groups.length === 0) return { sectionBorders: [], headerBottom: 1 };
-
-  const sectionBorders: number[] = [];
-  let border = 0;
-  for (const g of groups) {
-    border += g.columns.length;
-    sectionBorders.push(border);
-  }
-  return { sectionBorders, headerBottom: 3 };
-}

package/src/tests/fixtures/cases/asyncCases.ts

@@ -1,7 +0,0 @@
-/** Test cases module with async loadCase */
-export const cases = ["alpha", "beta"];
-
-export async function loadCase(id: string) {
-  await Promise.resolve(); // simulate async
-  return { data: id.toUpperCase(), metadata: { original: id } };
-}

package/src/tests/fixtures/cases/variants/product.ts

@@ -1,2 +0,0 @@
-/** Variant that multiplies array elements */
-export const run = (arr: number[]) => arr.reduce((a, b) => a * b, 1);

package/src/tests/fixtures/cases/variants/sum.ts

@@ -1,2 +0,0 @@
-/** Variant that sums array elements */
-export const run = (arr: number[]) => arr.reduce((a, b) => a + b, 0);

package/src/tests/fixtures/discover/fast.ts

@@ -1 +0,0 @@
-export const run = () => {};

package/src/tests/fixtures/invalid/bad.ts

@@ -1 +0,0 @@
-export const notRun = () => {};

package/src/tests/fixtures/loader/fast.ts

@@ -1 +0,0 @@
-export const run = () => {};

package/src/tests/fixtures/loader/stateful.ts

@@ -1,2 +0,0 @@
-export const setup = data => ({ value: data });
-export const run = state => state.value;

package/src/tests/fixtures/stateful/stateful.ts

@@ -1,2 +0,0 @@
-export const setup = data => ({ value: data });
-export const run = state => state.value;

package/src/tests/fixtures/variants/extra.ts

@@ -1 +0,0 @@
-export const run = () => {};

package/src/tests/fixtures/variants/impl.ts

@@ -1 +0,0 @@
-export const run = () => {};

package/src/tests/fixtures/worker/fast.ts

@@ -1 +0,0 @@
-export const run = () => {};