report

package
v0.10.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 5, 2026 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package report renders scan results as text for terminals, Markdown for tickets and pull requests, and JSON for tools. Reports only ever contain names, counts and categories: never sampled values.

Index

Constants

View Source 
const Headline = "What a plain copy of this database would carry into staging"

Headline is the question every report answers first.

Variables

This section is empty.

Functions

func JSON 

func JSON(w io.Writer, res *model.Result) error

JSON writes the full result as indented JSON.

func Markdown 

func Markdown(w io.Writer, res *model.Result) error

Markdown writes the report as Markdown, for tickets, pull requests and audit folders.

func Text 

func Text(w io.Writer, res *model.Result, opts TextOptions) error

Text writes the terminal report.

Types

type TextOptions 

type TextOptions struct {
	Color      bool   // use ANSI colours
	Verbose    bool   // also list low-confidence matches, relationships and full evidence
	ConfigPath string // where a starter config was written, if anywhere
}

TextOptions control the terminal report.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.