Module health_types 

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

ComplexityViolation

Inner complexity-violation payload, wrapped by HealthFinding.

ComponentRollup

Per-component breakdown attached to a synthetic <component> HealthFinding. See ComplexityViolation::component_rollup for the owning-finding contract; the wrapper flattens the inner type’s component_rollup field onto its own wire shape.

ContributingFactor

A contributing factor that triggered or strengthened a recommendation.

ContributorEntry

Per-author contribution summary. The identifier is rendered per the configured ownership.emailMode (handle, hash, or raw); the format field discriminates the three so type-aware consumers can branch without re-parsing.

CoverageGapSummary

Aggregate coverage-gap counters for the current analysis scope.

CoverageGaps

Static test coverage gaps derived from the module graph. Shows runtime files and exports with no test dependency path.

EvidenceFunction

A function referenced in target evidence.

FileHealthScore

Per-file health score combining complexity, coupling, and dead code metrics.

HealthActionContext

Construction-time context for HealthFinding::with_actions.

HealthActionOptions

Options controlling how the action builder populates a health finding’s actions array.

HealthActionsMeta

Auditable breadcrumb recording when health-finding suppress-line action hints were omitted from the report.

HealthFinding

Wire envelope for a single complexity finding.

HealthGroup

A health report scoped to a single group.

HealthGrouping

Wrapper carrying the resolver mode label alongside the partitioned groups.

HealthReport

Result of complexity analysis for reporting.

HealthScore

Project-level health score. Score = 100 minus available penalties from dead code, complexity, maintainability, hotspots, unused deps, circular deps, unit size, coupling, and duplication. Missing metrics do not penalize; –score computes the score and duplication penalty, while churn-backed hotspot penalties require hotspot analysis (–hotspots, or –targets with –score).

HealthScorePenalties

Per-component penalty breakdown for the health score.

HealthSummary

Summary statistics for the health report.

HealthTimings

Detailed timing breakdown for the health pipeline.

HealthTrend

Trend comparison between the current run and a previous snapshot. Shows per-metric deltas with directional indicators.

HotspotEntry

A hotspot: a file that is both complex and frequently changing.

HotspotFinding

Wire envelope for a single hotspot entry.

HotspotSummary

Summary statistics for hotspot analysis.

LargeFunctionEntry

A function exceeding the very-high-risk size threshold (>60 LOC).

OwnershipMetrics

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).

RefactoringTarget

RefactoringTargetFinding

Wire envelope for a single refactoring target.

RiskProfile

Risk profile: percentage of functions in each risk bin.

RuntimeCoverageAction

Suggested follow-up action for a runtime coverage finding.

RuntimeCoverageBlastRadiusEntry

RuntimeCoverageCaptureQuality

Quality-of-capture signals emitted by the sidecar so the CLI can explain short-window captures honestly instead of letting users blame the tool.

RuntimeCoverageEvidence

Supporting evidence for a finding (mirrors fallow_cov_protocol::Evidence).

RuntimeCoverageFinding

RuntimeCoverageHotPath

RuntimeCoverageImportanceEntry

RuntimeCoverageMessage

RuntimeCoverageReport

Runtime coverage findings merged into the health report or emitted by fallow coverage analyze. Present in health output when –runtime-coverage is used. Shape mirrors the runtime coverage JSON contract; cloud mode fetches runtime facts explicitly and merges them locally with AST/static analysis.

RuntimeCoverageSummary

Summary block mirroring fallow_cov_protocol::Summary (0.3 shape).

TargetEvidence

Evidence linking a target back to specific analysis data.

TargetThresholds

Adaptive thresholds used for refactoring target scoring.

TrendCount

Raw numerator/denominator for a percentage metric.

TrendMetric

A single metric’s trend between two snapshots.

TrendPoint

A reference to a snapshot used in trend comparison.

UntestedExport

Runtime export that no test-reachable module references.

UntestedExportFinding

Wire-shape envelope for an UntestedExport finding. Same pattern as UntestedFileFinding: flattens the bare finding and carries a typed actions array computed at construction time.

UntestedFile

Runtime code that no test dependency path reaches.

UntestedFileFinding

Wire-shape envelope for an UntestedFile finding. Carries the bare UntestedFile flattened in plus a typed actions array. The action vec is computed at construction time using a project-root-relative path so descriptions match strip_root_prefix’s post-pass output on the inner path field. Schemars derives the merged shape natively; this retires the augment_finding_definition graft for UntestedFile.

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.

ContributorIdentifierFormat

Format discriminator for ContributorEntry::identifier.

CoverageModel

Coverage model used for CRAP score computation.

CoverageSource

Provenance of a CRAP finding’s coverage signal.

CoverageTier

Coverage tier classification for CRAP findings.

EffortEstimate

A ranked refactoring recommendation for a file.

ExceededThreshold

Which complexity threshold was exceeded.

FindingSeverity

Severity tier indicating how far a function exceeds complexity thresholds.

RecommendationCategory

Category of refactoring recommendation.

RuntimeCoverageConfidence

Confidence level for a runtime coverage finding.

RuntimeCoverageDataSource

Runtime coverage source used to produce the summary.

RuntimeCoverageReportVerdict

Top-level verdict for the whole runtime-coverage report. Mirrors fallow_cov_protocol::ReportVerdict. The verdict is the SINGLE most actionable finding; for the full set of findings see RuntimeCoverageReport::signals. The verdict promotes hot-path-touched above cold-code-detected in PR-review context (when the CLI was given a change-scope: --diff-file or --changed-since) because the touched-hot-path is event-tied to the current diff and reviewers need it to be the top-line signal. In standalone analysis (no change scope), cold-code-detected remains primary.

RuntimeCoverageRiskBand

Blast-radius risk band. The current thresholds are high at >=20 static callers or >=1,000,000 traffic-weighted caller reach; medium at >=5 callers or >=50,000 weighted reach; low otherwise.

RuntimeCoverageSchemaVersion

Runtime coverage JSON contract version. This is scoped to the runtime_coverage block and is independent of the top-level fallow JSON schema_version.

RuntimeCoverageSignal

Discrete signal captured during runtime-coverage post-processing. verdict collapses to one summary value; signals enumerates ALL findings the report carries so JSON consumers, CI dashboards, and agents can reason about them independently of the headline. Order is stable: severity-descending so the first entry mirrors a sensible non-PR-context verdict.

RuntimeCoverageVerdict

Protocol-level per-function runtime coverage verdict derived from the decision table in fallow-cov-protocol. The CLI’s runtime_coverage.findings array omits active entries even though the underlying enum still includes it.

RuntimeCoverageWatermark

License or trial watermark applied to runtime coverage output.

TrendDirection

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_CRAP_CRITICAL

CRAP score threshold for “critical” severity. CC=10 untested gives 110, CC=12 untested gives 156; 100 lands between the two and flags genuinely dangerous combinations of high complexity and low coverage.

DEFAULT_CRAP_HIGH

CRAP score threshold for “high” severity. CC=7 untested -> 56, CC=10 -> 110.

DEFAULT_CYCLOMATIC_CRITICAL

Default cyclomatic complexity threshold for “critical” severity.

DEFAULT_CYCLOMATIC_HIGH

Default cyclomatic complexity threshold for “high” severity (warning tier).

HEALTH_SCORE_FORMULA_VERSION

Project-level health score: a single 0–100 number with letter grade.

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 score and grade fields. v3: Added coverage_model field. 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: Added total_loc to vital signs (always computed from parsed modules). v7: MI formula dampening for small files (values change for files < 50 lines). v8: Added scale-invariant tail/density metrics for health score calibration.

Functions

build_health_finding_actions

Compute the typed actions list for a complexity finding.

compute_finding_severity

Compute the severity tier for a complexity finding.

letter_grade

Map a numeric score (0–100) to a letter grade.