Mutare.Report.Sarif (mutare v0.1.0)

Copy Markdown View Source

Renders surviving mutants as a SARIF 2.1.0 log.

A surviving mutant is a gap in the suite at a specific location, which is exactly what SARIF models — so GitHub code scanning (and other SARIF consumers) surface each survivor as an inline annotation on the PR diff. Only :survived results become findings; killed/skipped mutants are not actionable and are omitted. The mutation description (Mutare.Site.describe/1) is reused verbatim as the finding message.

Emitted by mix mutare --report sarif or mix mutare --report sarif:path.sarif.

Summary

Functions

Render the survivors in results as a SARIF 2.1.0 log string.

Functions

render(results, sources, opts \\ [])

@spec render([Mutare.Result.t()], %{optional(String.t()) => String.t()}, keyword()) ::
  String.t()

Render the survivors in results as a SARIF 2.1.0 log string.