plugins

package
v1.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 11, 2026 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

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
}

Plugin Interface to be implemented by all plugins

type PluginConstructor

type PluginConstructor func() (Plugin, error)

PluginConstructor 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

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL