create-bench 0.1.1

package/README.md

@@ -0,0 +1,32 @@
+# create-bench
+
+Scaffold a new ComputeSDK benchmark project that uses [`@benchsdk/client`](https://github.com/computesdk/benchmarks/tree/master/packages/benchsdk).
+
+## Usage
+
+```sh
+npx create-bench my-benchmark
+```
+
+Or with npm:
+
+```sh
+npm create bench my-benchmark
+```
+
+## What gets created
+
+The CLI creates a directory with the given project name and writes:
+
+- `package.json` — with `@benchsdk/client`, `tsx`, and benchmark scripts
+- `tsconfig.json` — basic TypeScript configuration
+- `bench.ts` — a minimal benchmark worker using `defineWorker`, `defineTask`, and `defineStep`
+- `.env.example` — environment variables to configure the worker
+- `README.md` — instructions for the new project
+
+## Next steps
+
+1. `cd my-benchmark`
+2. `pnpm install`
+3. Copy `.env.example` to `.env` and fill in the required values
+4. `pnpm bench`

package/dist/index.js

@@ -0,0 +1,148 @@
+#!/usr/bin/env node
+
+// src/index.ts
+import fs from "fs";
+import path from "path";
+import readline from "readline/promises";
+import { fileURLToPath } from "url";
+function scaffold(targetDir, projectName) {
+  fs.mkdirSync(targetDir, { recursive: true });
+  const packageJson = {
+    name: projectName,
+    version: "0.0.0",
+    private: true,
+    type: "module",
+    scripts: {
+      bench: "tsx bench.ts",
+      typecheck: "tsc --noEmit"
+    },
+    dependencies: {
+      "@benchsdk/client": "^0.2.0"
+    },
+    devDependencies: {
+      tsx: "^4.22.4",
+      typescript: "^5.0.0"
+    }
+  };
+  fs.writeFileSync(
+    path.join(targetDir, "package.json"),
+    `${JSON.stringify(packageJson, null, 2)}
+`
+  );
+  const tsconfigJson = {
+    compilerOptions: {
+      target: "ES2022",
+      module: "ESNext",
+      moduleResolution: "bundler",
+      strict: true,
+      esModuleInterop: true,
+      skipLibCheck: true,
+      resolveJsonModule: true,
+      noEmit: true
+    },
+    include: ["**/*.ts"]
+  };
+  fs.writeFileSync(
+    path.join(targetDir, "tsconfig.json"),
+    `${JSON.stringify(tsconfigJson, null, 2)}
+`
+  );
+  const benchTs = `import { defineStep, defineTask, defineWorker } from '@benchsdk/client';
+
+const worker = defineWorker({
+  benchmarkSlug: process.env.BENCHMARK_SLUG ?? 'scale',
+  runId: process.env.BENCHMARK_RUN_ID!,
+  participantSlug: process.env.BENCHMARK_PARTICIPANT_SLUG ?? 'local',
+  processKind: 'container',
+  processKey: process.env.HOSTNAME ?? 'local',
+  concurrency: 1,
+  task: defineTask('example.lifecycle', [
+    defineStep('start', async ({ assignment }) => {
+      console.log(\`Worker \${assignment.workerId} starting task \${assignment.taskRange.start}\`);
+    }),
+    defineStep('work', async () => {
+      // Replace with your benchmark logic
+      await new Promise((resolve) => setTimeout(resolve, 100));
+    }),
+    defineStep('done', async () => {
+      console.log('Task complete');
+    }),
+  ]),
+});
+
+await worker.run();
+`;
+  fs.writeFileSync(path.join(targetDir, "bench.ts"), benchTs);
+  const envExample = `# Copy to .env and fill in your values
+COMPUTESDK_ADMIN_API_KEY=
+BENCHMARK_SLUG=scale
+BENCHMARK_RUN_ID=
+BENCHMARK_PARTICIPANT_SLUG=local
+`;
+  fs.writeFileSync(path.join(targetDir, ".env.example"), envExample);
+  const readme = `# ${projectName}
+
+This project was scaffolded by [\`create-bench\`](https://github.com/computesdk/benchmarks/tree/master/packages/create-bench).
+
+## Getting started
+
+1. Install dependencies:
+
+   \`\`\`sh
+   pnpm install
+   \`\`\`
+
+2. Copy \`.env.example\` to \`.env\` and fill in the required values.
+
+3. Run the benchmark worker:
+
+   \`\`\`sh
+   pnpm bench
+   \`\`\`
+`;
+  fs.writeFileSync(path.join(targetDir, "README.md"), readme);
+}
+async function askProjectName() {
+  const rl = readline.createInterface({
+    input: process.stdin,
+    output: process.stdout
+  });
+  try {
+    const answer = await rl.question("Project name: ");
+    return answer.trim() || void 0;
+  } finally {
+    rl.close();
+  }
+}
+async function createBench(projectName) {
+  const resolvedName = projectName ?? await askProjectName();
+  if (!resolvedName) {
+    throw new Error("A project name is required.");
+  }
+  const targetDir = path.isAbsolute(resolvedName) ? resolvedName : path.resolve(process.cwd(), resolvedName);
+  const packageName = path.basename(targetDir);
+  if (fs.existsSync(targetDir) && fs.readdirSync(targetDir).length > 0) {
+    throw new Error(`Directory ${targetDir} is not empty.`);
+  }
+  scaffold(targetDir, packageName);
+  console.log(`Created ${packageName} at ${targetDir}`);
+  console.log("Next steps:");
+  console.log(`  cd ${path.relative(process.cwd(), targetDir) || packageName}`);
+  console.log("  pnpm install");
+  console.log("  cp .env.example .env");
+  console.log("  pnpm bench");
+}
+async function main() {
+  const projectName = process.argv[2];
+  await createBench(projectName);
+}
+if (process.argv[1] === fileURLToPath(import.meta.url)) {
+  main().catch((err) => {
+    console.error(err);
+    process.exit(1);
+  });
+}
+export {
+  createBench
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +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/client': '^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 { defineStep, defineTask, defineWorker } from '@benchsdk/client';\n\nconst worker = defineWorker({\n  benchmarkSlug: process.env.BENCHMARK_SLUG ?? 'scale',\n  runId: process.env.BENCHMARK_RUN_ID!,\n  participantSlug: process.env.BENCHMARK_PARTICIPANT_SLUG ?? 'local',\n  processKind: 'container',\n  processKey: process.env.HOSTNAME ?? 'local',\n  concurrency: 1,\n  task: defineTask('example.lifecycle', [\n    defineStep('start', async ({ assignment }) => {\n      console.log(\\`Worker \\${assignment.workerId} starting task \\${assignment.taskRange.start}\\`);\n    }),\n    defineStep('work', async () => {\n      // Replace with your benchmark logic\n      await new Promise((resolve) => setTimeout(resolve, 100));\n    }),\n    defineStep('done', async () => {\n      console.log('Task complete');\n    }),\n  ]),\n});\n\nawait worker.run();\n`;\n\n  fs.writeFileSync(path.join(targetDir, 'bench.ts'), benchTs);\n\n  const envExample = `# Copy to .env and fill in your values\nCOMPUTESDK_ADMIN_API_KEY=\nBENCHMARK_SLUG=scale\nBENCHMARK_RUN_ID=\nBENCHMARK_PARTICIPANT_SLUG=local\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,SAAS,WAAmB,aAA2B;AAC9D,KAAG,UAAU,WAAW,EAAE,WAAW,KAAK,CAAC;AAE3C,QAAM,cAAc;AAAA,IAClB,MAAM;AAAA,IACN,SAAS;AAAA,IACT,SAAS;AAAA,IACT,MAAM;AAAA,IACN,SAAS;AAAA,MACP,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;AA0BhB,KAAG,cAAc,KAAK,KAAK,WAAW,UAAU,GAAG,OAAO;AAE1D,QAAM,aAAa;AAAA;AAAA;AAAA;AAAA;AAAA;AAOnB,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

@@ -0,0 +1,53 @@
+{
+  "name": "create-bench",
+  "version": "0.1.1",
+  "private": false,
+  "type": "module",
+  "description": "Scaffold a new ComputeSDK benchmark project with @benchsdk/client",
+  "author": "Garrison",
+  "license": "MIT",
+  "bin": {
+    "create-bench": "./dist/index.js"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "clean": "rimraf dist",
+    "dev": "tsup --watch",
+    "prepare": "tsup",
+    "pretest": "tsup",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit"
+  },
+  "keywords": [
+    "create",
+    "scaffold",
+    "benchmark",
+    "computesdk",
+    "benchsdk",
+    "cli"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/computesdk/benchmarks.git",
+    "directory": "packages/create-bench"
+  },
+  "homepage": "https://www.computesdk.com",
+  "bugs": {
+    "url": "https://github.com/computesdk/benchmarks/issues"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "rimraf": "^5.0.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.0.0",
+    "vitest": "^1.0.0"
+  }
+}