Farol.Finding (Farol v0.2.0)

One accessibility violation, tied to the rule that caught it.

A finding carries the instance-specific part (message, snippet): what was found, where. The didactic part (why, fix) lives on the rule module, since it is the same for every instance of the same violation. Farol.Report joins the two when rendering.

Summary

Types

t()

Types

t()

@type t() :: %Farol.Finding{
  file: String.t() | nil,
  level: String.t(),
  line: pos_integer() | nil,
  message: String.t(),
  rule: String.t(),
  severity: :error | :warning,
  snippet: String.t() | nil,
  wcag: String.t()
}