Excessibility.TelemetryCapture.Formatter (Excessibility v0.14.0)

View Source

Formats telemetry timeline data for different output formats.

Supports:

  • JSON (machine-readable)
  • Markdown (human/AI-readable)
  • Package (directory with multiple files)

Summary

Functions

Formats analysis results as markdown.

Formats timeline as JSON.

Formats timeline as markdown report.

Functions

format_analysis_results(analysis_results, opts \\ [])

Formats analysis results as markdown.

Takes map of analyzer_name => %{findings: [...], stats: %{...}} and produces formatted markdown sections.

Options

  • :verbose - Include detailed stats even when no issues found (default: false)

format_json(timeline)

Formats timeline as JSON.

Converts tuples to lists and structs to maps for JSON compatibility. Removes Ecto __meta__ fields from converted structs.

format_markdown(timeline, snapshots)

Formats timeline as markdown report.

Includes:

  • Summary header
  • Timeline table
  • Detailed change sections
  • Optional full snapshots (if snapshots provided)