modestbench 0.0.1

package/dist/types/utility.js

@@ -0,0 +1,78 @@
+/**
+ * ModestBench Utility Types
+ *
+ * Defines utility types, helper functions, and common type transformations used
+ * throughout the ModestBench system.
+ */
+/**
+ * Type predicate for checking if value is not null or undefined
+ */
+export const isDefined = (value) => {
+    return value !== null && value !== undefined;
+};
+/**
+ * Type predicate for checking if value is a non-empty string
+ */
+export const isNonEmptyString = (value) => {
+    return typeof value === 'string' && value.length > 0;
+};
+/**
+ * Type predicate for checking if value is a positive number
+ */
+export const isPositiveNumber = (value) => {
+    return typeof value === 'number' && value > 0 && !Number.isNaN(value);
+};
+/**
+ * Type predicate for checking if value is a non-negative number
+ */
+export const isNonNegativeNumber = (value) => {
+    return typeof value === 'number' && value >= 0 && !Number.isNaN(value);
+};
+/**
+ * Type predicate for checking if value is an integer
+ */
+export const isInteger = (value) => {
+    return typeof value === 'number' && Number.isInteger(value);
+};
+/**
+ * Type predicate for checking if array is non-empty
+ */
+export const isNonEmptyArray = (value) => {
+    return value.length > 0;
+};
+/**
+ * Creates a Result success value
+ */
+export const success = (data) => ({
+    data,
+    success: true,
+});
+/**
+ * Creates a Result error value
+ */
+export const failure = (error) => ({
+    error,
+    success: false,
+});
+/**
+ * Type assertion that a value is defined (throws if not)
+ */
+export const assertDefined = (value, message) => {
+    if (!isDefined(value)) {
+        throw new Error(message ?? 'Value is null or undefined');
+    }
+    return value;
+};
+/**
+ * Creates a branded type value
+ */
+export const brand = (value) => {
+    return value;
+};
+/**
+ * Removes brand from a branded type
+ */
+export const unbrand = (value) => {
+    return value;
+};
+//# sourceMappingURL=utility.js.map

package/dist/types/utility.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utility.js","sourceRoot":"","sources":["../../src/types/utility.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAiWH;;GAEG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAI,KAA2B,EAAc,EAAE;IACtE,OAAO,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,CAAC;AAC/C,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,KAAc,EAA2B,EAAE;IAC1E,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;AACvD,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,KAAc,EAA2B,EAAE;IAC1E,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AACxE,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,KAAc,EACc,EAAE;IAC9B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AACzE,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,KAAc,EAAoB,EAAE;IAC5D,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;AAC9D,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAI,KAAU,EAA6B,EAAE;IAC1E,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;AAC1B,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,CAAI,IAAO,EAAoB,EAAE,CAAC,CAAC;IACxD,IAAI;IACJ,OAAO,EAAE,IAAI;CACd,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,CAAI,KAAQ,EAAoB,EAAE,CAAC,CAAC;IACzD,KAAK;IACL,OAAO,EAAE,KAAK;CACf,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAC3B,KAA2B,EAC3B,OAAgB,EACb,EAAE;IACL,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,OAAO,IAAI,4BAA4B,CAAC,CAAC;IAC3D,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,CAA2B,KAAQ,EAAoB,EAAE;IAC5E,OAAO,KAAyB,CAAC;AACnC,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,CACrB,KAAuB,EACpB,EAAE;IACL,OAAO,KAAU,CAAC;AACpB,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,211 @@
+{
+  "name": "modestbench",
+  "version": "0.0.1",
+  "type": "module",
+  "description": "A full-ass benchmarking framework for Node.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/boneskull/modestbench.git"
+  },
+  "homepage": "https://github.com/boneskull/modestbench#readme",
+  "bugs": {
+    "url": "https://github.com/boneskull/modestbench/issues"
+  },
+  "author": "Christopher Hiller <boneskull@boneskull.com>",
+  "license": "BlueOak-1.0.0",
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "bin": {
+    "modestbench": "dist/cli/index.js"
+  },
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.cts",
+  "module": "./dist/index.js",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.cts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./cli": {
+      "types": "./dist/cli/index.d.cts",
+      "import": "./dist/cli/index.js",
+      "require": "./dist/cli/index.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "CHANGELOG.md",
+    "dist",
+    "src"
+  ],
+  "keywords": [
+    "benchmark",
+    "benchmarking",
+    "cli",
+    "csv",
+    "framework",
+    "json",
+    "measurement",
+    "metrics",
+    "optimization",
+    "perf",
+    "performance",
+    "profiling",
+    "speed",
+    "testing",
+    "tinybench"
+  ],
+  "scripts": {
+    "astro:build": "astro build --config astro.config.js",
+    "astro:dev": "astro dev --config astro.config.js",
+    "build": "run-s -sl build:compile build:schema",
+    "build:compile": "zshy",
+    "build:schema": "tsx scripts/generate-schema.ts",
+    "clean": "rm -rf dist",
+    "commitlint": "commitlint",
+    "dev": "zshy --watch",
+    "docs:build": "run-s docs:copy astro:build",
+    "docs:copy": "node scripts/copy-docs.js",
+    "docs:dev": "run-s docs:copy astro:dev",
+    "docs:preview": "astro preview --config astro.config.js",
+    "fix": "run-s -sl fix:*",
+    "fix:eslint": "eslint --fix .",
+    "fix:format": "prettier --write . && markdownlint-cli2 --fix \"**/*.md\"",
+    "fix:pkg": "npm pkg fix",
+    "lint": "run-p -sl --aggregate-output lint:*",
+    "lint-staged": "lint-staged",
+    "lint:eslint": "eslint .",
+    "lint:format": "prettier --check .",
+    "lint:knip": "knip",
+    "lint:markdown": "markdownlint-cli2 \"**/*.md\"",
+    "lint:spelling": "cspell .",
+    "lint:types": "tsc --noEmit",
+    "prepack": "run-s -s clean build",
+    "prepare": "husky; run-s -s build",
+    "pretest:base": "run-s -s build:compile",
+    "test": "run-s -s test:runtime test:types",
+    "test:base": "node --import tsx --test --test-reporter=spec",
+    "test:contract": "npm run test:base -- \"test/contract/**/*.test.ts\"",
+    "test:integration": "npm run test:base -- \"test/integration/**/*.test.ts\"",
+    "test:runtime": "npm run test:base -- \"test/**/*.test.ts\"",
+    "test:types": "tsd --files 'test-d/**/*.test-d.ts'",
+    "test:unit": "npm run test:base -- \"test/unit/**/*.test.ts\"",
+    "test:watch": "npm run test:base -- --watch"
+  },
+  "dependencies": {
+    "cosmiconfig": "9.0.0",
+    "cosmiconfig-typescript-loader": "6.2.0",
+    "glob": "11.0.3",
+    "tinybench": "5.0.1",
+    "yargs": "18.0.0",
+    "zod": "4.1.12"
+  },
+  "devDependencies": {
+    "@astrojs/starlight": "0.36.1",
+    "@commitlint/cli": "20.1.0",
+    "@commitlint/config-conventional": "20.0.0",
+    "@eslint/js": "9.38.0",
+    "@stylistic/eslint-plugin": "5.5.0",
+    "@types/node": "24.8.1",
+    "@types/wallabyjs": "0.0.15",
+    "@types/yargs": "17.0.33",
+    "astro": "5.14.8",
+    "bupkis": "0.11.1",
+    "cspell": "9.2.1",
+    "eslint": "9.38.0",
+    "eslint-plugin-jsonc": "2.21.0",
+    "eslint-plugin-perfectionist": "4.15.1",
+    "globals": "16.4.0",
+    "husky": "9.1.7",
+    "knip": "5.66.1",
+    "lint-staged": "16.2.4",
+    "markdownlint-cli2": "0.18.1",
+    "markdownlint-cli2-formatter-pretty": "0.0.8",
+    "npm-run-all2": "8.0.4",
+    "prettier": "3.6.2",
+    "prettier-plugin-jsdoc": "1.3.3",
+    "prettier-plugin-pkg": "0.21.2",
+    "prettier-plugin-sort-json": "4.1.1",
+    "tsd": "^0.33.0",
+    "tsx": "4.20.6",
+    "typescript": "5.9.3",
+    "typescript-eslint": "8.46.1",
+    "zshy": "0.4.4"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "knip": {
+    "ignoreDependencies": [
+      "@types/wallabyjs",
+      "markdownlint-cli2-formatter-pretty"
+    ],
+    "ignore": [
+      ".wallaby.js",
+      "**/*.cts",
+      "**/*.d.ts",
+      "site/media/**/*",
+      "worktrees/**/*",
+      "site/src/content/**/*",
+      "test-d/**/*"
+    ],
+    "tags": [
+      "-knipignore"
+    ],
+    "node": {
+      "entry": [
+        "scripts/**/*.ts",
+        "test/**/*.test.ts",
+        "src/index.ts",
+        "src/cli/index.ts",
+        "examples/**/*.ts",
+        "examples/**/*.js"
+      ]
+    }
+  },
+  "lint-staged": {
+    "package.json": [
+      "npm pkg fix"
+    ],
+    "*.{ts,cts,js,cjs,yml,json5}": [
+      "eslint --fix",
+      "prettier --write",
+      "cspell"
+    ],
+    "**/!(package-lock).json": [
+      "eslint --fix",
+      "prettier --write",
+      "cspell"
+    ],
+    "*.md": [
+      "markdownlint-cli2 --fix",
+      "prettier --write",
+      "cspell"
+    ],
+    "*.mdx": [
+      "prettier --write",
+      "cspell"
+    ]
+  },
+  "prettier": {
+    "jsdocCommentLineStrategy": "keep",
+    "jsdocPreferCodeFences": true,
+    "plugins": [
+      "prettier-plugin-jsdoc",
+      "prettier-plugin-pkg",
+      "prettier-plugin-sort-json"
+    ],
+    "singleQuote": true,
+    "tsdoc": true
+  },
+  "zshy": {
+    "exports": {
+      ".": "./src/index.ts",
+      "./cli": "./src/cli/index.ts",
+      "./package.json": "./package.json"
+    }
+  }
+}

package/src/bootstrap.ts

@@ -0,0 +1,35 @@
+/**
+ * Provides {@link bootstrap} function to initialize the ModestBench engine with
+ * default dependencies.
+ *
+ * @packageDocumentation
+ */
+
+import { ModestBenchConfigurationManager } from './config/manager.js';
+import { type ModestBenchEngine } from './core/engine.js';
+import { TinybenchEngine } from './core/engines/index.js';
+import { ModestBenchErrorManager } from './core/error-manager.js';
+import { BenchmarkFileLoader } from './core/loader.js';
+import { ModestBenchProgressManager } from './progress/manager.js';
+import { ModestBenchReporterRegistry } from './reporters/registry.js';
+import { FileHistoryStorage } from './storage/history.js';
+
+/**
+ * Initializes the ModestBench engine with default dependencies.
+ *
+ * Uses TinybenchEngine as the default concrete implementation.
+ *
+ * @returns {ModestBenchEngine} The initialized ModestBench engine.
+ * @public
+ */
+export const bootstrap = (): ModestBenchEngine => {
+  const engine = new TinybenchEngine({
+    configManager: new ModestBenchConfigurationManager(),
+    errorManager: new ModestBenchErrorManager(),
+    fileLoader: new BenchmarkFileLoader(),
+    historyStorage: new FileHistoryStorage(),
+    progressManager: new ModestBenchProgressManager(),
+    reporterRegistry: new ModestBenchReporterRegistry(),
+  });
+  return engine;
+};