scan

Documentation

Index

• type Config
• type Decision
  • func (d Decision) MarshalText() ([]byte, error)
• type EvaluatedModule
  • func (r EvaluatedModule) Allowed() bool
  • func (r EvaluatedModule) ExplainDecision() string
• type Exceptions
• type LicenseNotPermitted
• type Override
• type Summary
  • func Run(ctx context.Context, conf Config, binPaths ...string) (Summary, error)
• type UnresolvableLicense

Types

type Config

type Config struct {
	Threshold  *float64   `yaml:"threshold"`
	Allow      []string   `yaml:"allow"`
	Exceptions Exceptions `yaml:"exceptions"`
	Overrides  []Override `yaml:"override"`
}

type Decision

type Decision int

const (
	DecisionAllowed Decision = 1 + iota
	DecisionNotAllowedUnresolvableLicense
	DecisionNotAllowedLicenseNotPermitted
)

func (Decision) MarshalText

func (d Decision) MarshalText() ([]byte, error)

type EvaluatedModule

type EvaluatedModule struct {
	model.Module
	Decision     Decision
	NotPermitted []string `json:",omitempty"`
	UsedBy       []string
}

func (EvaluatedModule) Allowed

func (r EvaluatedModule) Allowed() bool

func (EvaluatedModule) ExplainDecision

func (r EvaluatedModule) ExplainDecision() string

type Exceptions

type Exceptions struct {
	LicenseNotPermitted []LicenseNotPermitted `yaml:"licenseNotPermitted"`
	UnresolvableLicense []UnresolvableLicense `yaml:"unresolvableLicense"`
}

type LicenseNotPermitted

type LicenseNotPermitted struct {
	Path     string   `yaml:"path"`
	Version  string   `yaml:"version"`
	Licenses []string `yaml:"licenses"`
}

type Override

type Override struct {
	Path     string   `yaml:"path"`
	Version  string   `yaml:"version"`
	Licenses []string `yaml:"licenses"`
}

type Summary

type Summary struct {
	Modules  []EvaluatedModule
	Binaries []model.BuildInfo
}

func Run

func Run(ctx context.Context, conf Config, binPaths ...string) (Summary, error)

type UnresolvableLicense

type UnresolvableLicense struct {
	Path    string `yaml:"path"`
	Version string `yaml:"version"`
}