feat: add benchmarks (#35)

* add benchmarks

* add benchmarks to ci

* using process.execPath

Author: AmirSa12

.github/workflows/ci.yml

@@ -62,3 +62,27 @@ jobs:
 
       - name: Type-check
         run: pnpm type-check
+
+  benchmark:
+    name: Benchmarks
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install pnpm
+        uses: pnpm/[email protected]
+
+      - name: Set node version to 20
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org/
+          cache: pnpm
+
+      - name: Install deps
+        run: pnpm install
+
+      - name: Run benchmarks
+        run: pnpm benchmark

benchmarks/completion.bench.ts

@@ -0,0 +1,62 @@
+import { Bench } from 'tinybench';
+import { promisify } from 'node:util';
+import { exec as execCb } from 'node:child_process';
+
+const exec = promisify(execCb);
+
+const bench = new Bench({ time: 2000 });
+
+const cmdPrefix = `${process.execPath} ./dist/examples/demo.t.js complete --`;
+
+async function run(cmd: string) {
+  await exec(cmd);
+}
+
+bench.add('command completion', async () => {
+  await run(`${cmdPrefix} d`);
+});
+
+bench.add('option completion', async () => {
+  await run(`${cmdPrefix} dev --p`);
+});
+
+bench.add('option value completion', async () => {
+  await run(`${cmdPrefix} dev --port ""`);
+});
+
+bench.add('config value completion', async () => {
+  await run(`${cmdPrefix} --config ""`);
+});
+
+bench.add('no match', async () => {
+  await run(`${cmdPrefix} xyz`);
+});
+
+async function runBenchmarks() {
+  await bench.run();
+
+  console.table(
+    bench.tasks.map((task) => {
+      const hz = task.result?.hz;
+      const derivedMs =
+        typeof hz === 'number' && hz > 0 ? 1000 / hz : undefined;
+      const mean = task.result?.mean;
+      return {
+        name: task.name,
+        'ops/sec': hz ? Math.round(hz).toLocaleString() : 'N/A',
+        'avg (ms)':
+          derivedMs !== undefined
+            ? derivedMs.toFixed(3)
+            : mean !== undefined
+              ? (mean * 1000).toFixed(3)
+              : 'N/A',
+      };
+    })
+  );
+}
+
+if (process.argv[1]?.endsWith('completion.bench.ts')) {
+  runBenchmarks().catch(console.error);
+}
+
+export { runBenchmarks };

package.json

@@ -15,7 +15,7 @@
     "build": "tsdown",
     "prepare": "pnpm build",
     "lint": "eslint src \"./*.ts\"",
-    "test-cli": "tsx bin/cli.ts"
+    "benchmark": "tsx benchmarks/completion.bench.ts"
   },
   "files": [
     "dist"
@@ -30,6 +30,7 @@
     "commander": "^13.1.0",
     "eslint-config-prettier": "^10.0.1",
     "prettier": "^3.5.2",
+    "tinybench": "^4.0.1",
     "tsdown": "^0.9.7",
     "tsx": "^4.19.1",
     "typescript": "^5.7.3",

pnpm-lock.yaml

@@ -7,6 +7,10 @@ export default defineConfig({
     'src/cac.ts',
     'src/commander.ts',
     'bin/cli.ts',
+    'examples/demo.t.ts',
+    'examples/demo.cac.ts',
+    'examples/demo.citty.ts',
+    'examples/demo.commander.ts',
   ],
   format: ['esm'],
   dts: true,