Farol.Report.SARIF (Farol v0.2.0)

Copy Markdown View Source

Renders findings as SARIF 2.1.0, the format GitHub code scanning (and most other CI annotation surfaces) consumes.

Each built-in rule becomes a SARIF rule carrying its WCAG reference in properties, and each finding becomes a result with a file/line location when the static engine provided one.

Summary

Functions

Encodes findings as a SARIF 2.1.0 JSON string.

Functions

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

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

Encodes findings as a SARIF 2.1.0 JSON string.