stacklock

Documentation

Overview

Package stacklock extracts stack.yaml.lock files from haskell projects.

Index

• Constants
• func NewDefault() filesystem.Extractor
• type Config
  • func DefaultConfig() Config
• type Extractor
  • func New(cfg Config) *Extractor
  • func (e Extractor) Config() Config
  • func (e Extractor) Extract(ctx context.Context, input *filesystem.ScanInput) (inventory.Inventory, error)
  • func (e Extractor) FileRequired(api filesystem.FileAPI) bool
  • func (e Extractor) Name() string
  • func (e Extractor) Requirements() *plugin.Capabilities
  • func (e Extractor) Version() int

Constants

const (
	// Name is the unique name of this extractor.
	Name = "haskell/stacklock"
)

Functions

func NewDefault

func NewDefault() filesystem.Extractor

NewDefault returns an extractor with the default config settings.

Types

type Config

type Config struct {
	// Stats is a stats collector for reporting metrics.
	Stats stats.Collector
	// MaxFileSizeBytes is the maximum file size this extractor will unmarshal. If
	// `FileRequired` gets a bigger file, it will return false,
	MaxFileSizeBytes int64
}

Config is the configuration for the Extractor.

func DefaultConfig

func DefaultConfig() Config

DefaultConfig returns the default configuration for the extractor.

type Extractor

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

Extractor extracts stacklock package info from stack.yaml.lock files.

func New

func New(cfg Config) *Extractor

New returns a haskell stacklock extractor.

func (Extractor) Config

func (e Extractor) Config() Config

Config returns the configuration of the extractor.

func (Extractor) Extract

func (e Extractor) Extract(ctx context.Context, input *filesystem.ScanInput) (inventory.Inventory, error)

Extract extracts packages from the stack.yaml.lock file.

func (Extractor) FileRequired

func (e Extractor) FileRequired(api filesystem.FileAPI) bool

FileRequired return true if the specified file matched the stack.yaml.lock file pattern.

func (Extractor) Name

func (e Extractor) Name() string

Name of the extractor

func (Extractor) Requirements

func (e Extractor) Requirements() *plugin.Capabilities

Requirements of the extractor.

func (Extractor) Version

func (e Extractor) Version() int

Version of the extractor