presenter

Documentation

Index

• Variables
• type Config
  • func ValidatedConfig(output, outputTemplateFile string, showSuppressed bool) (Config, error)
• type Presenter
  • func GetPresenter(c Config, pb models.PresenterConfig) Presenter

Variables

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

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

var DeprecatedFormats = []format{
	embeddedVEXJSON,
	embeddedVEXXML,
}

DeprecatedFormats TODO: remove in v1.0

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, showSuppressed bool) (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(c Config, pb models.PresenterConfig) Presenter

GetPresenter retrieves a Presenter that matches a CLI option TODO dependency cycle with presenter package to sub formats