modestbench 0.2.0 → 0.3.1

package/src/reporters/json.ts

@@ -5,16 +5,11 @@
  * 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 '../services/reporter-registry.js';
@@ -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),
     };

package/src/reporters/profile-human.ts

@@ -0,0 +1,210 @@
+/**
+ * Profile Human Reporter
+ *
+ * Human-readable reporter for profile command. Uses modestbench's synthwave
+ * ANSI theme to display profiled functions in an attractive, color-coded
+ * format.
+ *
+ * @packageDocumentation
+ */
+
+import path from 'node:path';
+
+import type { FilteredProfileData } from '../types/profiler.js';
+
+import { ansiChars, colors } from '../utils/ansi.js';
+
+/**
+ * Reporter options
+ */
+interface ProfileReporterOptions {
+  /** Enable color output */
+  color?: boolean;
+
+  /** Group by file */
+  groupByFile?: boolean;
+}
+
+/**
+ * Human-readable profile reporter
+ */
+export class ProfileHumanReporter {
+  private readonly groupByFile: boolean;
+
+  private readonly useColor: boolean;
+
+  constructor(options: ProfileReporterOptions = {}) {
+    this.useColor =
+      options.color ??
+      (process.stdout.isTTY &&
+        process.env.FORCE_COLOR !== '0' &&
+        process.env.NO_COLOR == null);
+
+    this.groupByFile = options.groupByFile ?? false;
+  }
+
+  /**
+   * Generate and print profile report
+   */
+  report(data: FilteredProfileData): void {
+    this.printHeader(data);
+    this.printLine();
+
+    if (this.groupByFile && data.groupedByFile) {
+      this.printGroupedResults(data);
+    } else {
+      this.printFlatResults(data);
+    }
+  }
+
+  private colorize(color: keyof typeof colors, text: string): string {
+    if (!this.useColor) {
+      return text;
+    }
+    return `${colors[color]}${text}${colors.reset}`;
+  }
+
+  /**
+   * 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;
+  }
+
+  private getPercentColor(percent: number): keyof typeof colors {
+    if (percent >= 10) {
+      return 'brightRed';
+    }
+    if (percent >= 5) {
+      return 'brightYellow';
+    }
+    if (percent >= 2) {
+      return 'brightCyan';
+    }
+    return 'white';
+  }
+
+  private printFlatResults(data: FilteredProfileData): void {
+    const header = `${this.colorize('magenta', ansiChars.block.full.repeat(2))} ${this.colorize('brightWhite', this.colorize('bold', 'Benchmark Candidates'))}`;
+    this.printLine(header);
+    this.printLine();
+    this.printLine('Top functions by execution time:');
+    this.printLine();
+
+    for (const fn of data.functions) {
+      // Function name and percentage
+      const percentColor = this.getPercentColor(fn.percentage);
+      const percent = `${fn.percentage.toFixed(1)}%`;
+      const ticks = `(${fn.ticks.toLocaleString()} ticks)`;
+
+      this.printLine(
+        `  ${this.colorize('brightWhite', fn.name).padEnd(60)} ${this.colorize(percentColor, percent.padStart(6))}  ${this.colorize('dim', ticks)}`,
+      );
+
+      // File and line
+      const displayPath = this.formatPath(fn.file);
+      const lineInfo = fn.line ? `:${fn.line}` : '';
+      this.printLine(
+        `  ${this.colorize('brightMagenta', this.colorize('bold', displayPath + lineInfo))}`,
+      );
+      this.printLine();
+    }
+
+    this.printSummary(data);
+  }
+
+  private printGroupedResults(data: FilteredProfileData): void {
+    if (!data.groupedByFile) {
+      return;
+    }
+
+    const header = `${this.colorize('magenta', ansiChars.block.full.repeat(2))} ${this.colorize('brightWhite', this.colorize('bold', 'Grouped by File'))}`;
+    this.printLine(header);
+    this.printLine();
+
+    // Sort files by total percentage
+    const sortedFiles = Array.from(data.groupedByFile.entries()).sort(
+      (a, b) => {
+        const aTotal = a[1].reduce((sum, fn) => sum + fn.percentage, 0);
+        const bTotal = b[1].reduce((sum, fn) => sum + fn.percentage, 0);
+        return bTotal - aTotal;
+      },
+    );
+
+    for (const [file, functions] of sortedFiles) {
+      const totalPercent = functions.reduce(
+        (sum, fn) => sum + fn.percentage,
+        0,
+      );
+      const totalTicks = functions.reduce((sum, fn) => sum + fn.ticks, 0);
+
+      const percentColor = this.getPercentColor(totalPercent);
+      const percent = `${totalPercent.toFixed(1)}%`;
+      const ticks = `(${totalTicks.toLocaleString()} ticks)`;
+
+      // File header
+      const displayPath = this.formatPath(file);
+      this.printLine(
+        `${this.colorize('magenta', ansiChars.block.dark)} ${this.colorize('brightMagenta', this.colorize('bold', displayPath)).padEnd(60)} ${this.colorize(percentColor, percent.padStart(6))}  ${this.colorize('dim', ticks)}`,
+      );
+
+      // Functions in this file
+      for (const fn of functions) {
+        const fnPercent = `${fn.percentage.toFixed(1)}%`;
+        const fnTicks = `(${fn.ticks.toLocaleString()} ticks)`;
+        const lineInfo = fn.line ? `:${fn.line}` : '';
+
+        this.printLine(
+          `  ${this.colorize('magenta', ansiChars.smallSquare)} ${this.colorize('brightWhite', fn.name).padEnd(58)} ${this.colorize(this.getPercentColor(fn.percentage), fnPercent.padStart(6))}  ${this.colorize('dim', fnTicks.padEnd(15))} ${this.colorize('dim', lineInfo)}`,
+        );
+      }
+
+      this.printLine();
+    }
+
+    this.printSummary(data);
+  }
+
+  private printHeader(data: FilteredProfileData): void {
+    const header = `${this.colorize('magenta', ansiChars.block.full.repeat(2))} ${this.colorize('brightWhite', this.colorize('bold', 'Profile Analysis'))}`;
+    this.printLine(header);
+    this.printLine();
+
+    if (data.command) {
+      this.printLine(`Command: ${this.colorize('cyan', data.command)}`);
+    }
+
+    if (data.duration) {
+      const durationSec = (data.duration / 1000).toFixed(1);
+      this.printLine(`Duration: ${this.colorize('cyan', `${durationSec}s`)}`);
+    }
+
+    this.printLine(
+      `Total Ticks: ${this.colorize('cyan', data.totalTicks.toLocaleString())}`,
+    );
+  }
+
+  private printLine(text = ''): void {
+    console.log(text);
+  }
+
+  private printSummary(data: FilteredProfileData): void {
+    if (data.totalShown === 0) {
+      this.printLine(
+        `${this.colorize('dim', `No functions used at least ${data.minExecutionPercent}% of the ticks`)}`,
+      );
+    } else {
+      this.printLine(
+        `${this.colorize('dim', `... (showing top ${data.totalShown} of ${data.totalFiltered} user functions)`)}`,
+      );
+    }
+  }
+}

package/src/reporters/simple.ts

@@ -9,8 +9,8 @@ import path from 'node:path';
 
 import type {
   BenchmarkRun,
+  BudgetSummary,
   FileResult,
-  ProgressState,
   SuiteResult,
   TaskResult,
 } from '../types/index.js';
@@ -62,6 +62,78 @@ export class SimpleReporter extends BaseReporter {
     this.quiet = options.quiet ?? false;
   }
 
+  /**
+   * 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;
+    }
+
+    console.log('== Performance Budgets');
+    console.log();
+
+    for (const result of summary.results) {
+      const icon = result.passed ? symbols.checkmark : symbols.cross;
+      console.log(`  ${icon} ${result.taskId}`);
+
+      if (!result.passed && result.violations.length > 0) {
+        for (const violation of result.violations) {
+          console.log(`      ${violation.message}`);
+        }
+      }
+    }
+
+    console.log();
+
+    if (summary.failed === 0) {
+      console.log(
+        `  ${symbols.checkmark} All ${summary.total} budget(s) passed`,
+      );
+    } else {
+      console.log(
+        `  ${symbols.cross} ${summary.failed} of ${summary.total} budget(s) failed`,
+      );
+    }
+
+    console.log();
+  }
+
   onEnd(run: BenchmarkRun): void {
     if (this.quiet) {
       return;
@@ -97,7 +169,7 @@ export class SimpleReporter extends BaseReporter {
     console.log(`- Files: ${totalFiles}`);
     console.log(`- Suites: ${totalSuites}`);
     console.log(
-      `${symbols.approx} Duration: ${this.formatDuration(duration * 1e6)}`,
+      `${symbols.approx} Duration: ${BaseReporter.formatDuration(duration * 1e6)}`,
     );
     console.log();
 
@@ -111,7 +183,7 @@ export class SimpleReporter extends BaseReporter {
         console.log();
 
         for (const failure of this.failures) {
-          const displayPath = this.formatPath(failure.file);
+          const displayPath = SimpleReporter.formatPath(failure.file);
           console.log(`  ${displayPath} > ${failure.suite} > ${failure.task}`);
           console.log(`    ${failure.error}`);
           console.log();
@@ -155,7 +227,7 @@ export class SimpleReporter extends BaseReporter {
       );
     } else {
       console.log(
-        ` ${symbols.checkmark} ${totalPassed > 1 ? 'All ' : ''}${totalPassed} ${this.pluralize('task', totalPassed)} passed`,
+        ` ${symbols.checkmark} ${totalPassed > 1 ? 'All ' : ''}${totalPassed} ${SimpleReporter.pluralize('task', totalPassed)} passed`,
       );
     }
 
@@ -169,15 +241,10 @@ export class SimpleReporter extends BaseReporter {
       return;
     }
 
-    const displayPath = this.formatPath(file);
+    const displayPath = SimpleReporter.formatPath(file);
     console.log(`-- ${displayPath}`);
   }
 
-  onProgress(_state: ProgressState): void {
-    // Simple reporter does not display progress bars
-    return;
-  }
-
   onStart(run: BenchmarkRun): void {
     this.startTime = Date.now();
     this.failures = []; // Reset failures for new run
@@ -197,7 +264,9 @@ export class SimpleReporter extends BaseReporter {
       console.log(
         `  cpu: ${run.environment.cpu.model} (${run.environment.cpu.cores} cores)`,
       );
-      console.log(`  mem: ${this.formatBytes(run.environment.memory.total)}`);
+      console.log(
+        `  mem: ${SimpleReporter.formatBytes(run.environment.memory.total)}`,
+      );
       console.log();
     }
 
@@ -231,7 +300,7 @@ export class SimpleReporter extends BaseReporter {
       console.log(`  ${symbols.cross} ${failed} failed, ${passed} passed`);
     } else {
       console.log(
-        `  ${symbols.checkmark} ${passed} ${this.pluralize('task', passed)} passed`,
+        `  ${symbols.checkmark} ${passed} ${SimpleReporter.pluralize('task', passed)} passed`,
       );
     }
     console.log();
@@ -260,8 +329,11 @@ export class SimpleReporter extends BaseReporter {
       return;
     }
 
-    // Buffer the result for later printing with proper alignment
+    // Always buffer the result for suite summary (including aborted tasks)
     this.suiteResults.push(result);
+
+    // Note: Aborted tasks are still printed in simple reporter for completeness
+    // but they'll have zero stats
   }
 
   onTaskStart(task: string): void {
@@ -275,44 +347,6 @@ export class SimpleReporter extends BaseReporter {
     }
   }
 
-  /**
-   * 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;
-  }
-
-  /**
-   * 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
    */
@@ -364,9 +398,9 @@ export class SimpleReporter extends BaseReporter {
         };
       }
 
-      const duration = this.formatDuration(result.mean * 1e9);
-      const opsPerSec = this.formatOpsPerSecond(result.opsPerSecond);
-      const rme = this.formatPercentage(result.marginOfError * 100);
+      const duration = BaseReporter.formatDuration(result.mean * 1e9);
+      const opsPerSec = BaseReporter.formatOpsPerSecond(result.opsPerSecond);
+      const rme = BaseReporter.formatPercentage(result.marginOfError); // already a percentage
 
       return {
         durationLen: duration.length,