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.
- Contributor
Entry - Per-author summary emitted in
OwnershipMetrics::top_contributorandOwnershipMetrics::recent_contributors. - 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
Timings - Detailed timing breakdown for the health pipeline.
- 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.
- Large
Function Entry - A function exceeding the very-high-risk size threshold (>60 LOC).
- Ownership
Metrics - Per-file ownership signals attached to hotspot entries when the user
passes
--ownership. All fields are derived from git history and the repository’s CODEOWNERS file (if any). - Production
Coverage Action - Production
Coverage Evidence - Supporting evidence for a finding (mirrors
fallow_cov_protocol::Evidence). - Production
Coverage Finding - Production
Coverage HotPath - Production
Coverage Message - Production
Coverage Report - Production
Coverage Summary - Summary block mirroring
fallow_cov_protocol::Summary(0.2 shape). - Refactoring
Target - Risk
Profile - Risk profile: percentage of functions in each risk bin.
- 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.
- Contributor
Identifier Format - Format discriminator for
ContributorEntry::identifier. - 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.
- Finding
Severity - Severity tier indicating how far a function exceeds complexity thresholds.
- Production
Coverage Confidence - Production
Coverage Report Verdict - Top-level verdict for the whole production-coverage report. Mirrors
fallow_cov_protocol::ReportVerdict. - Production
Coverage Verdict - Per-finding verdict. Replaces the 0.1
statefield. - Production
Coverage Watermark - 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.
- DEFAULT_
COGNITIVE_ CRITICAL - Default cognitive complexity threshold for “critical” severity.
- DEFAULT_
COGNITIVE_ HIGH - Default cognitive complexity threshold for “high” severity (warning tier).
- DEFAULT_
CYCLOMATIC_ CRITICAL - Default cyclomatic complexity threshold for “critical” severity.
- DEFAULT_
CYCLOMATIC_ HIGH - Default cyclomatic complexity threshold for “high” severity (warning tier).
- HOTSPOT_
SCORE_ THRESHOLD - Hotspot score threshold for counting a file as a hotspot in vital signs.
- MI_
DENSITY_ MIN_ LINES - Minimum lines of code for full complexity density weight in the MI formula. Files smaller than this get a proportional dampening factor to prevent density from dominating the score on trivially small files.
- SNAPSHOT_
SCHEMA_ VERSION - Current snapshot schema version. Independent of the report’s SCHEMA_VERSION.
v2: Added
scoreandgradefields. v3: Addedcoverage_modelfield. v4: Added risk profiles (unit_size_profile,unit_interfacing_profile) and coupling concentration (p95_fan_in,coupling_high_pct). v5: Added duplication penalty to health score formula. v6: Addedtotal_locto vital signs (always computed from parsed modules). v7: MI formula dampening for small files (values change for files < 50 lines).
Functions§
- compute_
finding_ severity - Compute the severity tier for a complexity finding.
- letter_
grade - Map a numeric score (0–100) to a letter grade.