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§
- Contributing
Factor - A contributing factor that triggered or strengthened a recommendation.
- Coverage
GapSummary - Aggregate coverage-gap counters for the current analysis scope.
- Coverage
Gaps - Static test coverage gaps derived from the module graph.
- Evidence
Function - A function referenced in target evidence.
- File
Health Score - Per-file health score combining complexity, coupling, and dead code metrics.
- Health
Finding - A single function that exceeds a complexity threshold.
- Health
Report - Result of complexity analysis for reporting.
- Health
Score - Project-level health score: a single 0–100 number with letter grade.
- Health
Score Penalties - Per-component penalty breakdown for the health score.
- Health
Summary - Summary statistics for the health report.
- Health
Trend - Health trend comparison: current run vs. a previous snapshot.
- Hotspot
Entry - A hotspot: a file that is both complex and frequently changing.
- Hotspot
Summary - Summary statistics for hotspot analysis.
- Refactoring
Target - Target
Evidence - Evidence linking a target back to specific analysis data.
- Target
Thresholds - Adaptive thresholds used for refactoring target scoring.
- Trend
Count - Raw numerator/denominator for a percentage metric.
- Trend
Metric - A single metric’s trend between two snapshots.
- Trend
Point - A reference to a snapshot used in trend comparison.
- Untested
Export - Runtime export that no test-reachable module references.
- Untested
File - Runtime code that no test dependency path reaches.
- Vital
Signs - Project-wide vital signs — a fixed set of metrics for trend tracking.
- Vital
Signs Counts - Raw counts backing the vital signs percentages.
- Vital
Signs Snapshot - A point-in-time snapshot of project vital signs, persisted to disk.
Enums§
- Confidence
- Confidence level for a refactoring recommendation.
- Coverage
Model - Coverage model used for CRAP score computation.
- Effort
Estimate - A ranked refactoring recommendation for a file.
- Exceeded
Threshold - Which complexity threshold was exceeded.
- Recommendation
Category - Category of refactoring recommendation.
- Trend
Direction - Direction of a metric’s change, semantically (improving/declining/stable).
Constants§
- COGNITIVE_
EXTRACTION_ THRESHOLD - Cognitive complexity threshold above which a function is flagged for extraction.
- 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.
v2: Added
scoreandgradefields.
Functions§
- letter_
grade - Map a numeric score (0–100) to a letter grade.