flexi-bench 0.0.0-alpha.2 → 0.0.0-alpha.4

package/dist/variation.d.ts

@@ -1,15 +1,29 @@
-import { SetupMethod, TeardownMethod, ActionMethod, EnvironmentVariableOptions } from './api-types';
-export declare class Variation {
+import { EnvironmentVariableOptions } from './api-types';
+import { BenchmarkBase } from './shared-api';
+export declare class Variation extends BenchmarkBase {
     name: string;
-    setupMethods: SetupMethod[];
-    teardownMethods: TeardownMethod[];
     environment: Partial<NodeJS.ProcessEnv>;
-    action?: ActionMethod;
+    cliArgs: string[];
     constructor(name: string);
     static FromEnvironmentVariables(variables: EnvironmentVariableOptions): Variation[];
-    withSetup(setup: SetupMethod): this;
-    withTeardown(teardown: TeardownMethod): this;
+    /**
+     *
+     * @param args An array of options to pass to the CLI. If an element is an array, they will be treated as alternatives.
+     * @returns An array of variations. Can be applied with `withVariations`.
+     * @example
+     * // Creates 2 variations, both with --flag, but one with --no-daemon and the other with --daemon.
+     * const variations = Variation.FromCliArgs([
+     *  '--flag',
+     * ['--no-daemon', '--daemon'],
+     * ]);
+     *
+     * // Creates 4 variations, with combinations of --a and --b.
+     * const variations = Variation.FromCliArgs([
+     * ['--a', '--b'],
+     * ]);
+     */
+    static FromCliArgs(args: Array<string | string[]>): Variation[];
     withEnvironmentVariables(env: Partial<NodeJS.ProcessEnv>): this;
     withEnvironmentVariable(name: string, value: string): this;
-    withAction(action: ActionMethod): this;
+    withCliArgs(...args: string[]): this;
 }

package/dist/variation.js

@@ -1,15 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Variation = void 0;
-class Variation {
+const shared_api_1 = require("./shared-api");
+const utils_1 = require("./utils");
+class Variation extends shared_api_1.BenchmarkBase {
     constructor(name) {
+        super();
         this.name = name;
-        this.setupMethods = [];
-        this.teardownMethods = [];
         this.environment = {};
+        this.cliArgs = [];
     }
     static FromEnvironmentVariables(variables) {
-        const combinations = variables.reduce((acc, [name, values]) => {
+        const combinations = (0, utils_1.findCombinations)(variables.map(([name, values]) => values.map((value) => [name, value])));
+        variables.reduce((acc, [name, values]) => {
             return acc.flatMap((accItem) => {
                 return values.map((value) => {
                     return [...accItem, [name, value]];
@@ -21,13 +24,30 @@ class Variation {
             return new Variation(label).withEnvironmentVariables(Object.fromEntries(combination));
         });
     }
-    withSetup(setup) {
-        this.setupMethods.push(setup);
-        return this;
-    }
-    withTeardown(teardown) {
-        this.teardownMethods.push(teardown);
-        return this;
+    /**
+     *
+     * @param args An array of options to pass to the CLI. If an element is an array, they will be treated as alternatives.
+     * @returns An array of variations. Can be applied with `withVariations`.
+     * @example
+     * // Creates 2 variations, both with --flag, but one with --no-daemon and the other with --daemon.
+     * const variations = Variation.FromCliArgs([
+     *  '--flag',
+     * ['--no-daemon', '--daemon'],
+     * ]);
+     *
+     * // Creates 4 variations, with combinations of --a and --b.
+     * const variations = Variation.FromCliArgs([
+     * ['--a', '--b'],
+     * ]);
+     */
+    static FromCliArgs(args) {
+        const alternatives = args.filter(Array.isArray);
+        const values = (0, utils_1.findCombinations)(alternatives);
+        return values.flatMap((alts) => {
+            const cliArgs = args.map((arg) => Array.isArray(arg) ? alts.shift() : arg);
+            const label = cliArgs.join(' ');
+            return new Variation(label).withCliArgs(...cliArgs);
+        });
     }
     withEnvironmentVariables(env) {
         this.environment = Object.assign(Object.assign({}, this.environment), env);
@@ -37,8 +57,8 @@ class Variation {
         this.environment[name] = value;
         return this;
     }
-    withAction(action) {
-        this.action = action;
+    withCliArgs(...args) {
+        this.cliArgs = this.cliArgs.concat(args);
         return this;
     }
 }

package/package.json

@@ -1,35 +1,49 @@
 {
   "name": "flexi-bench",
-  "version": "0.0.0-alpha.2",
+  "version": "0.0.0-alpha.4",
   "description": "",
   "main": "dist/index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/AgentEnder/flexi-bench"
+  },
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
+    "test": "node --import tsx --test './src/**/*.spec.ts'",
+    "test:watch": "node --import tsx --test --watch './src/**/*.spec.ts'",
     "build": "tsc -p tsconfig.json",
     "format": "prettier --write src"
   },
   "author": "",
-  "license": "ISC",
+  "license": "MIT",
   "devDependencies": {
     "@nx/js": "^19.4.2",
     "@swc-node/register": "~1.9.1",
     "@swc/core": "~1.5.7",
     "@swc/helpers": "~0.5.11",
-    "nx": "19.4.2"
-  },
-  "nx": {},
-  "dependencies": {
     "@types/cli-progress": "^3.11.6",
     "@types/node": "^20.14.10",
-    "cli-progress": "^3.12.0",
+    "nx": "19.4.2",
     "prettier": "^3.3.2",
-    "typescript": "^5.5.3"
+    "ts-node": "^10.9.2",
+    "tsx": "^4.16.2",
+    "typescript": "^5.5.3",
+    "yaml": "^2.4.5"
   },
+  "dependencies": {
+    "cli-progress": "^3.12.0",
+    "markdown-factory": "^0.0.6"
+  },
+  "nx": {},
   "files": [
     "dist",
     "README.md",
     "LICENSE",
     "CHANGELOG.md",
     "package.json"
+  ],
+  "workspaces": [
+    ".",
+    "docs-site",
+    "packages/*"
   ]
 }

package/dist/console-reporter.d.ts

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