presenter

Documentation

Index

• Variables
• type Config
  • func ValidatedConfig(output, outputTemplateFile string) (Config, error)
• type Presenter
  • func GetPresenter(presenterConfig Config, matches match.Matches, ...) Presenter

Variables

var AvailableFormats = []format{
	jsonFormat,
	tableFormat,
	cycloneDXFormat,
	templateFormat,
}

AvailableFormats is a list of presenter format options available to users.

Types

type Config

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

Config is the presenter domain's configuration data structure.

func ValidatedConfig

func ValidatedConfig(output, outputTemplateFile string) (Config, error)

ValidatedConfig returns a new, validated presenter.Config. If a valid Config cannot be created using the given input, an error is returned.

type Presenter

type Presenter interface {
	Present(io.Writer) error
}

Presenter is the main interface other Presenters need to implement

func GetPresenter

func GetPresenter(presenterConfig Config, matches match.Matches, ignoredMatches []match.IgnoredMatch, packages []pkg.Package, context pkg.Context, metadataProvider vulnerability.MetadataProvider, appConfig interface{}, dbStatus interface{}) Presenter

GetPresenter retrieves a Presenter that matches a CLI option