create-bench 0.1.1 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +5 -1
- package/dist/index.js +46 -27
- package/dist/index.js.map +1 -1
- package/package.json +10 -11
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 ComputeSDK
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -20,7 +20,7 @@ The CLI creates a directory with the given project name and writes:
|
|
|
20
20
|
|
|
21
21
|
- `package.json` — with `@benchsdk/client`, `tsx`, and benchmark scripts
|
|
22
22
|
- `tsconfig.json` — basic TypeScript configuration
|
|
23
|
-
- `bench.ts` — a minimal benchmark worker using `
|
|
23
|
+
- `bench.ts` — a minimal benchmark worker using `createBenchmarkClient().runWorker()`
|
|
24
24
|
- `.env.example` — environment variables to configure the worker
|
|
25
25
|
- `README.md` — instructions for the new project
|
|
26
26
|
|
|
@@ -30,3 +30,7 @@ The CLI creates a directory with the given project name and writes:
|
|
|
30
30
|
2. `pnpm install`
|
|
31
31
|
3. Copy `.env.example` to `.env` and fill in the required values
|
|
32
32
|
4. `pnpm bench`
|
|
33
|
+
|
|
34
|
+
For a full guide to authoring benchmarks and runnable examples covering every capability, see [`WRITING_BENCHMARKS.md`](../../WRITING_BENCHMARKS.md) and the [`examples/`](../../examples) directory.
|
|
35
|
+
|
|
36
|
+
For the full `bench` CLI reference (auth, runs, results, artifacts, export), see the [benchsdk-cli skill](../../.agents/skills/benchsdk-cli/SKILL.md).
|
package/dist/index.js
CHANGED
|
@@ -5,19 +5,25 @@ import fs from "fs";
|
|
|
5
5
|
import path from "path";
|
|
6
6
|
import readline from "readline/promises";
|
|
7
7
|
import { fileURLToPath } from "url";
|
|
8
|
+
function toValidPackageName(input) {
|
|
9
|
+
const name = input.toLowerCase().replace(/\s+/g, "-").replace(/[^a-z0-9-]/g, "").replace(/^[^a-z]+/, "").replace(/-+/g, "-").replace(/^-+/, "");
|
|
10
|
+
return name || "bench";
|
|
11
|
+
}
|
|
8
12
|
function scaffold(targetDir, projectName) {
|
|
9
13
|
fs.mkdirSync(targetDir, { recursive: true });
|
|
10
14
|
const packageJson = {
|
|
11
|
-
name: projectName,
|
|
15
|
+
name: toValidPackageName(projectName),
|
|
12
16
|
version: "0.0.0",
|
|
13
17
|
private: true,
|
|
14
18
|
type: "module",
|
|
15
19
|
scripts: {
|
|
16
|
-
bench
|
|
20
|
+
// `bench run` loads the *.bench.ts module; run it under tsx so the
|
|
21
|
+
// TypeScript benchmark file can be imported without a build step.
|
|
22
|
+
bench: "tsx node_modules/@benchsdk/runner/dist/bin.js run bench.ts",
|
|
17
23
|
typecheck: "tsc --noEmit"
|
|
18
24
|
},
|
|
19
25
|
dependencies: {
|
|
20
|
-
"@benchsdk/
|
|
26
|
+
"@benchsdk/runner": "^0.2.0"
|
|
21
27
|
},
|
|
22
28
|
devDependencies: {
|
|
23
29
|
tsx: "^4.22.4",
|
|
@@ -47,37 +53,50 @@ function scaffold(targetDir, projectName) {
|
|
|
47
53
|
`${JSON.stringify(tsconfigJson, null, 2)}
|
|
48
54
|
`
|
|
49
55
|
);
|
|
50
|
-
const benchTs = `import {
|
|
56
|
+
const benchTs = `import { defineBenchmarkConfig, defineTask } from '@benchsdk/runner';
|
|
51
57
|
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
+
// A benchmark file declares two things and nothing else:
|
|
59
|
+
// - config: identity + orchestration knobs + the participants to run against
|
|
60
|
+
// - task: the workload for ONE iteration
|
|
61
|
+
// Run it with \`pnpm bench\` (CLI flags like --iterations / --concurrency
|
|
62
|
+
// override the config knobs). No imperative entrypoint needed.
|
|
63
|
+
export const config = defineBenchmarkConfig({
|
|
64
|
+
benchmarkSlug: process.env.BENCHMARK_SLUG ?? 'example',
|
|
65
|
+
benchmarkName: 'Example benchmark',
|
|
66
|
+
iterations: 10,
|
|
58
67
|
concurrency: 1,
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
68
|
+
participants: [{ name: 'local', requiredEnvVars: [] }],
|
|
69
|
+
display: {
|
|
70
|
+
metrics: [
|
|
71
|
+
{ key: 'durationMs', label: 'Duration', unit: 'ms', direction: 'lower-better' },
|
|
72
|
+
],
|
|
73
|
+
overview: { defaultMetric: 'compositeScore' },
|
|
74
|
+
},
|
|
75
|
+
scoring: {
|
|
76
|
+
metrics: [
|
|
77
|
+
{ key: 'durationMs', ceiling: 1000, weights: { median: 0.7, p95: 0.2, p99: 0.1 } },
|
|
78
|
+
],
|
|
79
|
+
},
|
|
71
80
|
});
|
|
72
81
|
|
|
73
|
-
|
|
82
|
+
export const task = defineTask(async ({ taskIndex, step, measure, log }) => {
|
|
83
|
+
log(\`running task \${taskIndex}\`);
|
|
84
|
+
// Declare named steps with \`step(...)\`; values flow between them via
|
|
85
|
+
// closures and each step is recorded on the platform with its own timing.
|
|
86
|
+
const start = Date.now();
|
|
87
|
+
await step('work', async () => {
|
|
88
|
+
// Replace with your benchmark logic.
|
|
89
|
+
await new Promise((resolve) => setTimeout(resolve, 100));
|
|
90
|
+
});
|
|
91
|
+
// \`measure(...)\` attaches metrics to the current step (or the task).
|
|
92
|
+
measure({ durationMs: Date.now() - start });
|
|
93
|
+
});
|
|
74
94
|
`;
|
|
75
95
|
fs.writeFileSync(path.join(targetDir, "bench.ts"), benchTs);
|
|
76
96
|
const envExample = `# Copy to .env and fill in your values
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
BENCHMARK_PARTICIPANT_SLUG=local
|
|
97
|
+
BENCHMARKS_PLATFORM_URL=
|
|
98
|
+
BENCHMARKS_PLATFORM_API_KEY=
|
|
99
|
+
BENCHMARK_SLUG=example
|
|
81
100
|
`;
|
|
82
101
|
fs.writeFileSync(path.join(targetDir, ".env.example"), envExample);
|
|
83
102
|
const readme = `# ${projectName}
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["#!/usr/bin/env node\nimport fs from 'node:fs';\nimport path from 'node:path';\nimport readline from 'node:readline/promises';\nimport { fileURLToPath } from 'node:url';\n\nfunction scaffold(targetDir: string, projectName: string): void {\n fs.mkdirSync(targetDir, { recursive: true });\n\n const packageJson = {\n name: projectName,\n version: '0.0.0',\n private: true,\n type: 'module',\n scripts: {\n bench: 'tsx bench.ts',\n typecheck: 'tsc --noEmit',\n },\n dependencies: {\n '@benchsdk/
|
|
1
|
+
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["#!/usr/bin/env node\nimport fs from 'node:fs';\nimport path from 'node:path';\nimport readline from 'node:readline/promises';\nimport { fileURLToPath } from 'node:url';\n\nfunction toValidPackageName(input: string): string {\n const name = input\n .toLowerCase()\n .replace(/\\s+/g, '-')\n .replace(/[^a-z0-9-]/g, '')\n .replace(/^[^a-z]+/, '')\n .replace(/-+/g, '-')\n .replace(/^-+/, '');\n return name || 'bench';\n}\n\nfunction scaffold(targetDir: string, projectName: string): void {\n fs.mkdirSync(targetDir, { recursive: true });\n\n const packageJson = {\n name: toValidPackageName(projectName),\n version: '0.0.0',\n private: true,\n type: 'module',\n scripts: {\n // `bench run` loads the *.bench.ts module; run it under tsx so the\n // TypeScript benchmark file can be imported without a build step.\n bench: 'tsx node_modules/@benchsdk/runner/dist/bin.js run bench.ts',\n typecheck: 'tsc --noEmit',\n },\n dependencies: {\n '@benchsdk/runner': '^0.2.0',\n },\n devDependencies: {\n tsx: '^4.22.4',\n typescript: '^5.0.0',\n },\n };\n\n fs.writeFileSync(\n path.join(targetDir, 'package.json'),\n `${JSON.stringify(packageJson, null, 2)}\\n`,\n );\n\n const tsconfigJson = {\n compilerOptions: {\n target: 'ES2022',\n module: 'ESNext',\n moduleResolution: 'bundler',\n strict: true,\n esModuleInterop: true,\n skipLibCheck: true,\n resolveJsonModule: true,\n noEmit: true,\n },\n include: ['**/*.ts'],\n };\n\n fs.writeFileSync(\n path.join(targetDir, 'tsconfig.json'),\n `${JSON.stringify(tsconfigJson, null, 2)}\\n`,\n );\n\n const benchTs = `import { defineBenchmarkConfig, defineTask } from '@benchsdk/runner';\n\n// A benchmark file declares two things and nothing else:\n// - config: identity + orchestration knobs + the participants to run against\n// - task: the workload for ONE iteration\n// Run it with \\`pnpm bench\\` (CLI flags like --iterations / --concurrency\n// override the config knobs). No imperative entrypoint needed.\nexport const config = defineBenchmarkConfig({\n benchmarkSlug: process.env.BENCHMARK_SLUG ?? 'example',\n benchmarkName: 'Example benchmark',\n iterations: 10,\n concurrency: 1,\n participants: [{ name: 'local', requiredEnvVars: [] }],\n display: {\n metrics: [\n { key: 'durationMs', label: 'Duration', unit: 'ms', direction: 'lower-better' },\n ],\n overview: { defaultMetric: 'compositeScore' },\n },\n scoring: {\n metrics: [\n { key: 'durationMs', ceiling: 1000, weights: { median: 0.7, p95: 0.2, p99: 0.1 } },\n ],\n },\n});\n\nexport const task = defineTask(async ({ taskIndex, step, measure, log }) => {\n log(\\`running task \\${taskIndex}\\`);\n // Declare named steps with \\`step(...)\\`; values flow between them via\n // closures and each step is recorded on the platform with its own timing.\n const start = Date.now();\n await step('work', async () => {\n // Replace with your benchmark logic.\n await new Promise((resolve) => setTimeout(resolve, 100));\n });\n // \\`measure(...)\\` attaches metrics to the current step (or the task).\n measure({ durationMs: Date.now() - start });\n});\n`;\n\n fs.writeFileSync(path.join(targetDir, 'bench.ts'), benchTs);\n\n const envExample = `# Copy to .env and fill in your values\nBENCHMARKS_PLATFORM_URL=\nBENCHMARKS_PLATFORM_API_KEY=\nBENCHMARK_SLUG=example\n`;\n\n fs.writeFileSync(path.join(targetDir, '.env.example'), envExample);\n\n const readme = `# ${projectName}\n\nThis project was scaffolded by [\\`create-bench\\`](https://github.com/computesdk/benchmarks/tree/master/packages/create-bench).\n\n## Getting started\n\n1. Install dependencies:\n\n \\`\\`\\`sh\n pnpm install\n \\`\\`\\`\n\n2. Copy \\`.env.example\\` to \\`.env\\` and fill in the required values.\n\n3. Run the benchmark worker:\n\n \\`\\`\\`sh\n pnpm bench\n \\`\\`\\`\n`;\n\n fs.writeFileSync(path.join(targetDir, 'README.md'), readme);\n}\n\nasync function askProjectName(): Promise<string | undefined> {\n const rl = readline.createInterface({\n input: process.stdin,\n output: process.stdout,\n });\n\n try {\n const answer = await rl.question('Project name: ');\n return answer.trim() || undefined;\n } finally {\n rl.close();\n }\n}\n\nexport async function createBench(projectName?: string): Promise<void> {\n const resolvedName = projectName ?? (await askProjectName());\n\n if (!resolvedName) {\n throw new Error('A project name is required.');\n }\n\n const targetDir = path.isAbsolute(resolvedName)\n ? resolvedName\n : path.resolve(process.cwd(), resolvedName);\n const packageName = path.basename(targetDir);\n\n if (fs.existsSync(targetDir) && fs.readdirSync(targetDir).length > 0) {\n throw new Error(`Directory ${targetDir} is not empty.`);\n }\n\n scaffold(targetDir, packageName);\n\n console.log(`Created ${packageName} at ${targetDir}`);\n console.log('Next steps:');\n console.log(` cd ${path.relative(process.cwd(), targetDir) || packageName}`);\n console.log(' pnpm install');\n console.log(' cp .env.example .env');\n console.log(' pnpm bench');\n}\n\nasync function main(): Promise<void> {\n const projectName = process.argv[2];\n await createBench(projectName);\n}\n\nif (process.argv[1] === fileURLToPath(import.meta.url)) {\n main().catch((err) => {\n console.error(err);\n process.exit(1);\n });\n}\n"],"mappings":";;;AACA,OAAO,QAAQ;AACf,OAAO,UAAU;AACjB,OAAO,cAAc;AACrB,SAAS,qBAAqB;AAE9B,SAAS,mBAAmB,OAAuB;AACjD,QAAM,OAAO,MACV,YAAY,EACZ,QAAQ,QAAQ,GAAG,EACnB,QAAQ,eAAe,EAAE,EACzB,QAAQ,YAAY,EAAE,EACtB,QAAQ,OAAO,GAAG,EAClB,QAAQ,OAAO,EAAE;AACpB,SAAO,QAAQ;AACjB;AAEA,SAAS,SAAS,WAAmB,aAA2B;AAC9D,KAAG,UAAU,WAAW,EAAE,WAAW,KAAK,CAAC;AAE3C,QAAM,cAAc;AAAA,IAClB,MAAM,mBAAmB,WAAW;AAAA,IACpC,SAAS;AAAA,IACT,SAAS;AAAA,IACT,MAAM;AAAA,IACN,SAAS;AAAA;AAAA;AAAA,MAGP,OAAO;AAAA,MACP,WAAW;AAAA,IACb;AAAA,IACA,cAAc;AAAA,MACZ,oBAAoB;AAAA,IACtB;AAAA,IACA,iBAAiB;AAAA,MACf,KAAK;AAAA,MACL,YAAY;AAAA,IACd;AAAA,EACF;AAEA,KAAG;AAAA,IACD,KAAK,KAAK,WAAW,cAAc;AAAA,IACnC,GAAG,KAAK,UAAU,aAAa,MAAM,CAAC,CAAC;AAAA;AAAA,EACzC;AAEA,QAAM,eAAe;AAAA,IACnB,iBAAiB;AAAA,MACf,QAAQ;AAAA,MACR,QAAQ;AAAA,MACR,kBAAkB;AAAA,MAClB,QAAQ;AAAA,MACR,iBAAiB;AAAA,MACjB,cAAc;AAAA,MACd,mBAAmB;AAAA,MACnB,QAAQ;AAAA,IACV;AAAA,IACA,SAAS,CAAC,SAAS;AAAA,EACrB;AAEA,KAAG;AAAA,IACD,KAAK,KAAK,WAAW,eAAe;AAAA,IACpC,GAAG,KAAK,UAAU,cAAc,MAAM,CAAC,CAAC;AAAA;AAAA,EAC1C;AAEA,QAAM,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAwChB,KAAG,cAAc,KAAK,KAAK,WAAW,UAAU,GAAG,OAAO;AAE1D,QAAM,aAAa;AAAA;AAAA;AAAA;AAAA;AAMnB,KAAG,cAAc,KAAK,KAAK,WAAW,cAAc,GAAG,UAAU;AAEjE,QAAM,SAAS,KAAK,WAAW;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAqB/B,KAAG,cAAc,KAAK,KAAK,WAAW,WAAW,GAAG,MAAM;AAC5D;AAEA,eAAe,iBAA8C;AAC3D,QAAM,KAAK,SAAS,gBAAgB;AAAA,IAClC,OAAO,QAAQ;AAAA,IACf,QAAQ,QAAQ;AAAA,EAClB,CAAC;AAED,MAAI;AACF,UAAM,SAAS,MAAM,GAAG,SAAS,gBAAgB;AACjD,WAAO,OAAO,KAAK,KAAK;AAAA,EAC1B,UAAE;AACA,OAAG,MAAM;AAAA,EACX;AACF;AAEA,eAAsB,YAAY,aAAqC;AACrE,QAAM,eAAe,eAAgB,MAAM,eAAe;AAE1D,MAAI,CAAC,cAAc;AACjB,UAAM,IAAI,MAAM,6BAA6B;AAAA,EAC/C;AAEA,QAAM,YAAY,KAAK,WAAW,YAAY,IAC1C,eACA,KAAK,QAAQ,QAAQ,IAAI,GAAG,YAAY;AAC5C,QAAM,cAAc,KAAK,SAAS,SAAS;AAE3C,MAAI,GAAG,WAAW,SAAS,KAAK,GAAG,YAAY,SAAS,EAAE,SAAS,GAAG;AACpE,UAAM,IAAI,MAAM,aAAa,SAAS,gBAAgB;AAAA,EACxD;AAEA,WAAS,WAAW,WAAW;AAE/B,UAAQ,IAAI,WAAW,WAAW,OAAO,SAAS,EAAE;AACpD,UAAQ,IAAI,aAAa;AACzB,UAAQ,IAAI,QAAQ,KAAK,SAAS,QAAQ,IAAI,GAAG,SAAS,KAAK,WAAW,EAAE;AAC5E,UAAQ,IAAI,gBAAgB;AAC5B,UAAQ,IAAI,wBAAwB;AACpC,UAAQ,IAAI,cAAc;AAC5B;AAEA,eAAe,OAAsB;AACnC,QAAM,cAAc,QAAQ,KAAK,CAAC;AAClC,QAAM,YAAY,WAAW;AAC/B;AAEA,IAAI,QAAQ,KAAK,CAAC,MAAM,cAAc,YAAY,GAAG,GAAG;AACtD,OAAK,EAAE,MAAM,CAAC,QAAQ;AACpB,YAAQ,MAAM,GAAG;AACjB,YAAQ,KAAK,CAAC;AAAA,EAChB,CAAC;AACH;","names":[]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "create-bench",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2",
|
|
4
4
|
"private": false,
|
|
5
5
|
"type": "module",
|
|
6
6
|
"description": "Scaffold a new ComputeSDK benchmark project with @benchsdk/client",
|
|
@@ -13,15 +13,6 @@
|
|
|
13
13
|
"dist",
|
|
14
14
|
"README.md"
|
|
15
15
|
],
|
|
16
|
-
"scripts": {
|
|
17
|
-
"build": "tsup",
|
|
18
|
-
"clean": "rimraf dist",
|
|
19
|
-
"dev": "tsup --watch",
|
|
20
|
-
"prepare": "tsup",
|
|
21
|
-
"pretest": "tsup",
|
|
22
|
-
"test": "vitest run",
|
|
23
|
-
"typecheck": "tsc --noEmit"
|
|
24
|
-
},
|
|
25
16
|
"keywords": [
|
|
26
17
|
"create",
|
|
27
18
|
"scaffold",
|
|
@@ -49,5 +40,13 @@
|
|
|
49
40
|
"tsup": "^8.0.0",
|
|
50
41
|
"typescript": "^5.0.0",
|
|
51
42
|
"vitest": "^1.0.0"
|
|
43
|
+
},
|
|
44
|
+
"scripts": {
|
|
45
|
+
"build": "tsup",
|
|
46
|
+
"clean": "rimraf dist",
|
|
47
|
+
"dev": "tsup --watch",
|
|
48
|
+
"pretest": "tsup",
|
|
49
|
+
"test": "vitest run",
|
|
50
|
+
"typecheck": "tsc --noEmit"
|
|
52
51
|
}
|
|
53
|
-
}
|
|
52
|
+
}
|