licensei

Documentation

Index

• func NewAggregatedDependencySource(logger *slog.Logger) *aggregatedDependencySource
• func NewCacheProjectSource(delegatedDependencySource dependencySource, logger *slog.Logger) *cacheDependencySource
• func NewDepDependencySource() *depDependencySource
• func NewGoModDependencySource(logger *slog.Logger) *gomodDependencySource
• func NewJSONListView(output io.Writer) *jsonListView
• func NewTableListView(output io.Writer) *tableListView
• func WriteCache(w io.Writer, dependencies []Dependency) error
• type Dependency
  • func ReadCache(r io.Reader) ([]Dependency, error)
• type HeaderChecker
  • func (c HeaderChecker) Check(root string, template string) (HeaderViolations, error)
• type HeaderViolations
• type LicenseDetector
  • func NewLicenseDetector(githubToken string, logger *slog.Logger) *LicenseDetector
  • func (d *LicenseDetector) Detect(dependencies []Dependency) ([]Dependency, error)
• type ListDependencyItem
• type ListViewModel

Functions

func NewAggregatedDependencySource

func NewAggregatedDependencySource(logger *slog.Logger) *aggregatedDependencySource

func NewCacheProjectSource

func NewCacheProjectSource(delegatedDependencySource dependencySource, logger *slog.Logger) *cacheDependencySource

func NewDepDependencySource

func NewDepDependencySource() *depDependencySource

func NewGoModDependencySource

func NewGoModDependencySource(logger *slog.Logger) *gomodDependencySource

func NewJSONListView

func NewJSONListView(output io.Writer) *jsonListView

NewJSONListView returns a view that outputs a license list as JSON.

func NewTableListView

func NewTableListView(output io.Writer) *tableListView

NewTableListView returns a view that outputs a license list as JSON.

func WriteCache

func WriteCache(w io.Writer, dependencies []Dependency) error

WriteCache writes the generated cache to file.

Types

type Dependency

type Dependency struct {
	Name       string  `toml:"name"`
	Revision   string  `toml:"revision"`
	License    string  `toml:"license"`
	Confidence float32 `toml:"confidence"`
	Type       string  `toml:"type"`
}

func ReadCache

func ReadCache(r io.Reader) ([]Dependency, error)

ReadCache reads the cache from file.

type HeaderChecker

type HeaderChecker struct {
	IgnorePaths []string
	IgnoreFiles []string
	Authors     []string
}

func (HeaderChecker) Check

func (c HeaderChecker) Check(root string, template string) (HeaderViolations, error)

nolint: gocognit

type HeaderViolations

type HeaderViolations map[string]string

type LicenseDetector

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

func NewLicenseDetector

func NewLicenseDetector(githubToken string, logger *slog.Logger) *LicenseDetector

func (*LicenseDetector) Detect

func (d *LicenseDetector) Detect(dependencies []Dependency) ([]Dependency, error)

type ListDependencyItem

type ListDependencyItem struct {
	Name       string  `json:"name"`
	License    string  `json:"license"`
	Confidence float32 `json:"confidence"`
}

ListDependencyItem represents an item in the list view.

type ListViewModel

type ListViewModel struct {
	Dependencies []ListDependencyItem `json:"dependencies"`
}

ListViewModel holds information for a list view.