podfilelock

Documentation

Overview

Package podfilelock extracts dependencies from Podfile.lock files.

Index

• Constants
• type Config
  • func DefaultConfig() Config
• type Extractor
  • func New(cfg Config) *Extractor
  • func (e Extractor) Config() Config
  • func (Extractor) Ecosystem(_ *extractor.Inventory) string
  • func (e Extractor) Extract(ctx context.Context, input *filesystem.ScanInput) ([]*extractor.Inventory, error)
  • func (e Extractor) FileRequired(api filesystem.FileAPI) bool
  • func (e Extractor) Name() string
  • func (e Extractor) Requirements() *plugin.Capabilities
  • func (e Extractor) ToPURL(i *extractor.Inventory) *purl.PackageURL
  • func (e Extractor) Version() int

Constants

const Name = "swift/podfilelock"

Name is the unique name of this extractor.

Types

type Config

type Config struct {
	Stats            stats.Collector
	MaxFileSizeBytes int64
}

Config represents 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 dependencies from Podfile.lock files.

func New

func New(cfg Config) *Extractor

New creates a new instance of the Podfile.lock extractor.

func (Extractor) Config

func (e Extractor) Config() Config

Config returns the configuration of the extractor.

func (Extractor) Ecosystem

func (Extractor) Ecosystem(_ *extractor.Inventory) string

Ecosystem returns the OSV ecosystem name for CocoaPods.

func (Extractor) Extract

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

Extract processes and extracts dependency information from a Podfile.lock file.

func (Extractor) FileRequired

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

FileRequired checks if a file is named Podfile.lock and meets size constraints.

func (Extractor) Name

func (e Extractor) Name() string

Name returns the extractor's name.

func (Extractor) Requirements

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

Requirements defines the extractor's capabilities.

func (Extractor) ToPURL

func (e Extractor) ToPURL(i *extractor.Inventory) *purl.PackageURL

ToPURL converts an inventory item into a Package URL (PURL).

func (Extractor) Version

func (e Extractor) Version() int

Version returns the extractor's version.