aalekh-report/com.aalekh.aalekh.report/ReportCoordinator

ReportCoordinator

class ReportCoordinator(graph: ModuleDependencyGraph, ruleResult: RuleEngineResult, projectName: String, extensions: ExtensionResult = ExtensionResult.EMPTY)(source)

Facade that drives all report generation from a single call site.

Tasks never instantiate individual report generators directly - this keeps task code thin and report logic testable without Gradle on the classpath.

Constructors

ReportCoordinator

constructor(graph: ModuleDependencyGraph, ruleResult: RuleEngineResult, projectName: String, extensions: ExtensionResult = ExtensionResult.EMPTY)

Types

Companion

object Companion

Properties

extensionFailures

val extensionFailures: List<String>

Failures from third-party extensions, for the task to log. Empty when everything ran.

Functions

analyzeTemporal

fun analyzeTemporal(commits: List<CommitChange>, minSharedCommits: Int = TemporalCouplingAnalyzer.DEFAULT_MIN_SHARED_COMMITS, hiddenCouplingThreshold: Double = TemporalCouplingAnalyzer.DEFAULT_HIDDEN_COUPLING_THRESHOLD): TemporalCouplingReport

Computes temporal (change) coupling for this graph from a window of recent commits.

generateCsv

fun generateCsv(): String

Generates a CSV of per-module metrics for import into external tools. One timestamped row per module with fan-in, fan-out, instability, transitive dep count, health score, and boolean flags.

generateDocs

fun generateDocs(teamOwners: Map<String, List<String>> = emptyMap(), hiddenCoupling: List<CoChange> = emptyList(), churn: List<ModuleChurn> = emptyList(), layers: List<LayerSpec> = emptyList()): Map<String, String>

Generates the Markdown documentation set, keyed by file name.

generateHtml

fun generateHtml(trendJson: String = "[]", teamOwners: Map<String, List<String>> = emptyMap(), mainSequence: List<ModuleMainSequence> = emptyList(), hiddenCoupling: List<CoChange> = emptyList(), churn: List<ModuleChurn> = emptyList(), layers: List<LayerSpec> = emptyList()): String

Generates the self-contained HTML report. Returns the complete HTML string.

generateJson

fun generateJson(): String

Generates the machine-readable JSON report envelope: { graph, summary, violations, generatedAt, aalekhVersion }.

generateJUnitXml

fun generateJUnitXml(): String

Generates JUnit XML output for CI test reporting systems.

generateMermaid

fun generateMermaid(): String

Generates the module graph as a raw Mermaid graph definition (no code fence). Diffable plain text that renders inline on GitHub and in most IDEs.

generateMermaidMarkdown

fun generateMermaidMarkdown(): String