licensing

Documentation

Index

• Constants
• func Classify(filePath string, r io.Reader, confidenceLevel float64) (*types.LicenseFile, error)
• func LaxSplitLicenses(str string) []string
• func Normalize(name string) string
• func NormalizeLicense(name string) expr.SimpleExpr
• func SplitLicenses(str string) []string
• func TrimLicenseText(text string) string
• type Scanner
  • func NewScanner(categories map[types.LicenseCategory][]string) Scanner
  • func (s *Scanner) Scan(licenseName string) (types.LicenseCategory, string)
• type ScannerOption

Constants

const (
	LicenseTextPrefix   = "text://"
	LicenseFilePrefix   = "file://"
	CustomLicensePrefix = "CUSTOM License"
)

Functions

func Classify

func Classify(filePath string, r io.Reader, confidenceLevel float64) (*types.LicenseFile, error)

Classify detects and classifies the license found in a file

func LaxSplitLicenses

func LaxSplitLicenses(str string) []string

Split license string considering spaces as separator e.g. MPL 2.0 GPL2+ => {"MPL2.0", "GPL2+"}

func Normalize

func Normalize(name string) string

func NormalizeLicense

func NormalizeLicense(name string) expr.SimpleExpr

func SplitLicenses

func SplitLicenses(str string) []string

func TrimLicenseText

func TrimLicenseText(text string) string

Types

type Scanner

type Scanner struct {
	// contains filtered or unexported fields
}

func NewScanner

func NewScanner(categories map[types.LicenseCategory][]string) Scanner

func (*Scanner) Scan

func (s *Scanner) Scan(licenseName string) (types.LicenseCategory, string)

type ScannerOption

type ScannerOption struct {
	IgnoredLicenses   []string
	LicenseCategories map[types.LicenseCategory][]string
}