@maxgfr/codeindex 2.8.0 → 2.8.1

package/README.md

@@ -59,9 +59,9 @@ import { scanRepo, ENGINE_VERSION } from "@maxgfr/codeindex";
 const scan = scanRepo("/path/to/repo");
 ```
 
-The CLI ships in the same package (`npm i -g @maxgfr/codeindex`, see below).
-Skills should still prefer vendoring: it keeps their own bundle single-file and
-pinned to an exact commit without an npm dependency.
+The CLI ships in the same package — see **Use as a CLI** below for the global
+install command. Skills should still prefer vendoring: it keeps their own
+bundle single-file and pinned to an exact commit without an npm dependency.
 
 ## Use as a CLI
 
@@ -99,6 +99,19 @@ into their own CLIs); `cli.mjs` is the thin standalone CLI/MCP wrapper.
 `buildGraph`/`buildIndexArtifacts` accept `meta: { version, schemaVersion }` so
 a consumer can stamp its own identity into artifacts it persists.
 
+## Benchmarks
+
+Measured against 01x-in/codeindex, universal-ctags and scip-typescript with a
+reproducible harness (`scripts/bench/`); full methodology, fairness notes and
+all scenarios in [BENCHMARKS.md](./BENCHMARKS.md).
+
+| Metric | codeindex | Context |
+| --- | --- | --- |
+| `socialgouv/code-du-travail-numerique` — cold index | 1,746 ms | vs ctags 371 ms, 01x init 13,409 ms |
+| `socialgouv/code-du-travail-numerique` — warm rerun | 339 ms | |
+| `vercel/next.js` — cold index | 9,398 ms | vs ctags 3,431 ms |
+| `socialgouv/code-du-travail-numerique` — token ratio (measured) | 32.9× | structured index vs raw grep, single-symbol lookup |
+
 ## Development
 
 ```sh

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxgfr/codeindex",
-  "version": "2.8.0",
+  "version": "2.8.1",
   "description": "Self-contained, deterministic repo-indexing engine: walk + language detection + symbol/import extraction (tree-sitter AST with regex fallback) + import resolution + typed cross-file link-graph + analytics. Ships as a single zero-dependency engine.mjs that consumer tools vendor.",
   "type": "module",
   "packageManager": "pnpm@10.33.0",

package/scripts/engine.d.mts

@@ -1,4 +1,4 @@
-declare const ENGINE_VERSION = "2.8.0";
+declare const ENGINE_VERSION = "2.8.1";
 declare const SCHEMA_VERSION = 4;
 declare const EXTRACTOR_VERSION = 6;
 type FileKind = "code" | "doc" | "config" | "asset" | "other";
@@ -417,6 +417,7 @@ declare function renderGraphJson(graph: Graph): string;
 
 interface RenderScipOptions {
     projectRoot?: string;
+    toolVersion?: string;
 }
 declare function renderScip(scan: RepoScan, opts?: RenderScipOptions): Uint8Array;
 

package/scripts/engine.mjs

@@ -14,7 +14,7 @@ var ENGINE_VERSION, SCHEMA_VERSION, EXTRACTOR_VERSION;
 var init_types = __esm({
   "src/types.ts"() {
     "use strict";
-    ENGINE_VERSION = "2.8.0";
+    ENGINE_VERSION = "2.8.1";
     SCHEMA_VERSION = 4;
     EXTRACTOR_VERSION = 6;
   }
@@ -10434,6 +10434,7 @@ function findWord(line, name2) {
 }
 function renderScip(scan2, opts = {}) {
   const projectRoot = opts.projectRoot ?? "file://" + scan2.root.replace(/\\/g, "/");
+  const toolVersion = opts.toolVersion ?? ENGINE_VERSION;
   const docs = scan2.files.filter((f) => f.kind === "code" && f.symbols.length > 0);
   const docDefs = /* @__PURE__ */ new Map();
   const defByName = /* @__PURE__ */ new Map();
@@ -10514,7 +10515,7 @@ function renderScip(scan2, opts = {}) {
   }
   const toolInfo = [];
   pushString(toolInfo, F_TOOL_NAME, "codeindex");
-  pushString(toolInfo, F_TOOL_VERSION, ENGINE_VERSION);
+  pushString(toolInfo, F_TOOL_VERSION, toolVersion);
   const metadata2 = [];
   pushLenDelim(metadata2, F_META_TOOL_INFO, toolInfo);
   pushString(metadata2, F_META_PROJECT_ROOT, projectRoot);

package/src/render/scip.ts

@@ -24,6 +24,10 @@ export interface RenderScipOptions {
   // Overridable so a build is byte-reproducible regardless of the machine's
   // checkout path; defaults to `file://` + the posix repo root.
   projectRoot?: string;
+  // Metadata.tool_info.version. Overridable so a byte-golden fixture can pin a
+  // fixed string and stay stable across ENGINE_VERSION release bumps; defaults
+  // to the live ENGINE_VERSION (the CLI never overrides this — no flag for it).
+  toolVersion?: string;
 }
 
 // ---------------------------------------------------------------------------
@@ -246,6 +250,7 @@ interface DefEntry {
 // ---------------------------------------------------------------------------
 export function renderScip(scan: RepoScan, opts: RenderScipOptions = {}): Uint8Array {
   const projectRoot = opts.projectRoot ?? "file://" + scan.root.replace(/\\/g, "/");
+  const toolVersion = opts.toolVersion ?? ENGINE_VERSION;
 
   // One Document per `code` file that declares ≥1 symbol, in scan order (already
   // sorted by rel).
@@ -353,7 +358,7 @@ export function renderScip(scan: RepoScan, opts: RenderScipOptions = {}): Uint8A
   // Metadata { tool_info, project_root, text_document_encoding }.
   const toolInfo: Bytes = [];
   pushString(toolInfo, F_TOOL_NAME, "codeindex");
-  pushString(toolInfo, F_TOOL_VERSION, ENGINE_VERSION);
+  pushString(toolInfo, F_TOOL_VERSION, toolVersion);
 
   const metadata: Bytes = [];
   pushLenDelim(metadata, F_META_TOOL_INFO, toolInfo);

package/src/types.ts

@@ -1,7 +1,7 @@
 // Single source of truth for the engine version the bundle reports. Kept in
 // lockstep with package.json by the release pipeline. Do not edit by hand
 // outside a release.
-export const ENGINE_VERSION = "2.8.0";
+export const ENGINE_VERSION = "2.8.1";
 
 // Bumped whenever the on-disk artifact shape changes, so a consumer can reject
 // an index written by an incompatible engine instead of misreading it. The