Documentation
¶
Overview ¶
Package mixlock extracts elixir mix.lock files.
Index ¶
- Constants
- func NewDefault() filesystem.Extractor
- type Config
- type 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 ¶
View Source
const (
// Name is the unique name of this extractor.
Name = "elixir/mixlock"
)
Variables ¶
This section is empty.
Functions ¶
func NewDefault ¶ added in v0.1.7
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 Elixir extractor.
func DefaultConfig ¶
func DefaultConfig() Config
DefaultConfig returns the default configuration for the Elixir extractor.
type Extractor ¶
type Extractor struct {
// contains filtered or unexported fields
}
Extractor structure for mix.lock files.
func New ¶
New returns an Elixir extractor.
For most use cases, initialize with: ``` e := New(DefaultConfig()) ```
func (Extractor) Extract ¶
func (e Extractor) Extract(ctx context.Context, input *filesystem.ScanInput) (inventory.Inventory, error)
Extract parses the mix.lock file to extract Elixir package dependencies.
func (Extractor) FileRequired ¶
func (e Extractor) FileRequired(api filesystem.FileAPI) bool
FileRequired returns true if the specified file matches the mix.lock pattern.
func (Extractor) Requirements ¶
func (e Extractor) Requirements() *plugin.Capabilities
Requirements of the extractor.
Source Files
Click to show internal directories.
Click to hide internal directories.