library/io.github.baole.konture/HumanReadableViolationFormatter/format

format

@JvmOverloads
fun format(report: ViolationReport, customHeader: String? = null): String

Formats a ViolationReport into a human-readable string suitable for test failure outputs.

Return

Formatted human-readable string representation of the report.

Parameters

report

The violation report to format.

customHeader

Optional custom header or description to include below the rule header.