Expand description
§tokmd-types
Tier 0 (Core Types)
This crate defines the core data structures and contracts for tokmd.
It contains only data types, Serde definitions, and schema_version.
§Stability Policy
JSON-first stability: The primary contract is the JSON schema, not Rust struct literals.
- JSON consumers: Stable. New fields have sensible defaults; removed/renamed fields
bump
SCHEMA_VERSION. - Rust library consumers: Semi-stable. New fields may be added in minor versions,
which can break struct literal construction. Use
Default+ field mutation or..Default::default()patterns for forward compatibility.
If you need strict Rust API stability, pin to an exact version.
§What belongs here
- Pure data structs (Receipts, Rows, Reports)
- Serialization/Deserialization logic
- Stability markers (SCHEMA_VERSION)
§What does NOT belong here
- File I/O
- CLI argument parsing
- Complex business logic
- Tokei dependencies
Modules§
- cockpit
- Cockpit receipt types for PR metrics and evidence gates.
Structs§
- Artifact
Entry - Entry describing an artifact in the handoff bundle.
- Artifact
Hash - Hash for artifact integrity.
- Capability
Status - Status of a detected capability.
- Cards
File cards.jsonReviewCard snapshot (minimal consumer contract).- Context
Bundle Manifest - Manifest for a context bundle directory (bundle.txt + receipt.json + manifest.json).
- Context
Excluded Path - Explicitly excluded path with reason for context bundles.
- Context
File Row - Context
LogRecord - Log record for context command JSONL append mode. Contains metadata only (not file contents) for lightweight logging.
- Context
Receipt - Diff
Receipt - JSON receipt for diff output with envelope metadata.
- DiffRow
- A row in the diff output showing changes for a single language.
- Diff
Totals - Aggregate totals for the diff.
- Evidence
Packet Artifacts - Packet artifact paths.
- Evidence
Packet Manifest - Manifest for a scoped evidence packet directory.
- Evidence
Packet Review Priority Item - Advisory first-read item derived from packet artifacts.
- Export
Args - Export
Args Meta - Export
Data - Detailed export data containing individual file statistics.
- Export
Receipt - FileRow
- A single file row in the export inventory.
- Handoff
Complexity - Simplified complexity report for handoff intelligence.
- Handoff
Derived - Simplified derived metrics for handoff intelligence.
- Handoff
Excluded Path - Explicitly excluded path with reason.
- Handoff
Hotspot - Simplified hotspot row for handoff intelligence.
- Handoff
Intelligence - Intelligence bundle for handoff containing tree, hotspots, complexity, and derived metrics.
- Handoff
Manifest - Manifest for a handoff bundle containing LLM-ready artifacts.
- Lang
Args - Lang
Args Meta - Lang
Receipt - Lang
Report - A report detailing language statistics.
- LangRow
- A single language row in the lang summary.
- Manual
Candidate Record - One manual candidate row from
manual-candidates.json. - Manual
Candidates File manual-candidates.jsonindex (minimal consumer contract).- Module
Args - Module
Args Meta - Module
Receipt - Module
Report - Module
Row - A single module row in the module breakdown.
- Packet
Preset Input - Ready-to-format sections for one audience preset.
- Packet
Render Bundle - Bundle passed from CLI load through formatting.
- Packet
Sibling Inputs - Parsed sibling inputs available to the packet renderer.
- Policy
Excluded File - A file excluded by per-file cap / classification policy.
- Review
Card Record - One ReviewCard row from
cards.json. - RunReceipt
- Scan
Args - Smart
Excluded File - A file excluded by smart-exclude heuristics (lockfiles, minified, etc.).
- Token
Audit - Post-write audit comparing actual output to estimates.
- Token
Estimation Meta - Metadata about how token estimates were produced.
- Tokmd
Packets Manifest - Top-level packet bundle manifest (
tokmd-packets.json). - Tokmd
Packets Producer - Producer metadata recorded by the exporting tool.
- Tool
Info - Totals
- A small totals struct shared by summary outputs.
Enums§
- Analysis
Format - Capability
State - State of a capability: available, skipped, or unavailable.
- Child
Include Mode - Children
Mode - Commit
Intent Kind - Classification of a commit’s intent, derived from subject line.
- Config
Mode - Evidence
Packet Status - Evidence packet status.
- Export
Format - File
Classification - Classification of a file for bundle hygiene purposes.
- File
Kind - Inclusion
Policy - How a file is included in the context/handoff bundle.
- Redact
Mode - Scan
Status - Table
Format
Constants§
- BUN_
UB_ PACKET_ PRESETS - Bun UB packet presets documented in
docs/specs/tokmd-packets-render.md. - CARDS_
FILE - Sibling artifact filename for ReviewCard analyzer output.
- CONTEXT_
BUNDLE_ SCHEMA_ VERSION - Schema version for context bundle manifests.
- CONTEXT_
SCHEMA_ VERSION - Schema version for context receipts (separate from SCHEMA_VERSION used by lang/module/export/diff).
- EVIDENCE_
PACKET_ SCHEMA - Stable schema identifier for evidence packet manifests.
- HANDOFF_
SCHEMA_ VERSION - Schema version for handoff receipts.
- MANUAL_
CANDIDATES_ FILE - Sibling artifact filename for manual candidate indexes.
- MANUAL_
CANDIDATES_ SCHEMA - Schema id recorded by unsafe-review
manual-candidates.jsonexports. - SCHEMA_
VERSION - The current schema version for core receipt types (
lang,module,export,diff,run). - TOKMD_
PACKETS_ SCHEMA - Stable schema identifier for packet bundle manifests.