modestbench 0.6.0 → 0.7.0

package/src/cli/commands/test.ts

@@ -5,8 +5,7 @@
  * executing them through a lightweight benchmark runner.
  */
 
-import { hostname } from 'node:os';
-import { cpus, freemem, totalmem } from 'node:os';
+import { cpus, freemem, hostname, totalmem } from 'node:os';
 import { resolve } from 'node:path';
 import { performance } from 'node:perf_hooks';
 
@@ -31,7 +30,7 @@ import {
   type ConvertedBenchmarkSuite,
   type TestFramework,
 } from '../../adapters/types.js';
-import { ExitCodes } from '../../types/cli.js';
+import { ExitCodes } from '../../constants.js';
 import { createRunId } from '../../types/core.js';
 import { isError } from '../../utils/type-guards.js';
 

package/src/cli/index.ts

@@ -39,6 +39,7 @@ import {
   CsvReporter,
   HumanReporter,
   JsonReporter,
+  NyanReporter,
   SimpleReporter,
 } from '../reporters/index.js';
 // Import commands
@@ -1151,6 +1152,13 @@ const createCliContext = async (
       }),
     );
 
+    engine.registerReporter(
+      'nyan',
+      new NyanReporter({
+        color: !options.noColor,
+      }),
+    );
+
     return {
       abortController,
       configManager: engine.configManager,

package/src/constants.ts

@@ -1,4 +1,4 @@
-import { type Engine } from './types/cli.js';
+import { type Engine } from './types/core.js';
 
 /**
  * Supported benchmark file extensions
@@ -60,6 +60,7 @@ export const Reporters = {
   CSV: 'csv',
   HUMAN: 'human',
   JSON: 'json',
+  NYAN: 'nyan',
   SIMPLE: 'simple',
 } as const;
 

package/src/index.ts

@@ -8,6 +8,9 @@
 
 export { bootstrap as modestbench } from './bootstrap.js';
 
+// Constants
+export { ExitCodes } from './constants.js';
+
 // Core engine
 export { ModestBenchEngine } from './core/engine.js';
 export { AccurateEngine, TinybenchEngine } from './core/engines/index.js';

package/src/reporters/index.ts

@@ -7,4 +7,5 @@
 export { CsvReporter } from './csv.js';
 export { HumanReporter } from './human.js';
 export { JsonReporter } from './json.js';
+export { NyanReporter } from './nyan.js';
 export { SimpleReporter } from './simple.js';

package/src/reporters/nyan.ts

@@ -0,0 +1,409 @@
+/**
+ * ModestBench Nyan Cat Reporter
+ *
+ * Because benchmarking should be more colorful. Displays an animated nyan cat
+ * flying through a rainbow trail as benchmarks complete.
+ *
+ * Based on Mocha's legendary nyan reporter, adapted for the glory of
+ * performance measurement.
+ *
+ * @packageDocumentation
+ */
+
+import type {
+  BenchmarkRun,
+  FileResult,
+  SuiteResult,
+  TaskResult,
+} from '../types/index.js';
+
+import { BaseReporter } from '../services/reporter-registry.js';
+import { colors } from '../utils/ansi.js';
+
+/**
+ * Nyan Cat reporter - because your benchmarks deserve rainbow power
+ */
+export class NyanReporter extends BaseReporter {
+  /** Index into rainbow colors for cycling */
+  private colorIndex = 0;
+
+  /** Current file being processed */
+  private currentFile = '';
+
+  /** Current suite being processed */
+  private currentSuite = '';
+
+  /** Total failed tasks */
+  private failed = 0;
+
+  /** Collected failures for summary */
+  private failures: Array<{
+    error: string;
+    file: string;
+    suite: string;
+    task: string;
+  }> = [];
+
+  /** Number of lines the cat occupies */
+  private readonly numberOfLines = 4;
+
+  /** Total passed tasks */
+  private passed = 0;
+
+  /** Whether the display is active */
+  private progressActive = false;
+
+  /** Quiet mode - suppress output */
+  private readonly quiet: boolean;
+
+  /** Generated rainbow color palette */
+  private rainbowColors: number[] = [];
+
+  /** Width of scoreboard */
+  private readonly scoreboardWidth = 5;
+
+  /** Start time for duration calculation */
+  private startTime = 0;
+
+  /** Animation tick (alternates between frames) */
+  private tick = false;
+
+  /** Rainbow trail storage - one trajectory per cat line */
+  private trajectories: string[][] = [[], [], [], []];
+
+  /** Maximum width of the rainbow trail */
+  private trajectoryWidthMax = 0;
+
+  /** Whether to use colors */
+  private readonly useColor: boolean;
+
+  constructor(
+    options: {
+      color?: boolean;
+      quiet?: boolean;
+    } = {},
+  ) {
+    super('nyan', options);
+
+    this.quiet = options.quiet ?? false;
+
+    // Auto-detect color support if not explicitly set
+    this.useColor =
+      options.color ??
+      (process.stdout.isTTY &&
+        process.env.FORCE_COLOR !== '0' &&
+        process.env.NO_COLOR == null);
+
+    // Generate the rainbow colors on construction
+    this.rainbowColors = this.generateColors();
+
+    // Calculate trajectory width based on terminal width
+    // Leave room for scoreboard (5) + cat (11) + some padding
+    const termWidth = process.stdout.columns || 80;
+    const nyanCatWidth = 11;
+    this.trajectoryWidthMax = Math.floor(termWidth * 0.75) - nyanCatWidth;
+  }
+
+  onEnd(run: BenchmarkRun): void {
+    if (this.quiet) {
+      return;
+    }
+
+    // Show cursor and move past the cat
+    this.showCursor();
+    for (let i = 0; i < this.numberOfLines; i++) {
+      process.stdout.write('\n');
+    }
+
+    // Print summary
+    this.printEpilogue(run);
+  }
+
+  onError(error: Error): void {
+    if (this.quiet) {
+      return;
+    }
+
+    // Make sure cursor is visible
+    this.showCursor();
+
+    console.error(`\n${colors.red}Error: ${error.message}${colors.reset}`);
+  }
+
+  onFileEnd(_result: FileResult): void {
+    // Just keep flying
+  }
+
+  onFileStart(file: string): void {
+    this.currentFile = file;
+  }
+
+  onStart(_run: BenchmarkRun): void {
+    this.startTime = Date.now();
+    this.passed = 0;
+    this.failed = 0;
+    this.failures = [];
+    this.colorIndex = 0;
+    this.tick = false;
+    this.trajectories = [[], [], [], []];
+
+    if (this.quiet) {
+      return;
+    }
+
+    // Hide cursor for cleaner animation
+    this.hideCursor();
+
+    // Initial draw
+    this.draw();
+    this.progressActive = true;
+  }
+
+  onSuiteEnd(_result: SuiteResult): void {
+    // Keep flying
+  }
+
+  onSuiteStart(suite: string): void {
+    this.currentSuite = suite;
+  }
+
+  onTaskResult(result: TaskResult): void {
+    if (result.error) {
+      this.failed++;
+      this.failures.push({
+        error: result.error.message || String(result.error),
+        file: this.currentFile,
+        suite: this.currentSuite,
+        task: result.name,
+      });
+    } else if (!result.aborted) {
+      this.passed++;
+    }
+
+    if (this.quiet) {
+      return;
+    }
+
+    this.draw();
+  }
+
+  onTaskStart(_task: string): void {
+    // The cat flies on results, not starts
+  }
+
+  /**
+   * Append a segment to the rainbow trail
+   */
+  private appendRainbow(): void {
+    const segment = this.tick ? '_' : '-';
+    const rainbowified = this.rainbowify(segment);
+
+    for (let index = 0; index < this.numberOfLines; index++) {
+      const trajectory = this.trajectories[index]!;
+      if (trajectory.length >= this.trajectoryWidthMax) {
+        trajectory.shift();
+      }
+      trajectory.push(rainbowified);
+    }
+  }
+
+  /**
+   * Move cursor down n lines
+   */
+  private cursorDown(n: number): void {
+    process.stdout.write(`\x1b[${n}B`);
+  }
+
+  /**
+   * Move cursor up n lines
+   */
+  private cursorUp(n: number): void {
+    process.stdout.write(`\x1b[${n}A`);
+  }
+
+  /**
+   * Draw the complete nyan cat scene
+   */
+  private draw(): void {
+    this.appendRainbow();
+    this.drawScoreboard();
+    this.drawRainbow();
+    this.drawNyanCat();
+    this.tick = !this.tick;
+  }
+
+  /**
+   * Draw the nyan cat ASCII art
+   */
+  private drawNyanCat(): void {
+    const startWidth = this.scoreboardWidth + this.trajectories[0]!.length;
+    const dist = `\x1b[${startWidth}C`;
+
+    process.stdout.write(dist);
+    process.stdout.write('_,------,');
+    process.stdout.write('\n');
+
+    process.stdout.write(dist);
+    const padding1 = this.tick ? '  ' : '   ';
+    process.stdout.write(`_|${padding1}/\\_/\\ `);
+    process.stdout.write('\n');
+
+    process.stdout.write(dist);
+    const padding2 = this.tick ? '_' : '__';
+    const tail = this.tick ? '~' : '^';
+    process.stdout.write(`${tail}|${padding2}${this.face()} `);
+    process.stdout.write('\n');
+
+    process.stdout.write(dist);
+    const padding3 = this.tick ? ' ' : '  ';
+    process.stdout.write(`${padding3}""  "" `);
+    process.stdout.write('\n');
+
+    this.cursorUp(this.numberOfLines);
+  }
+
+  /**
+   * Draw the rainbow trail
+   */
+  private drawRainbow(): void {
+    for (const line of this.trajectories) {
+      process.stdout.write(`\x1b[${this.scoreboardWidth}C`);
+      process.stdout.write(line.join(''));
+      process.stdout.write('\n');
+    }
+
+    this.cursorUp(this.numberOfLines);
+  }
+
+  /**
+   * Draw the scoreboard showing pass/fail counts
+   */
+  private drawScoreboard(): void {
+    const draw = (type: 'green' | 'red', n: number) => {
+      process.stdout.write(' ');
+      if (this.useColor) {
+        process.stdout.write(`${colors[type]}${n}${colors.reset}`);
+      } else {
+        process.stdout.write(String(n));
+      }
+      process.stdout.write('\n');
+    };
+
+    draw('green', this.passed);
+    draw('red', this.failed);
+    process.stdout.write('\n');
+    process.stdout.write('\n');
+
+    this.cursorUp(this.numberOfLines);
+  }
+
+  /**
+   * Get the nyan cat's face based on current state
+   */
+  private face(): string {
+    if (this.failed > 0) {
+      return '( x .x)';
+    } else if (this.passed > 0) {
+      return '( ^ .^)';
+    }
+    return '( - .-)';
+  }
+
+  /**
+   * Generate rainbow colors using sine wave color cycling
+   *
+   * Uses 256-color palette (colors 16-231 are a 6x6x6 color cube)
+   */
+  private generateColors(): number[] {
+    const colorList: number[] = [];
+
+    // Generate 42 colors (6 * 7) cycling through the spectrum
+    for (let i = 0; i < 6 * 7; i++) {
+      const pi3 = Math.floor(Math.PI / 3);
+      const n = i * (1.0 / 6);
+      const r = Math.floor(3 * Math.sin(n) + 3);
+      const g = Math.floor(3 * Math.sin(n + 2 * pi3) + 3);
+      const b = Math.floor(3 * Math.sin(n + 4 * pi3) + 3);
+      // Calculate 256-color code from RGB values (16 + 36*r + 6*g + b)
+      colorList.push(36 * r + 6 * g + b + 16);
+    }
+
+    return colorList;
+  }
+
+  /**
+   * Hide the cursor
+   */
+  private hideCursor(): void {
+    if (process.stdout.isTTY) {
+      process.stdout.write('\x1b[?25l');
+    }
+  }
+
+  /**
+   * Print the epilogue summary after the run
+   */
+  private printEpilogue(run: BenchmarkRun): void {
+    const duration = Date.now() - this.startTime;
+    const durationStr = BaseReporter.formatDuration(duration * 1000000);
+
+    console.log();
+    console.log(
+      `  ${this.useColor ? colors.green : ''}${this.passed} passing${this.useColor ? colors.reset : ''} ${this.useColor ? colors.gray : ''}(${durationStr})${this.useColor ? colors.reset : ''}`,
+    );
+
+    if (this.failed > 0) {
+      console.log(
+        `  ${this.useColor ? colors.red : ''}${this.failed} failing${this.useColor ? colors.reset : ''}`,
+      );
+      console.log();
+
+      // Print failure details
+      for (let i = 0; i < this.failures.length; i++) {
+        const failure = this.failures[i]!;
+        console.log(
+          `  ${i + 1}) ${failure.suite === 'default' ? '' : failure.suite + ' > '}${failure.task}`,
+        );
+        console.log(
+          `     ${this.useColor ? colors.red : ''}${failure.error}${this.useColor ? colors.reset : ''}`,
+        );
+        console.log();
+      }
+    }
+
+    // Show total files/suites for context
+    let totalSuites = 0;
+    for (const file of run.files) {
+      totalSuites += file.suites.length;
+    }
+
+    console.log();
+    console.log(
+      `  ${this.useColor ? colors.gray : ''}Files: ${run.files.length} | Suites: ${totalSuites} | Tasks: ${this.passed + this.failed}${this.useColor ? colors.reset : ''}`,
+    );
+  }
+
+  /**
+   * Apply rainbow coloring to a string
+   */
+  private rainbowify(str: string): string {
+    if (!this.useColor) {
+      return str;
+    }
+
+    const color =
+      this.rainbowColors[this.colorIndex % this.rainbowColors.length]!;
+    this.colorIndex += 1;
+
+    return `\x1b[38;5;${color}m${str}\x1b[0m`;
+  }
+
+  /**
+   * Show the cursor
+   */
+  private showCursor(): void {
+    if (process.stdout.isTTY) {
+      process.stdout.write('\x1b[?25h');
+    }
+  }
+}

package/src/types/core.ts

@@ -37,6 +37,20 @@ export type {
   BenchmarkTaskInput,
 } from '../core/benchmark-schema.js';
 
+/**
+ * Benchmark file structure after parsing
+ */
+export interface BenchmarkFile {
+  /** Raw file content */
+  readonly content: string;
+  /** Parsed exports from the file */
+  readonly exports: unknown;
+  /** Absolute path to the file */
+  readonly filePath: string;
+  /** File metadata */
+  readonly metadata: FileMetadata;
+}
+
 /**
  * ModestBench Core Types
  *
@@ -52,20 +66,6 @@ export type {
 // Re-export identifier helper functions
 export { createRunId, createTaskId } from '../utils/identifiers.js';
 
-/**
- * Benchmark file structure after parsing
- */
-export interface BenchmarkFile {
-  /** Raw file content */
-  readonly content: string;
-  /** Parsed exports from the file */
-  readonly exports: unknown;
-  /** Absolute path to the file */
-  readonly filePath: string;
-  /** File metadata */
-  readonly metadata: FileMetadata;
-}
-
 /**
  * Represents a complete benchmark run across multiple files
  */
@@ -128,6 +128,8 @@ export interface CpuInfo {
   readonly speed: number;
 }
 
+export type Engine = 'accurate' | 'tinybench';
+
 /**
  * Environment information captured during benchmark execution
  */

package/src/types/index.ts

@@ -5,9 +5,6 @@
  * This file re-exports all types from the individual type modules.
  */
 
-// CLI-specific types
-export * from './cli.js';
-
 // Core data types
 export type * from './core.js';
 // Helper functions from core (value exports)

package/dist/types/cli.cjs

@@ -1,12 +0,0 @@
-"use strict";
-/**
- * ModestBench CLI Types
- *
- * Defines types specific to the command-line interface, including command
- * definitions, argument parsing, and CLI-specific configuration structures.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ExitCodes = void 0;
-const constants_js_1 = require("../constants.cjs");
-Object.defineProperty(exports, "ExitCodes", { enumerable: true, get: function () { return constants_js_1.ExitCodes; } });
-//# sourceMappingURL=cli.js.map

package/dist/types/cli.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../src/types/cli.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,mDAA4C;AAEnC,0FAFA,wBAAS,OAEA"}

package/dist/types/cli.d.cts

@@ -1,75 +0,0 @@
-/**
- * ModestBench CLI Types
- *
- * Defines types specific to the command-line interface, including command
- * definitions, argument parsing, and CLI-specific configuration structures.
- */
-import { ExitCodes } from "../constants.cjs";
-export { ExitCodes };
-/**
- * CLI argument specification for a command
- */
-export interface ArgumentSpec {
-    /** Short alias */
-    readonly alias?: string;
-    /** Choices for string arguments */
-    readonly choices?: string[];
-    /** Default value */
-    readonly default?: unknown;
-    /** Argument description */
-    readonly description: string;
-    /** Argument name */
-    readonly name: string;
-    /** Whether argument is required */
-    readonly required?: boolean;
-    /** Argument type */
-    readonly type: 'array' | 'boolean' | 'number' | 'string';
-    /** Validation function */
-    readonly validate?: (value: unknown) => boolean | string;
-}
-/**
- * Parsed command-line arguments
- */
-export interface CommandArguments {
-    /** Positional arguments */
-    readonly _: string[];
-    /** Named arguments */
-    readonly [key: string]: unknown;
-}
-/**
- * CLI command specification
- */
-export interface CommandSpec {
-    /** Command aliases */
-    readonly aliases?: string[];
-    /** Command description */
-    readonly description: string;
-    /** Examples of command usage */
-    readonly examples?: string[];
-    /** Command name */
-    readonly name: string;
-    /** Named arguments */
-    readonly options?: ArgumentSpec[];
-    /** Positional arguments */
-    readonly positional?: ArgumentSpec[];
-    /** Subcommands */
-    readonly subcommands?: CommandSpec[];
-}
-export type Engine = 'accurate' | 'tinybench';
-export type ExitCode = (typeof ExitCodes)[keyof typeof ExitCodes];
-/**
- * Progress display options
- */
-export interface ProgressDisplayOptions {
-    /** Progress bar width */
-    readonly barWidth: number;
-    /** Show current file being processed */
-    readonly showCurrentFile: boolean;
-    /** Show progress bars */
-    readonly showProgress: boolean;
-    /** Show estimated time remaining */
-    readonly showTimeRemaining: boolean;
-    /** Update interval in milliseconds */
-    readonly updateInterval: number;
-}
-//# sourceMappingURL=cli.d.ts.map

package/dist/types/cli.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../../src/types/cli.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,SAAS,EAAE,yBAAwB;AAE5C,OAAO,EAAE,SAAS,EAAE,CAAC;AAErB;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,kBAAkB;IAClB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,mCAAmC;IACnC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAC5B,oBAAoB;IACpB,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAC3B,2BAA2B;IAC3B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,oBAAoB;IACpB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,mCAAmC;IACnC,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAC5B,oBAAoB;IACpB,QAAQ,CAAC,IAAI,EAAE,OAAO,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,CAAC;IACzD,0BAA0B;IAC1B,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,OAAO,GAAG,MAAM,CAAC;CAC1D;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,2BAA2B;IAC3B,QAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,sBAAsB;IACtB,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,sBAAsB;IACtB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAC5B,0BAA0B;IAC1B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,gCAAgC;IAChC,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IAC7B,mBAAmB;IACnB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,sBAAsB;IACtB,QAAQ,CAAC,OAAO,CAAC,EAAE,YAAY,EAAE,CAAC;IAClC,2BAA2B;IAC3B,QAAQ,CAAC,UAAU,CAAC,EAAE,YAAY,EAAE,CAAC;IACrC,kBAAkB;IAClB,QAAQ,CAAC,WAAW,CAAC,EAAE,WAAW,EAAE,CAAC;CACtC;AAED,MAAM,MAAM,MAAM,GAAG,UAAU,GAAG,WAAW,CAAC;AAE9C,MAAM,MAAM,QAAQ,GAAG,CAAC,OAAO,SAAS,CAAC,CAAC,MAAM,OAAO,SAAS,CAAC,CAAC;AAElE;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,yBAAyB;IACzB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,wCAAwC;IACxC,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAC;IAClC,yBAAyB;IACzB,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC;IAC/B,oCAAoC;IACpC,QAAQ,CAAC,iBAAiB,EAAE,OAAO,CAAC;IACpC,sCAAsC;IACtC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;CACjC"}