PropWise.Reporter (PropWise v0.4.0)

Formats and outputs analysis results.

Summary

Functions

format_report(analysis_result, opts \\ [])

Formats analysis results and returns as a string. Formats: :text / :markdown (default) or :json.

print_report(analysis_result, opts \\ [])

Prints analysis results. Renders Markdown with Marcli for terminal output when format is :text (default). Outputs raw Markdown when format is :markdown. Outputs JSON when format is :json.

Functions

format_report(analysis_result, opts \\ [])

@spec format_report(
  PropWise.Analyzer.analysis_result(),
  keyword()
) :: String.t()

Formats analysis results and returns as a string. Formats: :text / :markdown (default) or :json.

print_report(analysis_result, opts \\ [])

@spec print_report(
  PropWise.Analyzer.analysis_result(),
  keyword()
) :: :ok

Prints analysis results. Renders Markdown with Marcli for terminal output when format is :text (default). Outputs raw Markdown when format is :markdown. Outputs JSON when format is :json.