Farol.Report (Farol v0.2.0)

Copy Markdown View Source

Renders findings into the didactic terminal report.

Every finding gets three layers: what was found (message + WCAG ref), why it matters to humans (the rule's why/0), and how to fix it (fix/0). The output is plain ASCII with ANSI colors, so it reads the same in a terminal, in CI logs, and pasted into an issue.

Summary

Functions

Formats a list of findings as a printable report string.

Functions

format(findings, rules \\ Farol.rules())

@spec format([Farol.Finding.t()], [module()]) :: String.t()

Formats a list of findings as a printable report string.