pnpmlock

Documentation

Overview

Package pnpmlock extracts pnpm-lock.yaml files.

Index

• Constants
• func New() filesystem.Extractor
• type Extractor
  • func (e Extractor) Ecosystem(p *extractor.Package) string
  • 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) ToPURL(p *extractor.Package) *purl.PackageURL
  • func (e Extractor) Version() int

Constants

const (
	// Name is the unique name of this extractor.
	Name = "javascript/pnpmlock"
)

Functions

func New

func New() filesystem.Extractor

New returns a new instance of the extractor.

Types

type Extractor

type Extractor struct{}

Extractor extracts pnpm-lock.yaml files.

func (Extractor) Ecosystem

func (e Extractor) Ecosystem(p *extractor.Package) string

Ecosystem returns the OSV Ecosystem of the software extracted by this extractor.

func (Extractor) Extract

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

Extract extracts packages from a pnpm-lock.yaml file passed through the scan input.

func (Extractor) FileRequired

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

FileRequired returns true if the specified file matches pnpm-lock.yaml files.

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) ToPURL

func (e Extractor) ToPURL(p *extractor.Package) *purl.PackageURL

ToPURL converts a package created by this extractor into a PURL.

func (Extractor) Version

func (e Extractor) Version() int

Version of the extractor