module

package

v1.10.0 Latest Latest Go to latest Published: Jan 31, 2026 License: Apache-2.0 Imports: 9 Imported by: 0

Details

This section is empty.

This section is empty.

func ToComponent(logger zerolog.Logger, module gomod.Module, options ...Option) (*cdx.Component, error)

ToComponent converts a gomod.Module to a CycloneDX component. The component can be further customized using options, before it's returned.

func ToComponents(logger zerolog.Logger, modules []gomod.Module, options ...Option) ([]cdx.Component, error)

ToComponents converts a slice of gomod.Module to a slice of CycloneDX components.

type Option func(zerolog.Logger, gomod.Module, *cdx.Component) error

func WithComponentType(ctype cdx.ComponentType) Option

WithComponentType overrides the type of the component.

func WithLicenses(detector licensedetect.Detector) Option

WithLicenses attempts to detect licenses for the module using a provided license detector and attach them to the component's license evidence.

func WithModuleHashes() Option

func WithPackages(enabled bool, options ...pkgConv.Option) Option

func WithScope(scope cdx.Scope) Option

WithScope overrides the scope of the component.

func WithShortPURL(enabled bool) Option

WithShortPURL configures the component to use short PURLs without query parameters.

func WithTestScope(scope cdx.Scope) Option

WithTestScope overrides the scope of the component, if the corresponding module has the TestOnly flag set.