Skip to main content

Crate tokmd_analysis_types

Crate tokmd_analysis_types 

Source
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§

AnalysisArgsMeta
AnalysisReceipt
AnalysisSource
Archetype
Artifact
Artifact reference in the sensor report.
AssetCategoryRow
AssetFileRow
AssetReport
BaselineComplexitySection
Complexity section mirroring analysis receipt structure for ratchet compatibility.
BaselineMetrics
Aggregate baseline metrics for the entire codebase.
BoilerplateReport
BusFactorRow
ChurnTrend
CocomoReport
CodeAgeBucket
CodeAgeDistributionReport
ComplexityBaseline
Complexity baseline for tracking trends over time.
ComplexityHistogram
Histogram of cyclomatic complexity distribution across files.
ComplexityReport
ContextWindowReport
CorporateFingerprint
CouplingRow
DependencyReport
DerivedReport
DerivedTotals
DeterminismBaseline
Build determinism baseline for reproducibility verification.
DistributionReport
DomainStat
DuplicateGroup
DuplicateReport
DuplicationDensityReport
EcoLabel
EntropyFinding
EntropyReport
Envelope
Sensor report envelope for multi-sensor integration.
EnvelopeTool
Tool identification for the sensor report.
FileBaselineEntry
Per-file baseline entry for granular complexity tracking.
FileComplexity
FileStatRow
Finding
A finding reported by the sensor.
FindingLocation
Source location for a finding.
FreshnessReport
FunReport
FunctionComplexityDetail
Function-level complexity details.
GateItem
Individual gate item in the gates section.
GateResults
Evidence gate results section.
GatesEnvelope
Evidence gate results section.
GitReport
HalsteadMetrics
Halstead software science metrics computed from operator/operand token counts.
HistogramBucket
HotspotRow
ImportEdge
ImportReport
IntegrityReport
LangPurityReport
LangPurityRow
LicenseFinding
LicenseReport
LockfileReport
MaintainabilityIndex
Composite maintainability index based on the SEI formula.
MaxFileReport
MaxFileRow
ModuleDuplicationDensityRow
ModuleFreshnessRow
NestingReport
NestingRow
PolyglotReport
PredictiveChurnReport
RateReport
RateRow
RatioReport
RatioRow
ReadingTimeReport
SensorReport
Sensor report envelope for multi-sensor integration.
TechnicalDebtRatio
Complexity-to-size ratio heuristic for technical debt estimation.
TestDensityReport
TodoReport
TodoTagRow
ToolMeta
Tool identification for the sensor report.
TopOffenders
TopicClouds
TopicTerm

Enums§

ComplexityRisk
EntropyClass
FindingSeverity
Severity level for findings.
LicenseSourceKind
TechnicalDebtLevel
TrendClass
Verdict
Overall verdict for the sensor report.

Constants§

ANALYSIS_SCHEMA_VERSION
Schema version for analysis receipts. v5: Added complexity enrichers (Halstead, maintainability, histogram) with additive debt/duplication/age signals.
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.