Skip to main content

Module health_types

Module health_types 

Source
Expand description

Health / complexity analysis report types. Health / complexity analysis report types.

Separated from the health command module so that report formatters (which are compiled as part of both the lib and bin targets) can reference these types without pulling in binary-only dependencies.

Structs§

ContributingFactor
A contributing factor that triggered or strengthened a recommendation.
EvidenceFunction
A function referenced in target evidence.
FileHealthScore
Per-file health score combining complexity, coupling, and dead code metrics.
HealthFinding
A single function that exceeds a complexity threshold.
HealthReport
Result of complexity analysis for reporting.
HealthSummary
Summary statistics for the health report.
HotspotEntry
A hotspot: a file that is both complex and frequently changing.
HotspotSummary
Summary statistics for hotspot analysis.
RefactoringTarget
TargetEvidence
Evidence linking a target back to specific analysis data.
TargetThresholds
Adaptive thresholds used for refactoring target scoring.
VitalSigns
Project-wide vital signs — a fixed set of metrics for trend tracking.
VitalSignsCounts
Raw counts backing the vital signs percentages.
VitalSignsSnapshot
A point-in-time snapshot of project vital signs, persisted to disk.

Enums§

Confidence
Confidence level for a refactoring recommendation.
EffortEstimate
A ranked refactoring recommendation for a file.
ExceededThreshold
Which complexity threshold was exceeded.
RecommendationCategory
Category of refactoring recommendation.

Constants§

HOTSPOT_SCORE_THRESHOLD
Hotspot score threshold for counting a file as a hotspot in vital signs.
SNAPSHOT_SCHEMA_VERSION
Current snapshot schema version. Independent of the report’s SCHEMA_VERSION.