package io.gitlab.arturbosch.detekt.core.reporting.console

import io.gitlab.arturbosch.detekt.api.ConsoleReport
import io.gitlab.arturbosch.detekt.api.Detektion

/**
 * Contains metrics and statistics concerning the analyzed project sorted by priority.
 * See: https://detekt.dev/configurations.html#console-reports
 */
class ProjectStatisticsReport : ConsoleReport {

    override val id: String = "ProjectStatisticsReport"
    override val priority: Int = 10

    override fun render(detektion: Detektion): String? {
        val metrics = detektion.metrics
        if (metrics.isEmpty()) return null
        return with(StringBuilder()) {
            append("Project Statistics:\n")
            metrics.sortedBy { -it.priority }
                .forEach {
                    append("\t- ")
                    append(it)
                    append("\n")
                }
            toString()
        }
    }
}
