modestbench 0.1.0 → 0.3.0

package/src/reporters/csv.ts

@@ -11,20 +11,24 @@ import { dirname } from 'node:path';
 
 import type {
   BenchmarkRun,
-  FileResult,
-  ProgressState,
-  SuiteResult,
+  BudgetResult,
+  BudgetSummary,
+  TaskId,
   TaskResult,
 } from '../types/index.js';
 
 import { ReporterOutputError } from '../errors/index.js';
-import { BaseReporter } from './registry.js';
+import { BaseReporter } from '../services/reporter-registry.js';
+import { createTaskId } from '../types/index.js';
 
 /**
  * CSV column definitions for task results
  */
 interface CsvRow {
   readonly arch: string;
+  /** Budget passed: 1 (pass), 0 (fail), undefined (no budget) */
+  readonly budgetPassed?: number | undefined;
+  readonly budgetViolations?: string | undefined;
   readonly ciProvider?: string | undefined;
   readonly cpuCores: number;
   readonly cpuModel: string;
@@ -54,6 +58,8 @@ interface CsvRow {
  * CSV reporter for structured tabular output
  */
 export class CsvReporter extends BaseReporter {
+  private budgetResults: Map<TaskId, BudgetResult> = new Map();
+
   private currentFile = '';
 
   private currentRun?: BenchmarkRun;
@@ -68,8 +74,6 @@ export class CsvReporter extends BaseReporter {
 
   private readonly outputPath?: string | undefined;
 
-  private readonly quiet: boolean;
-
   private readonly quote: string;
 
   private rows: CsvRow[] = [];
@@ -92,7 +96,6 @@ export class CsvReporter extends BaseReporter {
     this.includeMetadata = options.includeMetadata ?? true;
     this.delimiter = options.delimiter ?? ',';
     this.quote = options.quote ?? '"';
-    this.quiet = options.quiet ?? false;
   }
 
   /**
@@ -137,6 +140,31 @@ export class CsvReporter extends BaseReporter {
     return this.includeMetadata;
   }
 
+  onBudgetResult(summary: BudgetSummary): void {
+    // Store budget results indexed by taskId
+    for (const result of summary.results) {
+      this.budgetResults.set(result.taskId, result);
+    }
+
+    // Update existing rows with budget data (since onTaskResult is called before onBudgetResult)
+    for (const row of this.rows) {
+      // row.file is already relative to cwd
+      const taskId = createTaskId(row.file, row.suite, row.task);
+      const budgetResult = this.budgetResults.get(taskId);
+      if (budgetResult) {
+        // Need to cast to mutable to update readonly properties
+        const mutableRow = row as {
+          budgetPassed?: number;
+          budgetViolations?: string;
+        };
+        mutableRow.budgetPassed = budgetResult.passed ? 1 : 0;
+        mutableRow.budgetViolations = budgetResult.violations
+          .map((v) => v.type)
+          .join('; ');
+      }
+    }
+  }
+
   async onEnd(_run: BenchmarkRun): Promise<void> {
     const csvContent = this.generateCsv();
 
@@ -151,27 +179,15 @@ export class CsvReporter extends BaseReporter {
     console.error('CSV Reporter Error:', error.message);
   }
 
-  onFileEnd(_result: FileResult): void {
-    // No-op for CSV reporter
-  }
-
   onFileStart(file: string): void {
     this.currentFile = file;
   }
 
-  onProgress(_state: ProgressState): void {
-    // No-op for CSV reporter
-  }
-
   onStart(run: BenchmarkRun): void {
     this.currentRun = run;
     this.rows = [];
   }
 
-  onSuiteEnd(_result: SuiteResult): void {
-    // No-op for CSV reporter
-  }
-
   onSuiteStart(suite: string): void {
     this.currentSuite = suite;
   }
@@ -181,8 +197,21 @@ export class CsvReporter extends BaseReporter {
       return;
     }
 
+    // Look up budget result for this task
+    // this.currentFile is already relative to cwd (comes from engine)
+    const taskId = createTaskId(
+      this.currentFile,
+      this.currentSuite,
+      result.name,
+    );
+    const budgetResult = this.budgetResults.get(taskId);
+
     const row: CsvRow = {
       arch: this.currentRun.environment.arch,
+      budgetPassed: budgetResult ? (budgetResult.passed ? 1 : 0) : undefined,
+      budgetViolations: budgetResult
+        ? budgetResult.violations.map((v) => v.type).join('; ')
+        : undefined,
       ciProvider: this.currentRun.ci?.provider,
       cpuCores: this.currentRun.environment.cpu.cores,
       cpuModel: this.currentRun.environment.cpu.model,
@@ -211,10 +240,6 @@ export class CsvReporter extends BaseReporter {
     this.rows.push(row);
   }
 
-  onTaskStart(_task: string): void {
-    // No-op for CSV reporter
-  }
-
   /**
    * Escape a field value for CSV format
    */
@@ -277,6 +302,8 @@ export class CsvReporter extends BaseReporter {
       'p95',
       'p99',
       'error',
+      'budgetPassed',
+      'budgetViolations',
       'timestamp',
     ];
 
@@ -302,9 +329,9 @@ export class CsvReporter extends BaseReporter {
    */
   private generateRow(row: CsvRow): string {
     const values = [
-      row.file || '',
-      row.suite || '',
-      row.task || '',
+      row.file,
+      row.suite,
+      row.task,
       (row.mean ?? 0).toString(),
       (row.stdDev ?? 0).toString(),
       (row.min ?? 0).toString(),
@@ -316,6 +343,8 @@ export class CsvReporter extends BaseReporter {
       (row.p95 ?? 0).toString(),
       (row.p99 ?? 0).toString(),
       row.error || '',
+      row.budgetPassed !== undefined ? row.budgetPassed.toString() : '',
+      row.budgetViolations || '',
       row.timestamp || '',
     ];
 

package/src/reporters/human.ts

@@ -9,54 +9,15 @@ import path from 'node:path';
 
 import type {
   BenchmarkRun,
+  BudgetSummary,
   FileResult,
   ProgressState,
   SuiteResult,
   TaskResult,
 } from '../types/index.js';
 
-import { BaseReporter } from './registry.js';
-
-/**
- * ANSI color codes for terminal output
- */
-const colors = {
-  bold: '\x1b[1m',
-  brightBlue: '\x1b[94m',
-  brightCyan: '\x1b[96m',
-  brightMagenta: '\x1b[95m',
-  brightRed: '\x1b[91m',
-  brightWhite: '\x1b[97m',
-  cyan: '\x1b[36m',
-  dim: '\x1b[2m',
-  gray: '\x1b[90m',
-  green: '\x1b[32m',
-  magenta: '\x1b[35m',
-  red: '\x1b[31m',
-  reset: '\x1b[0m',
-  underline: '\x1b[4m',
-  white: '\x1b[37m',
-} as const;
-
-/**
- * CP437-inspired ANSI art characters
- */
-const ansiChars = {
-  approx: '≈',
-  // Block elements for gradients
-  block: {
-    dark: '▓',
-    full: '█',
-    light: '░',
-    medium: '▒',
-  },
-  bullet: '•',
-  // Symbols
-  checkmark: '√',
-  cross: '×',
-  plusMinus: '±',
-  smallSquare: '▪',
-} as const;
+import { BaseReporter } from '../services/reporter-registry.js';
+import { ansiChars, colors } from '../utils/ansi.js';
 
 /**
  * Human-readable console reporter with colorized output
@@ -111,6 +72,84 @@ export class HumanReporter extends BaseReporter {
     this.showProgress = options.progress ?? true;
   }
 
+  /**
+   * Format bytes in human-readable format
+   */
+  private static formatBytes(this: void, bytes: number): string {
+    const units = ['B', 'KB', 'MB', 'GB', 'TB'];
+    let size = bytes;
+    let unitIndex = 0;
+
+    while (size >= 1024 && unitIndex < units.length - 1) {
+      size /= 1024;
+      unitIndex++;
+    }
+
+    return `${size.toFixed(1)} ${units[unitIndex]}`;
+  }
+
+  /**
+   * Format file path - show relative path if within CWD, otherwise absolute
+   */
+  private static formatPath(this: void, filePath: string): string {
+    const cwd = process.cwd();
+    const absolutePath = path.resolve(filePath);
+
+    // Check if the file is within the current working directory
+    if (absolutePath.startsWith(cwd + path.sep) || absolutePath === cwd) {
+      return path.relative(cwd, absolutePath);
+    }
+
+    return absolutePath;
+  }
+
+  /**
+   * Simple pluralization helper
+   */
+  private static pluralize(this: void, str: string, count: number): string {
+    return count === 1 ? str : `${str}s`;
+  }
+
+  onBudgetResult(summary: BudgetSummary): void {
+    if (summary.total === 0 || this.quiet) {
+      return;
+    }
+
+    this.clearProgress();
+
+    this.printLine();
+    const budgetHeader = `${this.colorize('magenta', ansiChars.block.full.repeat(2))} ${this.colorize('brightWhite', this.colorize('bold', 'Performance Budgets'))}`;
+    this.printLine(budgetHeader);
+    this.printLine();
+
+    for (const result of summary.results) {
+      const icon = result.passed ? ansiChars.checkmark : ansiChars.cross;
+      const iconColor = result.passed ? 'brightCyan' : 'brightRed';
+
+      this.printLine(
+        `  ${this.colorize(iconColor, icon)} ${this.colorize('white', result.taskId)}`,
+      );
+
+      if (!result.passed && result.violations.length > 0) {
+        for (const violation of result.violations) {
+          this.printLine(
+            `      ${this.colorize('brightRed', violation.message)}`,
+          );
+        }
+      }
+    }
+
+    this.printLine();
+
+    const statusText =
+      summary.failed === 0
+        ? `${this.colorize('brightCyan', ansiChars.checkmark)} All ${summary.total} budget(s) passed`
+        : `${this.colorize('brightRed', ansiChars.cross)} ${summary.failed} of ${summary.total} budget(s) failed`;
+
+    this.printLine(`  ${statusText}`);
+    this.printLine();
+  }
+
   onEnd(run: BenchmarkRun): void {
     if (this.quiet) {
       return;
@@ -161,7 +200,7 @@ export class HumanReporter extends BaseReporter {
       );
     }
     this.printLine(
-      `${this.colorize('cyan', ansiChars.approx + ' Duration:')} ${this.colorize('brightWhite', this.formatDuration(duration * 1000000))}`,
+      `${this.colorize('cyan', ansiChars.approx + ' Duration:')} ${this.colorize('brightWhite', BaseReporter.formatDuration(duration * 1000000))}`,
     );
     this.printLine();
 
@@ -175,7 +214,7 @@ export class HumanReporter extends BaseReporter {
         this.printLine();
 
         for (const failure of this.failures) {
-          const displayPath = this.formatPath(failure.file);
+          const displayPath = HumanReporter.formatPath(failure.file);
           this.printLine(
             `  ${this.colorize('dim', displayPath)} ${this.colorize('dim', '›')} ${this.colorize('white', failure.suite)} ${this.colorize('dim', '›')} ${this.colorize('brightWhite', failure.task)}`,
           );
@@ -229,7 +268,7 @@ export class HumanReporter extends BaseReporter {
       );
     } else {
       this.printLine(
-        ` ${this.colorize('magenta', ansiChars.checkmark)} ${totalPassed > 1 ? this.colorize('brightMagenta', 'All ') : ''}${this.colorize('bold', this.colorize('brightMagenta', `${totalPassed}`))} ${this.colorize('brightMagenta', `${this.pluralize('task', totalPassed)} passed`)}`,
+        ` ${this.colorize('magenta', ansiChars.checkmark)} ${totalPassed > 1 ? this.colorize('brightMagenta', 'All ') : ''}${this.colorize('bold', this.colorize('brightMagenta', `${totalPassed}`))} ${this.colorize('brightMagenta', `${HumanReporter.pluralize('task', totalPassed)} passed`)}`,
       );
     }
 
@@ -243,7 +282,7 @@ export class HumanReporter extends BaseReporter {
       return;
     }
 
-    const displayPath = this.formatPath(file);
+    const displayPath = HumanReporter.formatPath(file);
     const fileMarker = `${colors.magenta}${ansiChars.block.dark}${ansiChars.block.dark}${colors.reset}`;
     this.printLine(
       `${fileMarker} ${colors.underline}${this.colorize('brightMagenta', this.colorize('bold', displayPath))}${colors.reset}`,
@@ -318,7 +357,7 @@ export class HumanReporter extends BaseReporter {
     \x1b[48;5;0m \x1b[48;5;14m \x1b[38;5;30;48;5;38m▄\x1b[38;5;14;48;5;14m▄\x1b[48;5;14m      \x1b[38;5;45;48;5;14m▄\x1b[38;5;89;48;5;14m▄\x1b[38;5;89;48;5;89m▄\x1b[38;5;14;48;5;31m▄\x1b[48;5;14m \x1b[38;5;37;48;5;89m▄\x1b[48;5;198m \x1b[38;5;198;48;5;198m▄\x1b[38;5;31;48;5;14m▄\x1b[48;5;14m \x1b[48;5;0m \x1b[m \x1b[2mnode.js:\x1b[m \x1b[36m${run.environment.nodeVersion} \x1b[m
     \x1b[48;5;0m \x1b[48;5;14m \x1b[38;5;44;48;5;31m▄\x1b[48;5;14m      \x1b[38;5;126;48;5;38m▄\x1b[38;5;198;48;5;237m▄\x1b[38;5;237;48;5;37m▄\x1b[48;5;14m   \x1b[38;5;14;48;5;14m▄\x1b[38;5;162;48;5;198m▄▄\x1b[38;5;53;48;5;240m▄\x1b[48;5;14m \x1b[48;5;0m \x1b[m \x1b[2mplatform:\x1b[m \x1b[36m${run.environment.platform} ${run.environment.arch} \x1b[m
     \x1b[48;5;0m \x1b[38;5;45;48;5;14m▄\x1b[48;5;14m       \x1b[38;5;14;48;5;37m▄\x1b[38;5;14;48;5;5m▄\x1b[38;5;14;48;5;44m▄\x1b[48;5;14m       \x1b[38;5;45;48;5;14m▄\x1b[48;5;0m \x1b[m \x1b[2mcpu:\x1b[m \x1b[36m${run.environment.cpu.model} \x1b[2m(\x1b[m\x1b[36m${run.environment.cpu.cores} cores\x1b[2m) \x1b[m
-    \x1b[49;38;5;0m▀▀\x1b[38;5;0;48;5;6m▄\x1b[38;5;232;48;5;14m▄\x1b[38;5;38;48;5;14m▄\x1b[48;5;14m           \x1b[38;5;30;48;5;14m▄\x1b[38;5;0;48;5;14m▄\x1b[38;5;0;48;5;23m▄\x1b[49;38;5;0m▀▀\x1b[m \x1b[2mmem:\x1b[m \x1b[36m${this.formatBytes(run.environment.memory.total)} \x1b[m
+    \x1b[49;38;5;0m▀▀\x1b[38;5;0;48;5;6m▄\x1b[38;5;232;48;5;14m▄\x1b[38;5;38;48;5;14m▄\x1b[48;5;14m           \x1b[38;5;30;48;5;14m▄\x1b[38;5;0;48;5;14m▄\x1b[38;5;0;48;5;23m▄\x1b[49;38;5;0m▀▀\x1b[m \x1b[2mmem:\x1b[m \x1b[36m${HumanReporter.formatBytes(run.environment.memory.total)} \x1b[m
     \x1b[49m    \x1b[49;38;5;0m▀\x1b[38;5;0;48;5;236m▄\x1b[38;5;0;48;5;45m▄\x1b[38;5;23;48;5;14m▄\x1b[48;5;14m     \x1b[38;5;236;48;5;14m▄\x1b[38;5;0;48;5;44m▄\x1b[38;5;0;48;5;232m▄\x1b[49;38;5;0m▀\x1b[49m    \x1b[m
     \x1b[49m       \x1b[49;38;5;0m▀▀\x1b[38;5;0;48;5;37m▄\x1b[38;5;0;48;5;14m▄\x1b[38;5;0;48;5;30m▄\x1b[49;38;5;0m▀▀\x1b[49m       \x1b[m
     `;
@@ -373,7 +412,7 @@ export class HumanReporter extends BaseReporter {
       );
     } else {
       this.printLine(
-        `  ${this.colorize('magenta', ansiChars.checkmark)} ${this.colorize('bold', this.colorize('brightWhite', `${passed}`))} ${this.colorize('brightWhite', `${this.pluralize('task', passed)} passed`)}`,
+        `  ${this.colorize('magenta', ansiChars.checkmark)} ${this.colorize('bold', this.colorize('brightWhite', `${passed}`))} ${this.colorize('brightWhite', `${HumanReporter.pluralize('task', passed)} passed`)}`,
       );
     }
     this.printLine();
@@ -454,37 +493,6 @@ export class HumanReporter extends BaseReporter {
     return `${colors[color]}${text}${colors.reset}`;
   }
 
-  /**
-   * Format bytes in human-readable format
-   */
-  private formatBytes(bytes: number): string {
-    const units = ['B', 'KB', 'MB', 'GB', 'TB'];
-    let size = bytes;
-    let unitIndex = 0;
-
-    while (size >= 1024 && unitIndex < units.length - 1) {
-      size /= 1024;
-      unitIndex++;
-    }
-
-    return `${size.toFixed(1)} ${units[unitIndex]}`;
-  }
-
-  /**
-   * Format file path - show relative path if within CWD, otherwise absolute
-   */
-  private formatPath(filePath: string): string {
-    const cwd = process.cwd();
-    const absolutePath = path.resolve(filePath);
-
-    // Check if the file is within the current working directory
-    if (absolutePath.startsWith(cwd + path.sep) || absolutePath === cwd) {
-      return path.relative(cwd, absolutePath);
-    }
-
-    return absolutePath;
-  }
-
   /**
    * Format duration in human-readable format for progress display
    */
@@ -511,13 +519,6 @@ export class HumanReporter extends BaseReporter {
     return str.replace(/\x1b\[[0-9;]*m/g, '').length;
   }
 
-  /**
-   * Simple pluralization helper
-   */
-  private pluralize(str: string, count: number): string {
-    return count === 1 ? str : `${str}s`;
-  }
-
   /**
    * Print all task results in a suite with aligned columns
    */
@@ -574,9 +575,9 @@ export class HumanReporter extends BaseReporter {
         };
       }
 
-      const duration = this.formatDuration(result.mean); // already in nanoseconds
-      const opsPerSec = this.formatOpsPerSecond(result.opsPerSecond);
-      const rme = this.formatPercentage(result.marginOfError * 100);
+      const duration = BaseReporter.formatDuration(result.mean); // already in nanoseconds
+      const opsPerSec = BaseReporter.formatOpsPerSecond(result.opsPerSecond);
+      const rme = BaseReporter.formatPercentage(result.marginOfError * 100);
 
       return {
         durationLen: this.getVisibleLength(duration),

package/src/reporters/json.ts

@@ -5,19 +5,14 @@
  * processing, CI/CD integration, and data analysis.
  */
 
-import { mkdirSync, writeFileSync } from 'node:fs';
-import { dirname } from 'node:path';
+import { mkdirSync, readFileSync, writeFileSync } from 'node:fs';
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
 
-import type {
-  BenchmarkRun,
-  FileResult,
-  ProgressState,
-  SuiteResult,
-  TaskResult,
-} from '../types/index.js';
+import type { BenchmarkRun, TaskResult } from '../types/index.js';
 
 import { ReporterOutputError } from '../errors/index.js';
-import { BaseReporter } from './registry.js';
+import { BaseReporter } from '../services/reporter-registry.js';
 
 /**
  * JSON output structure for benchmark results
@@ -40,12 +35,30 @@ interface JsonOutput {
   };
 }
 
+/**
+ * Cache the package version at module load time
+ *
+ * NOTE: This relies on package.json being at the same relative path from both
+ * src/ and dist/ directories (../../package.json). If the build output
+ * structure changes, this will break.
+ */
+const cachedPackageVersion = (() => {
+  try {
+    const __dirname = dirname(fileURLToPath(import.meta.url));
+    const pkgPath = join(__dirname, '..', '..', 'package.json');
+    const pkgContent = readFileSync(pkgPath, 'utf8');
+    const pkg = JSON.parse(pkgContent) as { version: string };
+    return pkg.version;
+  } catch {
+    // Fallback if package.json cannot be read (shouldn't happen in normal use)
+    return 'unknown';
+  }
+})();
+
 /**
  * JSON reporter for structured output
  */
 export class JsonReporter extends BaseReporter {
-  private currentRun?: BenchmarkRun;
-
   private readonly includeMetadata: boolean;
 
   private readonly includeStatistics: boolean;
@@ -54,8 +67,6 @@ export class JsonReporter extends BaseReporter {
 
   private readonly prettyPrint: boolean;
 
-  private readonly quiet: boolean;
-
   private statistics: {
     fastestTask?: TaskResult;
     slowestTask?: TaskResult;
@@ -74,8 +85,6 @@ export class JsonReporter extends BaseReporter {
       includeStatistics?: boolean;
       outputPath?: string;
       prettyPrint?: boolean;
-      quiet?: boolean;
-      verbose?: boolean;
     } = {},
   ) {
     super('json', options);
@@ -84,35 +93,6 @@ export class JsonReporter extends BaseReporter {
     this.prettyPrint = options.prettyPrint ?? true;
     this.includeStatistics = options.includeStatistics ?? true;
     this.includeMetadata = options.includeMetadata ?? true;
-    this.quiet = options.quiet ?? false;
-  }
-
-  /**
-   * Check if statistics are included
-   */
-  areStatisticsIncluded(): boolean {
-    return this.includeStatistics;
-  }
-
-  /**
-   * Get the output path (if configured)
-   */
-  getOutputPath(): string | undefined {
-    return this.outputPath;
-  }
-
-  /**
-   * Check if metadata is included
-   */
-  isMetadataIncluded(): boolean {
-    return this.includeMetadata;
-  }
-
-  /**
-   * Check if pretty printing is enabled
-   */
-  isPrettyPrintEnabled(): boolean {
-    return this.prettyPrint;
   }
 
   async onEnd(run: BenchmarkRun): Promise<void> {
@@ -131,41 +111,16 @@ export class JsonReporter extends BaseReporter {
     console.error('JSON Reporter Error:', error.message);
   }
 
-  onFileEnd(_result: FileResult): void {
-    // No-op for JSON reporter
-  }
-
-  onFileStart(_file: string): void {
-    // No-op for JSON reporter
-  }
-
-  onProgress(_state: ProgressState): void {
-    // No-op for JSON reporter - we don't output progress in JSON format
-  }
-
-  onStart(run: BenchmarkRun): void {
-    this.currentRun = run;
+  onStart(_run: BenchmarkRun): void {
     this.resetStatistics();
   }
 
-  onSuiteEnd(_result: SuiteResult): void {
-    // No-op for JSON reporter
-  }
-
-  onSuiteStart(_suite: string): void {
-    // No-op for JSON reporter
-  }
-
   onTaskResult(result: TaskResult): void {
     if (!result.error) {
       this.updateStatistics(result);
     }
   }
 
-  onTaskStart(_task: string): void {
-    // No-op for JSON reporter
-  }
-
   /**
    * Build the complete JSON output structure
    */
@@ -174,7 +129,7 @@ export class JsonReporter extends BaseReporter {
       meta: {
         format: 'modestbench-json',
         timestamp: new Date().toISOString(),
-        version: '0.1.0', // TODO: Get from package.json
+        version: cachedPackageVersion,
       },
       run: this.includeMetadata ? run : this.sanitizeRun(run),
     };