output

Documentation

Overview

Package output renders a run's Result as terminal text, markdown (in the ops-report style: problems first, full table after) or JSON.

Index

• func JSON(res engine.Result) (string, error)
• func Markdown(res engine.Result, title string) string
• func Text(res engine.Result) string

Functions

func JSON

func JSON(res engine.Result) (string, error)

JSON renders the machine-readable result.

func Markdown

func Markdown(res engine.Result, title string) string

Markdown renders an ops-style report: summary, problems, full table.

func Text

func Text(res engine.Result) string

Text renders for the terminal: worst findings first (Result is pre-sorted).