provider

Documentation

Overview

Package provider defines the extension point of the permits library. A new dependency ecosystem is added by implementing Scanner (parse a lockfile into dependencies) and Fetcher (retrieve raw license artifacts for a dependency), then registering them in a Registry. The collector depends only on these interfaces and never on a concrete ecosystem, so third parties can add ecosystems without forking.

Index

• type DirectScanner
• type Fetcher
• type Registry
  • func NewRegistry() *Registry
  • func (r *Registry) FetcherFor(eco model.Ecosystem) (Fetcher, error)
  • func (r *Registry) Register(s Scanner, f Fetcher)
  • func (r *Registry) ScannerFor(path string) (Scanner, bool)
• type Scanner
• type Source

Types

type DirectScanner

type DirectScanner interface {
	Scanner

	ScanDirect(ctx context.Context, path string) ([]model.Dependency, error)
}

DirectScanner is an optional capability: a Scanner that can also restrict results to the project's direct (top-level) dependencies, excluding transitive ones. Providers implement it when the distinction is recoverable (pnpm importers / top-level deps, go.mod non-indirect requires). The collector checks for this interface only when direct-only mode is requested.

type Fetcher

type Fetcher interface {
	Source

	// Fetch returns every license artifact found for dep. Returning an empty slice with a nil
	// error means "fetched, but no license file present".
	Fetch(ctx context.Context, dep model.Dependency) ([]model.LicenseArtifact, error)
}

Fetcher retrieves the raw license artifacts for a single dependency.

type Registry

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

Registry maps an ecosystem to its Scanner and Fetcher.

func NewRegistry

func NewRegistry() *Registry

NewRegistry returns an empty Registry.

func (*Registry) FetcherFor

func (r *Registry) FetcherFor(eco model.Ecosystem) (Fetcher, error)

FetcherFor returns the fetcher registered for the given ecosystem.

func (*Registry) Register

func (r *Registry) Register(s Scanner, f Fetcher)

Register adds a provider's Scanner and Fetcher. Either may be nil if a provider only supplies one half, though both are required for that ecosystem to be usable end to end. A later registration for the same ecosystem replaces the previous Fetcher.

func (*Registry) ScannerFor

func (r *Registry) ScannerFor(path string) (Scanner, bool)

ScannerFor returns the first registered scanner whose [Scanner.Detect] accepts path.

type Scanner

type Scanner interface {
	Source

	// Detect reports whether this scanner handles the given file. It may inspect the filename
	// and/or peek at the file contents.
	Detect(path string) bool

	// Scan parses the file into the resolved dependency set.
	Scan(ctx context.Context, path string) ([]model.Dependency, error)
}

Scanner parses a lockfile/manifest into the set of resolved dependencies.

type Source

type Source interface {
	Ecosystem() model.Ecosystem
}

Source identifies which ecosystem a provider component serves.