modestbench 0.2.0 → 0.3.0

package/src/reporters/human.ts

@@ -9,6 +9,7 @@ import path from 'node:path';
 
 import type {
   BenchmarkRun,
+  BudgetSummary,
   FileResult,
   ProgressState,
   SuiteResult,
@@ -71,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;
@@ -121,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();
 
@@ -135,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)}`,
           );
@@ -189,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`)}`,
       );
     }
 
@@ -203,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}`,
@@ -278,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
     `;
@@ -333,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();
@@ -414,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
    */
@@ -471,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
    */
@@ -534,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,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,204 @@
+/**
+ * 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 {
+    this.printLine(
+      `${this.colorize('dim', `... (showing top ${data.totalShown} of ${data.totalFiltered} user functions)`)}`,
+    );
+  }
+}