licensedetect

Documentation

Overview

Package licensedetect exposes cyclonedx-gomod's license detection functionality.

Index

• type Detector

Types

type Detector

type Detector interface {
	Detect(path, version, dir string) ([]cdx.License, error)
}

Detector is the interface that provides abstraction for license detection strategies.

Detectors are provided with a module's path, version, and local directory (in Go's module cache). The latter may be empty, if the module has not been downloaded to the module cache.