feat: add performance benchmark suite for scan fixtures

.github/workflows/ci.yml

@@ -23,6 +23,7 @@ jobs:
       - run: npm run typecheck:tests
       - run: npm test
       - run: npm run build
+      - run: npm run benchmark:ci
       - run: node dist/cli/index.js scan examples/react --min-severity info --format markdown --output debtlens-react-report.md
       - run: node dist/cli/index.js scan examples/react-native --min-severity info --format markdown --output debtlens-react-native-report.md
       - run: node dist/cli/index.js scan examples/next --min-severity info --format markdown --output debtlens-next-report.md

README.md

@@ -74,6 +74,26 @@ Built-in rules are grouped into a **core** pack (any TS/JS project) and a **reac
 | `effect-complexity` | react | Long or overloaded React effect hooks | Medium |
 | `prop-drilling` | react | Components that forward many props to children | Medium |
 
+## Performance benchmarks
+
+Synthetic fixtures under `tests/benchmarks/fixtures/` exercise small (5 files), medium (30), and large (100) scan sizes.
+
+```bash
+npm run build
+npm run benchmark        # all fixtures + local budget check
+npm run benchmark:ci     # small fixture only (used in CI)
+```
+
+Local budgets (generous; CI enforces small `< 5000ms` only):
+
+| Fixture | Files | Budget |
+| --- | ---: | ---: |
+| small | 5 | 5s |
+| medium | 30 | 30s |
+| large | 100 | 120s |
+
+Per-rule timing is available via `--profile` in [PR #62](https://github.com/ColumbusLabs/DebtLens/pull/62) once merged.
+
 ## Install
 
 ```bash

package.json

@@ -31,6 +31,8 @@
     "typecheck": "tsc -p tsconfig.json --noEmit",
     "typecheck:tests": "tsc -p tsconfig.tests.json",
     "schema:generate": "node --import tsx scripts/generate-schema.mjs",
+    "benchmark": "node scripts/benchmark.mjs",
+    "benchmark:ci": "node scripts/benchmark.mjs --small-only",
     "prepublishOnly": "npm run build"
   },
   "keywords": [

scripts/benchmark.mjs

@@ -0,0 +1,48 @@
+import { spawnSync } from "node:child_process";
+import { readdirSync } from "node:fs";
+import { dirname, join, resolve } from "node:path";
+import { fileURLToPath } from "node:url";
+
+const repoRoot = resolve(dirname(fileURLToPath(import.meta.url)), "..");
+const cliEntrypoint = join(repoRoot, "src", "cli", "index.ts");
+const fixturesRoot = join(repoRoot, "tests", "benchmarks", "fixtures");
+const filter = process.argv.includes("--small-only") ? ["small"] : readdirSync(fixturesRoot).sort();
+const budgets = { small: 5000, medium: 30000, large: 120000 };
+let failed = false;
+
+console.log("DebtLens benchmark fixtures\n");
+
+for (const name of filter) {
+  const target = join(fixturesRoot, name);
+  const result = spawnSync(process.execPath, [
+    "--import",
+    "tsx",
+    cliEntrypoint,
+    "scan",
+    target,
+    "--format",
+    "json",
+    "--min-severity",
+    "info",
+  ], {
+    cwd: repoRoot,
+    encoding: "utf8",
+  });
+
+  if (result.status !== 0) {
+    process.stderr.write(result.stderr || result.stdout);
+    failed = true;
+    continue;
+  }
+
+  const parsed = JSON.parse(result.stdout);
+  const elapsedMs = parsed.summary.elapsedMs;
+  const filesScanned = parsed.summary.filesScanned;
+  const budget = budgets[name];
+  const withinBudget = budget === undefined || elapsedMs < budget;
+
+  console.log(`${name}: ${elapsedMs}ms (${filesScanned} files)${budget !== undefined ? ` budget < ${budget}ms` : ""} ${withinBudget ? "OK" : "FAIL"}`);
+  if (!withinBudget) failed = true;
+}
+
+if (failed) process.exit(1);

tests/benchmarks/fixtures/large/src/module0.ts

@@ -0,0 +1 @@
+export function fn0() { return 0; }

tests/benchmarks/fixtures/large/src/module1.ts

@@ -0,0 +1 @@
+export function fn1() { return 1; }

tests/benchmarks/fixtures/large/src/module10.ts

@@ -0,0 +1 @@
+export function fn10() { return 10; }

tests/benchmarks/fixtures/large/src/module11.ts

@@ -0,0 +1 @@
+export function fn11() { return 11; }

tests/benchmarks/fixtures/large/src/module12.ts

@@ -0,0 +1 @@
+export function fn12() { return 12; }

tests/benchmarks/fixtures/large/src/module13.ts

@@ -0,0 +1 @@
+export function fn13() { return 13; }

tests/benchmarks/fixtures/large/src/module14.ts

@@ -0,0 +1 @@
+export function fn14() { return 14; }

tests/benchmarks/fixtures/large/src/module15.ts

@@ -0,0 +1 @@
+export function fn15() { return 15; }

tests/benchmarks/fixtures/large/src/module16.ts

@@ -0,0 +1 @@
+export function fn16() { return 16; }

tests/benchmarks/fixtures/large/src/module17.ts

@@ -0,0 +1 @@
+export function fn17() { return 17; }

tests/benchmarks/fixtures/large/src/module18.ts

@@ -0,0 +1 @@
+export function fn18() { return 18; }

tests/benchmarks/fixtures/large/src/module19.ts

@@ -0,0 +1 @@
+export function fn19() { return 19; }

tests/benchmarks/fixtures/large/src/module2.ts

@@ -0,0 +1 @@
+export function fn2() { return 2; }

tests/benchmarks/fixtures/large/src/module20.ts

@@ -0,0 +1 @@
+export function fn20() { return 20; }

tests/benchmarks/fixtures/large/src/module21.ts

@@ -0,0 +1 @@
+export function fn21() { return 21; }

tests/benchmarks/fixtures/large/src/module22.ts

@@ -0,0 +1 @@
+export function fn22() { return 22; }

tests/benchmarks/fixtures/large/src/module23.ts

@@ -0,0 +1 @@
+export function fn23() { return 23; }

tests/benchmarks/fixtures/large/src/module24.ts

@@ -0,0 +1 @@
+export function fn24() { return 24; }

tests/benchmarks/fixtures/large/src/module25.ts

@@ -0,0 +1 @@
+export function fn25() { return 25; }

tests/benchmarks/fixtures/large/src/module26.ts

@@ -0,0 +1 @@
+export function fn26() { return 26; }

tests/benchmarks/fixtures/large/src/module27.ts

@@ -0,0 +1 @@
+export function fn27() { return 27; }

tests/benchmarks/fixtures/large/src/module28.ts

@@ -0,0 +1 @@
+export function fn28() { return 28; }

tests/benchmarks/fixtures/large/src/module29.ts

@@ -0,0 +1 @@
+export function fn29() { return 29; }

tests/benchmarks/fixtures/large/src/module3.ts

@@ -0,0 +1 @@
+export function fn3() { return 3; }

tests/benchmarks/fixtures/large/src/module30.ts

@@ -0,0 +1 @@
+export function fn30() { return 30; }

tests/benchmarks/fixtures/large/src/module31.ts

@@ -0,0 +1 @@
+export function fn31() { return 31; }

tests/benchmarks/fixtures/large/src/module32.ts

@@ -0,0 +1 @@
+export function fn32() { return 32; }

tests/benchmarks/fixtures/large/src/module33.ts

@@ -0,0 +1 @@
+export function fn33() { return 33; }

tests/benchmarks/fixtures/large/src/module34.ts

@@ -0,0 +1 @@
+export function fn34() { return 34; }

tests/benchmarks/fixtures/large/src/module35.ts

@@ -0,0 +1 @@
+export function fn35() { return 35; }

tests/benchmarks/fixtures/large/src/module36.ts

@@ -0,0 +1 @@
+export function fn36() { return 36; }

tests/benchmarks/fixtures/large/src/module37.ts

@@ -0,0 +1 @@
+export function fn37() { return 37; }

tests/benchmarks/fixtures/large/src/module38.ts

@@ -0,0 +1 @@
+export function fn38() { return 38; }

tests/benchmarks/fixtures/large/src/module39.ts

@@ -0,0 +1 @@
+export function fn39() { return 39; }

tests/benchmarks/fixtures/large/src/module4.ts

@@ -0,0 +1 @@
+export function fn4() { return 4; }

tests/benchmarks/fixtures/large/src/module40.ts

@@ -0,0 +1 @@
+export function fn40() { return 40; }

tests/benchmarks/fixtures/large/src/module41.ts

@@ -0,0 +1 @@
+export function fn41() { return 41; }

tests/benchmarks/fixtures/large/src/module42.ts

@@ -0,0 +1 @@
+export function fn42() { return 42; }

tests/benchmarks/fixtures/large/src/module43.ts

@@ -0,0 +1 @@
+export function fn43() { return 43; }

tests/benchmarks/fixtures/large/src/module44.ts

@@ -0,0 +1 @@
+export function fn44() { return 44; }

tests/benchmarks/fixtures/large/src/module45.ts

@@ -0,0 +1 @@
+export function fn45() { return 45; }

tests/benchmarks/fixtures/large/src/module46.ts

@@ -0,0 +1 @@
+export function fn46() { return 46; }

tests/benchmarks/fixtures/large/src/module47.ts

@@ -0,0 +1 @@
+export function fn47() { return 47; }

tests/benchmarks/fixtures/large/src/module48.ts

@@ -0,0 +1 @@
+export function fn48() { return 48; }

tests/benchmarks/fixtures/large/src/module49.ts

@@ -0,0 +1 @@
+export function fn49() { return 49; }

tests/benchmarks/fixtures/large/src/module5.ts

@@ -0,0 +1 @@
+export function fn5() { return 5; }

tests/benchmarks/fixtures/large/src/module50.ts

@@ -0,0 +1 @@
+export function fn50() { return 50; }

tests/benchmarks/fixtures/large/src/module51.ts

@@ -0,0 +1 @@
+export function fn51() { return 51; }

tests/benchmarks/fixtures/large/src/module52.ts

@@ -0,0 +1 @@
+export function fn52() { return 52; }

tests/benchmarks/fixtures/large/src/module53.ts

@@ -0,0 +1 @@
+export function fn53() { return 53; }

tests/benchmarks/fixtures/large/src/module54.ts

@@ -0,0 +1 @@
+export function fn54() { return 54; }

tests/benchmarks/fixtures/large/src/module55.ts

@@ -0,0 +1 @@
+export function fn55() { return 55; }

tests/benchmarks/fixtures/large/src/module56.ts

@@ -0,0 +1 @@
+export function fn56() { return 56; }

tests/benchmarks/fixtures/large/src/module57.ts

@@ -0,0 +1 @@
+export function fn57() { return 57; }

tests/benchmarks/fixtures/large/src/module58.ts

@@ -0,0 +1 @@
+export function fn58() { return 58; }

tests/benchmarks/fixtures/large/src/module59.ts

@@ -0,0 +1 @@
+export function fn59() { return 59; }

tests/benchmarks/fixtures/large/src/module6.ts

@@ -0,0 +1 @@
+export function fn6() { return 6; }

tests/benchmarks/fixtures/large/src/module60.ts

@@ -0,0 +1 @@
+export function fn60() { return 60; }

tests/benchmarks/fixtures/large/src/module61.ts

@@ -0,0 +1 @@
+export function fn61() { return 61; }

tests/benchmarks/fixtures/large/src/module62.ts

@@ -0,0 +1 @@
+export function fn62() { return 62; }

tests/benchmarks/fixtures/large/src/module63.ts

@@ -0,0 +1 @@
+export function fn63() { return 63; }

tests/benchmarks/fixtures/large/src/module64.ts

@@ -0,0 +1 @@
+export function fn64() { return 64; }

tests/benchmarks/fixtures/large/src/module65.ts

@@ -0,0 +1 @@
+export function fn65() { return 65; }

tests/benchmarks/fixtures/large/src/module66.ts

@@ -0,0 +1 @@
+export function fn66() { return 66; }

tests/benchmarks/fixtures/large/src/module67.ts

@@ -0,0 +1 @@
+export function fn67() { return 67; }

tests/benchmarks/fixtures/large/src/module68.ts

@@ -0,0 +1 @@
+export function fn68() { return 68; }

tests/benchmarks/fixtures/large/src/module69.ts

@@ -0,0 +1 @@
+export function fn69() { return 69; }

tests/benchmarks/fixtures/large/src/module7.ts

@@ -0,0 +1 @@
+export function fn7() { return 7; }

tests/benchmarks/fixtures/large/src/module70.ts

@@ -0,0 +1 @@
+export function fn70() { return 70; }

tests/benchmarks/fixtures/large/src/module71.ts

@@ -0,0 +1 @@
+export function fn71() { return 71; }

tests/benchmarks/fixtures/large/src/module72.ts

@@ -0,0 +1 @@
+export function fn72() { return 72; }

tests/benchmarks/fixtures/large/src/module73.ts

@@ -0,0 +1 @@
+export function fn73() { return 73; }

tests/benchmarks/fixtures/large/src/module74.ts

@@ -0,0 +1 @@
+export function fn74() { return 74; }

tests/benchmarks/fixtures/large/src/module75.ts

@@ -0,0 +1 @@
+export function fn75() { return 75; }

tests/benchmarks/fixtures/large/src/module76.ts

@@ -0,0 +1 @@
+export function fn76() { return 76; }

tests/benchmarks/fixtures/large/src/module77.ts

@@ -0,0 +1 @@
+export function fn77() { return 77; }

tests/benchmarks/fixtures/large/src/module78.ts

@@ -0,0 +1 @@
+export function fn78() { return 78; }

tests/benchmarks/fixtures/large/src/module79.ts

@@ -0,0 +1 @@
+export function fn79() { return 79; }

tests/benchmarks/fixtures/large/src/module8.ts

@@ -0,0 +1 @@
+export function fn8() { return 8; }

tests/benchmarks/fixtures/large/src/module80.ts

@@ -0,0 +1 @@
+export function fn80() { return 80; }

tests/benchmarks/fixtures/large/src/module81.ts

@@ -0,0 +1 @@
+export function fn81() { return 81; }

tests/benchmarks/fixtures/large/src/module82.ts

@@ -0,0 +1 @@
+export function fn82() { return 82; }

tests/benchmarks/fixtures/large/src/module83.ts

@@ -0,0 +1 @@
+export function fn83() { return 83; }

tests/benchmarks/fixtures/large/src/module84.ts

@@ -0,0 +1 @@
+export function fn84() { return 84; }

tests/benchmarks/fixtures/large/src/module85.ts

@@ -0,0 +1 @@
+export function fn85() { return 85; }

tests/benchmarks/fixtures/large/src/module86.ts

@@ -0,0 +1 @@
+export function fn86() { return 86; }

tests/benchmarks/fixtures/large/src/module87.ts

@@ -0,0 +1 @@
+export function fn87() { return 87; }

tests/benchmarks/fixtures/large/src/module88.ts

@@ -0,0 +1 @@
+export function fn88() { return 88; }

tests/benchmarks/fixtures/large/src/module89.ts

@@ -0,0 +1 @@
+export function fn89() { return 89; }

tests/benchmarks/fixtures/large/src/module9.ts

@@ -0,0 +1 @@
+export function fn9() { return 9; }

tests/benchmarks/fixtures/large/src/module90.ts

@@ -0,0 +1 @@
+export function fn90() { return 90; }

tests/benchmarks/fixtures/large/src/module91.ts

@@ -0,0 +1 @@
+export function fn91() { return 91; }

tests/benchmarks/fixtures/large/src/module92.ts

@@ -0,0 +1 @@
+export function fn92() { return 92; }

tests/benchmarks/fixtures/large/src/module93.ts

@@ -0,0 +1 @@
+export function fn93() { return 93; }

tests/benchmarks/fixtures/large/src/module94.ts

@@ -0,0 +1 @@
+export function fn94() { return 94; }

tests/benchmarks/fixtures/large/src/module95.ts

@@ -0,0 +1 @@
+export function fn95() { return 95; }

tests/benchmarks/fixtures/large/src/module96.ts

@@ -0,0 +1 @@
+export function fn96() { return 96; }

tests/benchmarks/fixtures/large/src/module97.ts

@@ -0,0 +1 @@
+export function fn97() { return 97; }

tests/benchmarks/fixtures/large/src/module98.ts

@@ -0,0 +1 @@
+export function fn98() { return 98; }

tests/benchmarks/fixtures/large/src/module99.ts

@@ -0,0 +1 @@
+export function fn99() { return 99; }

tests/benchmarks/fixtures/medium/src/module0.ts

@@ -0,0 +1 @@
+export function fn0() { return 0; }

tests/benchmarks/fixtures/medium/src/module1.ts

@@ -0,0 +1 @@
+export function fn1() { return 1; }

tests/benchmarks/fixtures/medium/src/module10.ts

@@ -0,0 +1 @@
+export function fn10() { return 10; }

tests/benchmarks/fixtures/medium/src/module11.ts

@@ -0,0 +1 @@
+export function fn11() { return 11; }

tests/benchmarks/fixtures/medium/src/module12.ts

@@ -0,0 +1 @@
+export function fn12() { return 12; }

tests/benchmarks/fixtures/medium/src/module13.ts

@@ -0,0 +1 @@
+export function fn13() { return 13; }

tests/benchmarks/fixtures/medium/src/module14.ts

@@ -0,0 +1 @@
+export function fn14() { return 14; }

tests/benchmarks/fixtures/medium/src/module15.ts

@@ -0,0 +1 @@
+export function fn15() { return 15; }

tests/benchmarks/fixtures/medium/src/module16.ts

@@ -0,0 +1 @@
+export function fn16() { return 16; }

tests/benchmarks/fixtures/medium/src/module17.ts

@@ -0,0 +1 @@
+export function fn17() { return 17; }

tests/benchmarks/fixtures/medium/src/module18.ts

@@ -0,0 +1 @@
+export function fn18() { return 18; }

tests/benchmarks/fixtures/medium/src/module19.ts

@@ -0,0 +1 @@
+export function fn19() { return 19; }

tests/benchmarks/fixtures/medium/src/module2.ts

@@ -0,0 +1 @@
+export function fn2() { return 2; }

tests/benchmarks/fixtures/medium/src/module20.ts

@@ -0,0 +1 @@
+export function fn20() { return 20; }

tests/benchmarks/fixtures/medium/src/module21.ts

@@ -0,0 +1 @@
+export function fn21() { return 21; }

tests/benchmarks/fixtures/medium/src/module22.ts

@@ -0,0 +1 @@
+export function fn22() { return 22; }

tests/benchmarks/fixtures/medium/src/module23.ts

@@ -0,0 +1 @@
+export function fn23() { return 23; }

tests/benchmarks/fixtures/medium/src/module24.ts

@@ -0,0 +1 @@
+export function fn24() { return 24; }

tests/benchmarks/fixtures/medium/src/module25.ts

@@ -0,0 +1 @@
+export function fn25() { return 25; }

tests/benchmarks/fixtures/medium/src/module26.ts

@@ -0,0 +1 @@
+export function fn26() { return 26; }

tests/benchmarks/fixtures/medium/src/module27.ts

@@ -0,0 +1 @@
+export function fn27() { return 27; }

tests/benchmarks/fixtures/medium/src/module28.ts

@@ -0,0 +1 @@
+export function fn28() { return 28; }

tests/benchmarks/fixtures/medium/src/module29.ts

@@ -0,0 +1 @@
+export function fn29() { return 29; }

tests/benchmarks/fixtures/medium/src/module3.ts

@@ -0,0 +1 @@
+export function fn3() { return 3; }

tests/benchmarks/fixtures/medium/src/module4.ts

@@ -0,0 +1 @@
+export function fn4() { return 4; }

tests/benchmarks/fixtures/medium/src/module5.ts

@@ -0,0 +1 @@
+export function fn5() { return 5; }

tests/benchmarks/fixtures/medium/src/module6.ts

@@ -0,0 +1 @@
+export function fn6() { return 6; }

tests/benchmarks/fixtures/medium/src/module7.ts

@@ -0,0 +1 @@
+export function fn7() { return 7; }

tests/benchmarks/fixtures/medium/src/module8.ts

@@ -0,0 +1 @@
+export function fn8() { return 8; }

tests/benchmarks/fixtures/medium/src/module9.ts

@@ -0,0 +1 @@
+export function fn9() { return 9; }

tests/benchmarks/fixtures/small/src/module0.ts

@@ -0,0 +1 @@
+export function fn0() { return 0; }

tests/benchmarks/fixtures/small/src/module1.ts

@@ -0,0 +1 @@
+export function fn1() { return 1; }

tests/benchmarks/fixtures/small/src/module2.ts

@@ -0,0 +1 @@
+export function fn2() { return 2; }

tests/benchmarks/fixtures/small/src/module3.ts

@@ -0,0 +1 @@
+export function fn3() { return 3; }

tests/benchmarks/fixtures/small/src/module4.ts

@@ -0,0 +1 @@
+export function fn4() { return 4; }