plugins

Documentation

Index

• func PluginSliceToString(plugins []Plugin) string
• type Plugin
• type PluginConstructor
• type PluginType

Functions

func PluginSliceToString

func PluginSliceToString(plugins []Plugin) string

Types

type Plugin

type Plugin interface {
	GetName() string                                        // return a name for the plugin
	GetExplanation() string                                 // explain the functionality of this plugin
	GetType() PluginType                                    // return the plugin type
	UpdateBOM(fs filesystem.Filesystem, bom *cdx.BOM) error // Update BOM using found files
}

Interface to be implemented by all plugins

type PluginConstructor

type PluginConstructor func() (Plugin, error)

This PluginConstructor function should be exposed by all plugin packages

type PluginType

type PluginType int

const (
	PluginTypeAppend PluginType = iota + 1
	PluginTypeVerify
	PluginTypeOther
)

A list of possible plugin types

Important: order these in the way you want to run the plugins; e.g. here the plugins are running in this order: PluginTypeAppend -> PluginTypeVerify -> PluginTypeOther