format

package

v0.0.0-...-4cf0a74 Latest Latest Go to latest Published: Apr 29, 2024 License: Apache-2.0 Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func DisplayColorSchemes()

DisplayColorSchemes outputs a quick preview of the configured color scheme to stdout.

func Print[T PrintDocument](formatter *Formatter, document T) error

Print renders the given document using the configured formatter

func RenderMatchShort(match *grype.Match) string

RenderMatchShort Renders a match as a single line of colored text

type Formatter struct {
	// contains filtered or unexported fields
}

Formatter can be used to format grype reports for output use NewFormatter to configure a new formatter.

func NewFormatter(format string, writer io.Writer) *Formatter

NewFormatter configures a new formatter for handling grype documents

func (f *Formatter) PrintDiff(diff *grype.DocumentDiff) error

PrintDiff renders the given diff using the configured formatter

type PrintDocument interface {
	*grype.Document | *syft.Document
}

PrintDocument is a union type for grype and syft documents