cyclondx

Documentation

Overview

Package cyclondx provides utilities for showing results in cyclondx format

Index

• type Presenter
  • func NewPresenter(provider Provider) *Presenter
  • func (p Presenter) Footer() string
  • func (p Presenter) Present(output io.Writer) error
  • func (p Presenter) Title() string
• type Provider

Types

type Presenter

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

Presenter will show the analyzed result in json format.

func NewPresenter

func NewPresenter(provider Provider) *Presenter

NewPresenter will init a JSONPresenter.

func (Presenter) Footer

func (p Presenter) Footer() string

Footer is the footer of the json output.

func (Presenter) Present

func (p Presenter) Present(output io.Writer) error

Present will convert the result into json format and pass to io.Writer.

func (Presenter) Title

func (p Presenter) Title() string

Title is the title of the json output.

type Provider

type Provider interface {
	Title() string
	Footer() string
	CycloneDXDoc() ([]byte, error)
}

Provider implement the methods needed for creating cycloneDx xml.