Expand description
§tokmd-analysis-types
Tier 0 (Analysis Contract)
Pure data structures for analysis receipts. No I/O or business logic.
§What belongs here
- Analysis-specific receipt types and findings
- Schema definitions for analysis outputs
- Type enums for classification results
§What does NOT belong here
- Analysis computation logic (use tokmd-analysis)
- Formatting logic (use tokmd-analysis-format)
- File I/O operations
Modules§
- findings
- Finding ID registry for cockpit outputs.
Structs§
- Analysis
Args Meta - Analysis
Receipt - Analysis
Source - ApiExport
Item - A file that exports many public items.
- ApiSurface
Report - Public API surface analysis report.
- Archetype
- Artifact
- Artifact reference in the sensor report.
- Asset
Category Row - Asset
File Row - Asset
Report - Baseline
Complexity Section - Complexity section mirroring analysis receipt structure for ratchet compatibility.
- Baseline
Metrics - Aggregate baseline metrics for the entire codebase.
- Boilerplate
Report - BusFactor
Row - Churn
Trend - Cocomo
Report - Code
AgeBucket - Code
AgeDistribution Report - Commit
Intent Counts - Counts per intent kind.
- Commit
Intent Report - Overall commit intent classification report.
- Complexity
Baseline - Complexity baseline for tracking trends over time.
- Complexity
Histogram - Histogram of cyclomatic complexity distribution across files.
- Complexity
Report - Context
Window Report - Corporate
Fingerprint - Coupling
Row - Dependency
Report - Derived
Report - Derived
Totals - Determinism
Baseline - Build determinism baseline for reproducibility verification.
- Distribution
Report - Domain
Stat - Duplicate
Group - Duplicate
Report - Duplication
Density Report - EcoLabel
- Entropy
Finding - Entropy
Report - Envelope
- Sensor report envelope for multi-sensor integration.
- Envelope
Tool - Tool identification for the sensor report.
- File
Baseline Entry - Per-file baseline entry for granular complexity tracking.
- File
Complexity - File
Stat Row - Finding
- A finding reported by the sensor.
- Finding
Location - Source location for a finding.
- Freshness
Report - FunReport
- Function
Complexity Detail - Function-level complexity details.
- Gate
Item - Individual gate item in the gates section.
- Gate
Results - Evidence gate results section.
- Gates
Envelope - Evidence gate results section.
- GitReport
- Halstead
Metrics - Halstead software science metrics computed from operator/operand token counts.
- Histogram
Bucket - Hotspot
Row - Import
Edge - Import
Report - Integrity
Report - Lang
ApiSurface - Per-language API surface breakdown.
- Lang
Purity Report - Lang
Purity Row - License
Finding - License
Report - Lockfile
Report - Maintainability
Index - Composite maintainability index based on the SEI formula.
- MaxFile
Report - MaxFile
Row - Module
ApiRow - Per-module API surface row.
- Module
Duplication Density Row - Module
Freshness Row - Module
Intent Row - Per-module intent breakdown row.
- Near
DupAlgorithm - Algorithm constants for near-duplicate fingerprinting.
- Near
DupCluster - A connected component of near-duplicate files.
- Near
DupPair Row - A pair of near-duplicate files with similarity score.
- Near
DupParams - Parameters for near-duplicate detection.
- Near
DupStats - Runtime statistics for near-duplicate detection.
- Near
Duplicate Report - Report of near-duplicate file pairs.
- Nesting
Report - Nesting
Row - Polyglot
Report - Predictive
Churn Report - Rate
Report - RateRow
- Ratio
Report - Ratio
Row - Reading
Time Report - Sensor
Report - Sensor report envelope for multi-sensor integration.
- Technical
Debt Ratio - Complexity-to-size ratio heuristic for technical debt estimation.
- Test
Density Report - Todo
Report - Todo
TagRow - Tool
Meta - Tool identification for the sensor report.
- TopOffenders
- Topic
Clouds - Topic
Term
Enums§
- Commit
Intent Kind - Classification of a commit’s intent, derived from subject line.
- Complexity
Risk - Entropy
Class - Finding
Severity - Severity level for findings.
- License
Source Kind - Near
DupScope - Scope for near-duplicate comparison partitioning.
- Technical
Debt Level - Trend
Class - Verdict
- Overall verdict for the sensor report.
Constants§
- ANALYSIS_
SCHEMA_ VERSION - Schema version for analysis receipts. v7: Added coupling normalization (Jaccard/Lift), commit intent classification, near-duplicate detection. v8: Near-dup clusters, selection metadata, max_pairs guardrail, runtime stats.
- BASELINE_
VERSION - Schema version for baseline files. v1: Initial baseline format with complexity and determinism tracking.
- ENVELOPE_
SCHEMA - Schema identifier for ecosystem envelope format. v1: Initial envelope specification for multi-sensor integration.