Six.Formatter behaviour (Six v0.1.0)

Copy Markdown View Source

Behaviour for Six coverage output formatters.

Summary

Callbacks

Optional callback for formatters that produce files. Returns the path to the generated file.

Types

summary()

@type summary() :: map()

Callbacks

format(summary, keyword)

@callback format(
  summary(),
  keyword()
) :: :ok | {:error, term()}

output_path(keyword)

(optional)
@callback output_path(keyword()) :: String.t() | nil

Optional callback for formatters that produce files. Returns the path to the generated file.