output

Documentation

Index

• func JSON(results []*comparer.Result, includePassing bool, tweaks []*config.QueryTweak)
• func TSV(results []*comparer.Result, _ bool, _ []*config.QueryTweak)
• func Text(results []*comparer.Result, includePassing bool, tweaks []*config.QueryTweak)
• type JSONResult
• type Outputter
  • func HTML(tplFile string) (Outputter, error)

Functions

func JSON

func JSON(results []*comparer.Result, includePassing bool, tweaks []*config.QueryTweak)

JSON produces JSON-based output for a number of query results.

func TSV

func TSV(results []*comparer.Result, _ bool, _ []*config.QueryTweak)

TSV produces tab separated values output for a number of query results.

func Text

func Text(results []*comparer.Result, includePassing bool, tweaks []*config.QueryTweak)

Text produces text-based output for a number of query results.

Types

type JSONResult

type JSONResult struct {
	TotalResults   int                  `json:"totalResults"`
	Results        []*comparer.Result   `json:"results,omitempty"`
	IncludePassing bool                 `json:"includePassing"`
	QueryTweaks    []*config.QueryTweak `json:"queryTweaks,omitempty"`
}

JSONResult is the JSON output format.

type Outputter

type Outputter func(results []*comparer.Result, includePassing bool, tweaks []*config.QueryTweak)

An Outputter outputs a number of test results.

func HTML

func HTML(tplFile string) (Outputter, error)

HTML produces HTML output for a number of query results.