detection

Documentation

Index

• type LicenceDetector
  • func NewLicenceDetector() LicenceDetector
• type LicenceMatch
• type Result

Types

type LicenceDetector

type LicenceDetector interface {
	Detect(paths []string) ([]Result, error)
}

LicenceDetector defines the behaviour for Licence detectors

func NewLicenceDetector

func NewLicenceDetector() LicenceDetector

NewLicenceDetector creates a new LicenceDetector

type LicenceMatch

type LicenceMatch struct {
	Licence    string  `json:"license"`
	Confidence float32 `json:"confidence"`
}

LicenceMatch describes the level of confidence for the detected Licence

type Result

type Result struct {
	Project string         `json:"project,omitempty"`
	Matches []LicenceMatch `json:"matches,omitempty"`
	ErrStr  string         `json:"error,omitempty"`
}

Result is a representation of the Licence detection outcome for a project