projectScore

fun projectScore(summary: GraphSummary, errorCount: Int, warningCount: Int): ProjectHealth(source)

Returns the whole-project health score - a different measure from the per-module score.

Where score asks "is this module in a healthy position in the graph?", this asks "is this project's architecture in good shape right now?", so it weighs project-level facts a single module cannot express: cycle count, rule violations, the number of coupling hubs, and how unstable the graph is on average. Each signal is capped, so no one problem can drive the score to zero on its own, and every penalty is returned in ProjectHealth.components so the number can explain itself.

Parameters

summary

The current graph summary - supplies cycle count, god-module count, and average instability.

errorCount

ERROR-severity violations from the rule engine.

warningCount

WARNING-severity violations from the rule engine.