flexi-bench 0.0.0-alpha.1 → 0.0.0-alpha.3

package/CHANGELOG.md

@@ -0,0 +1,18 @@
+## 0.0.0-alpha.3 (2024-07-11)
+
+This was a version bump only, there were no code changes.
+
+## 0.0.0-alpha.2 (2024-07-11)
+
+This was a version bump only, there were no code changes.
+
+## 0.0.0-alpha.1 (2024-07-11)
+
+
+### 🚀 Features
+
+- initial draft ([d999262](https://github.com/AgentEnder/easybench/commit/d999262))
+
+### ❤️  Thank You
+
+- Craigory Coppola @AgentEnder

package/dist/api-types.d.ts

@@ -18,7 +18,10 @@ export interface ProgressContext {
     timeout?: number;
     timeElapsed: number;
 }
-export interface Reporter {
+export interface BenchmarkReporter {
     progress?: (name: string, progress: number, context: ProgressContext) => void;
     report: (benchmark: Benchmark, results: Result[]) => void;
 }
+export interface SuiteReporter {
+    report: (results: Record<string, Result[]>) => void;
+}

package/dist/benchmark-console-reporter.d.ts

@@ -0,0 +1,8 @@
+import { Result, BenchmarkReporter, ProgressContext } from './api-types';
+import { Benchmark } from './benchmark';
+export declare class BenchmarkConsoleReporter implements BenchmarkReporter {
+    private bar;
+    constructor();
+    progress(name: string, percent: number, context: ProgressContext): void;
+    report(benchmark: Benchmark, results: Result[]): void;
+}

package/dist/benchmark-console-reporter.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BenchmarkConsoleReporter = void 0;
+const cli_progress_1 = require("cli-progress");
+class BenchmarkConsoleReporter {
+    constructor() {
+        this.bar = new cli_progress_1.SingleBar({
+            format: 'Running: {label}\n{bar} {percentage}% | {value}/{total} - ETA: {eta}s',
+            barCompleteChar: '\u2588',
+            barIncompleteChar: '\u2591',
+            hideCursor: true,
+        });
+    }
+    progress(name, percent, context) {
+        var _a;
+        if (!this.bar.isActive) {
+            this.bar.start((_a = context.totalIterations) !== null && _a !== void 0 ? _a : 100, 0);
+        }
+        this.bar.update(context.completedIterations, { label: name });
+        process.stdout.moveCursor(0, -1);
+        // console.log(`Progress: ${name} ${Math.round(percent * 10000) / 100}%`);
+    }
+    report(benchmark, results) {
+        this.bar.stop();
+        process.stdout.moveCursor(0, -1);
+        process.stdout.clearScreenDown();
+        console.log(`Benchmark: ${benchmark.name}`);
+        console.table(results);
+    }
+}
+exports.BenchmarkConsoleReporter = BenchmarkConsoleReporter;

package/dist/benchmark.d.ts

@@ -1,5 +1,5 @@
 import { Variation } from './variation';
-import { Reporter } from './api-types';
+import { BenchmarkReporter, Result } from './api-types';
 import { ActionMethod } from './api-types';
 import { TeardownMethod } from './api-types';
 import { SetupMethod } from './api-types';
@@ -18,7 +18,7 @@ export declare class Benchmark {
         action?: ActionMethod;
         iterations?: number;
         timeout?: number;
-        reporter?: Reporter;
+        reporter?: BenchmarkReporter;
     });
     withVariation(name: string, builder: (variation: Variation) => Variation): this;
     withVariations(variations: Variation[]): this;
@@ -27,7 +27,7 @@ export declare class Benchmark {
     withAction(action: () => void): this;
     withIterations(iterations: number): this;
     withTimeout(timeout: number): this;
-    withReporter(reporter: Reporter): this;
-    run(): Promise<void>;
+    withReporter(reporter: BenchmarkReporter): this;
+    run(): Promise<Result[]>;
     private validate;
 }

package/dist/benchmark.js

@@ -10,7 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Benchmark = void 0;
-const console_reporter_1 = require("./console-reporter");
+const benchmark_console_reporter_1 = require("./benchmark-console-reporter");
 const variation_1 = require("./variation");
 class Benchmark {
     constructor(name, options) {
@@ -33,7 +33,7 @@ class Benchmark {
         if (options === null || options === void 0 ? void 0 : options.timeout) {
             this.timeout = options.timeout;
         }
-        this.reporter = (options === null || options === void 0 ? void 0 : options.reporter) || new console_reporter_1.ConsoleReporter();
+        this.reporter = (options === null || options === void 0 ? void 0 : options.reporter) || new benchmark_console_reporter_1.BenchmarkConsoleReporter();
     }
     withVariation(name, builder) {
         this.variations.push(builder(new variation_1.Variation(name)));
@@ -170,6 +170,7 @@ class Benchmark {
                 });
             }
             this.reporter.report(this, results);
+            return results;
         });
     }
     validate() {

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from './api-types';
 export * from './benchmark';
 export * from './variation';
-export * from './console-reporter';
+export * from './benchmark-console-reporter';
+export * from './suite';

package/dist/index.js

@@ -17,4 +17,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./api-types"), exports);
 __exportStar(require("./benchmark"), exports);
 __exportStar(require("./variation"), exports);
-__exportStar(require("./console-reporter"), exports);
+__exportStar(require("./benchmark-console-reporter"), exports);
+__exportStar(require("./suite"), exports);

package/dist/suite-console-reporter.d.ts

@@ -0,0 +1,4 @@
+import { Result, SuiteReporter } from './api-types';
+export declare class SuiteConsoleReporter implements SuiteReporter {
+    report: (results: Record<string, Result[]>) => void;
+}

package/dist/suite-console-reporter.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SuiteConsoleReporter = void 0;
+class SuiteConsoleReporter {
+    constructor() {
+        this.report = (results) => {
+            console.log('Suite Results:');
+            for (const [name, result] of Object.entries(results)) {
+                console.log(`Benchmark: ${name}`);
+                console.table(result);
+            }
+        };
+    }
+}
+exports.SuiteConsoleReporter = SuiteConsoleReporter;

package/dist/suite.d.ts

@@ -0,0 +1,17 @@
+import { SuiteReporter } from './api-types';
+import { Benchmark } from './benchmark';
+import { Variation } from './variation';
+export interface SuiteOptions {
+    reporter?: SuiteReporter;
+}
+export declare class Suite {
+    private name;
+    private benchmarks;
+    private variations;
+    private reporter;
+    constructor(name: string, options?: SuiteOptions);
+    addBenchmark(benchmark: Benchmark): this;
+    addVariation(variation: Variation): this;
+    addVariations(variations: Variation[]): this;
+    run(): Promise<void>;
+}

package/dist/suite.js

@@ -0,0 +1,46 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Suite = void 0;
+const suite_console_reporter_1 = require("./suite-console-reporter");
+class Suite {
+    constructor(name, options) {
+        this.name = name;
+        this.benchmarks = [];
+        this.variations = [];
+        this.name = name;
+        this.benchmarks = [];
+        this.reporter = (options === null || options === void 0 ? void 0 : options.reporter) || new suite_console_reporter_1.SuiteConsoleReporter();
+    }
+    addBenchmark(benchmark) {
+        this.benchmarks.push(benchmark);
+        return this;
+    }
+    addVariation(variation) {
+        this.variations.push(variation);
+        return this;
+    }
+    addVariations(variations) {
+        this.variations.push(...variations);
+        return this;
+    }
+    run() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const results = {};
+            for (const benchmark of this.benchmarks) {
+                benchmark.withVariations(this.variations);
+                results[benchmark.name] = yield benchmark.run();
+            }
+            this.reporter.report(results);
+        });
+    }
+}
+exports.Suite = Suite;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flexi-bench",
-  "version": "0.0.0-alpha.1",
+  "version": "0.0.0-alpha.3",
   "description": "",
   "main": "dist/index.js",
   "scripts": {
@@ -29,6 +29,7 @@
     "dist",
     "README.md",
     "LICENSE",
+    "CHANGELOG.md",
     "package.json"
   ]
 }