licenses

Documentation

Index

• func FileNames() []string
• func Search(ctx context.Context, scanner Scanner, reader file.LocationReadCloser) (licenses []pkg.License, err error)
• func SetContextLicenseScanner(ctx context.Context, s Scanner) context.Context
• type Scanner
  • func ContextLicenseScanner(ctx context.Context) Scanner
  • func NewDefaultScanner() Scanner
  • func TestingOnlyScanner() Scanner

Functions

func FileNames

func FileNames() []string

func Search

func Search(ctx context.Context, scanner Scanner, reader file.LocationReadCloser) (licenses []pkg.License, err error)

Search scans the contents of a license file to attempt to determine the type of license it is

func SetContextLicenseScanner

func SetContextLicenseScanner(ctx context.Context, s Scanner) context.Context

Types

type Scanner

type Scanner interface {
	IdentifyLicenseIDs(context.Context, io.Reader) ([]string, error)
}

func ContextLicenseScanner

func ContextLicenseScanner(ctx context.Context) Scanner

func NewDefaultScanner

func NewDefaultScanner() Scanner

NewDefaultScanner returns a scanner that uses a new instance of the default licensecheck package scanner.

func TestingOnlyScanner

func TestingOnlyScanner() Scanner

TestingOnlyScanner returns a scanner that uses the built-in license scanner from the licensecheck package. THIS IS ONLY MEANT FOR TEST CODE, NOT PRODUCTION CODE.