Spectre.Doctor.Report (Spectre v0.3.3)

Contract-v1 privacy-safe result returned by Spectre.Doctor.

Summary

t()

Returns whether the report should produce a successful command exit.

Formats a report as terminal text or JSON.

to_map(report)

Returns the stable JSON-safe contract-v1 map.

@type t() :: %Spectre.Doctor.Report{
  checks: term(),
  contract_version: term(),
  spectre_version: term(),
  status: term(),
  summary: term()
}

@spec acceptable?(
  t(),
  keyword()
) :: boolean()

Returns whether the report should produce a successful command exit.

@spec format(t(), :text | :json) :: String.t()

Formats a report as terminal text or JSON.

@spec to_map(t()) :: map()

Returns the stable JSON-safe contract-v1 map.