Expand description
Codebase-index DTOs: the code-as-source view, emitted by spec-spine index
as index.json. Field names serialize to camelCase. Shapes are ported from
OAP codebase-index.schema.json (3.0.0), pruned to the generic v1 surface and
re-versioned to this library’s own schema line (currently 0.3.0; see
crate::version::INDEX_SCHEMA_VERSION).
Structs§
- Codebase
Index - The compiled codebase index:
index.json. - Diagnostic
- A single index diagnostic (
I-###). - Diagnostics
- Index diagnostics, split by tier.
I-003..I-009(inerrors) blockcheck. - Implementing
Path - A path claimed by a spec, with its linkage source.
- Index
Build - Deterministic build metadata embedded in
index.json. - Index
Package Shard - One package’s inventory shard:
<derived>/codebase-index/by-package/<slug>.json. A PR confined to a package’s manifest rewrites only that package’s shard. - Index
Spec Shard - One spec’s traceability shard:
<derived>/codebase-index/by-spec/<id>.json. A PR confined to spec X’s inputs rewrites only X’s shard (spec 024 FR-002). - Line
Span - An inclusive, 1-based line span, aligned with
git diff -U0hunk ranges. - Package
Record - A discovered compilation unit (a Rust crate or an npm package).
- Resolved
Location - A physical location: a file and an optional line-span (absent ⇒ whole file).
- Resolved
Unit - A typed unit resolved to its physical locations.
- Trace
Mapping - One spec’s mapping onto the code.
- Traceability
- Layer 2: how the corpus maps onto the code, and what is unmapped.
Enums§
- Package
Kind - The kind of a discovered compilation unit.
- Source
Field - Which edge field a resolved unit came from.
- Trace
Source - Where a path-level linkage came from.