scanner

Documentation

Index

• type LicenseChecker
  • func NewLicenseChecker(configuration *config.Config) (*LicenseChecker, error)
  • func (c *LicenseChecker) Check(pkgName string, licenseSearchResult LicenseSearchResult)
• type LicenseSearchResult
• type LicensesOutputHandler
  • func NewLicensesOutputHandler(settings config.OutputSettings, handler licensesOutputHandlerFn) *LicensesOutputHandler
  • func (h *LicensesOutputHandler) GetPrinter() (*OutputPrinter, error)
  • func (h *LicensesOutputHandler) HandleLicensesOutput() (err error)
• type LicensesScanner
  • func NewLicenseScanner() *LicensesScanner
  • func (l *LicensesScanner) GetLicenses(root string) (licenses map[string]LicenseSearchResult, err error)
• type OutputPrinter
  • func NewOutputPrinter(outputTemplate string) (*OutputPrinter, error)
  • func (l *OutputPrinter) AddData(level, message, pkgName, license string, direct bool)
  • func (l *OutputPrinter) Print() (err error)
  • func (l *OutputPrinter) PrintJSON() (err error)
• type PackageInfo
• type PackagesScanner
  • func NewPackagesScanner() *PackagesScanner
  • func (s *PackagesScanner) GetPackages(root string) (map[string]*PackageInfo, error)
• type StateHandlerFn

Types

type LicenseChecker

type LicenseChecker struct {
	OkStateHandler              StateHandlerFn
	ExceptionedStateHandler     StateHandlerFn
	CriteriaUnknownStateHandler StateHandlerFn
	CriticalStateHandler        StateHandlerFn
	// contains filtered or unexported fields
}

func NewLicenseChecker

func NewLicenseChecker(configuration *config.Config) (*LicenseChecker, error)

func (*LicenseChecker) Check

func (c *LicenseChecker) Check(pkgName string, licenseSearchResult LicenseSearchResult)

type LicenseSearchResult

type LicenseSearchResult struct {
	License *license.License
	Error   error
	Direct  bool
}

type LicensesOutputHandler

type LicensesOutputHandler struct {
	Printer *OutputPrinter
	// contains filtered or unexported fields
}

func NewLicensesOutputHandler

func NewLicensesOutputHandler(settings config.OutputSettings, handler licensesOutputHandlerFn) *LicensesOutputHandler

func (*LicensesOutputHandler) GetPrinter

func (h *LicensesOutputHandler) GetPrinter() (*OutputPrinter, error)

func (*LicensesOutputHandler) HandleLicensesOutput

func (h *LicensesOutputHandler) HandleLicensesOutput() (err error)

type LicensesScanner

type LicensesScanner struct{}

func NewLicenseScanner

func NewLicenseScanner() *LicensesScanner

func (*LicensesScanner) GetLicenses

func (l *LicensesScanner) GetLicenses(root string) (licenses map[string]LicenseSearchResult, err error)

type OutputPrinter

type OutputPrinter struct {
	Lines []*outputLine
	// contains filtered or unexported fields
}

func NewOutputPrinter

func NewOutputPrinter(outputTemplate string) (*OutputPrinter, error)

func (*OutputPrinter) AddData

func (l *OutputPrinter) AddData(level, message, pkgName, license string, direct bool)

func (*OutputPrinter) Print

func (l *OutputPrinter) Print() (err error)

func (*OutputPrinter) PrintJSON

func (l *OutputPrinter) PrintJSON() (err error)

type PackageInfo

type PackageInfo struct {
	FromVendor bool
}

type PackagesScanner

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

func NewPackagesScanner

func NewPackagesScanner() *PackagesScanner

func (*PackagesScanner) GetPackages

func (s *PackagesScanner) GetPackages(root string) (map[string]*PackageInfo, error)

type StateHandlerFn

type StateHandlerFn func(pkgName string, licenseSearchResult LicenseSearchResult)