packagelockjson

package

v0.5.3 Latest Latest Go to latest Published: Sep 22, 2026 License: Apache-2.0, BSD-3-Clause, MIT Imports: 23 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/google/osv-scalibr

Links

Documentation ¶

Overview ¶

Package packagelockjson extracts package-lock.json files.

Index ¶

Constants
func DeterminePackageSource(resolved, commit string) metadata.NPMPackageSource
func New(cfg *cpb.PluginConfig) (filesystem.Extractor, error)
type Extractor

Constants ¶

View Source

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

Variables ¶

This section is empty.

Functions ¶

func DeterminePackageSource ¶ added in v0.5.3

func DeterminePackageSource(resolved, commit string) metadata.NPMPackageSource

DeterminePackageSource determines the source of an npm package based on its resolved field and commit. If it is an HTTP or HTTPS endpoint containing "npm", it is classified as a public registry. Otherwise, if it is an HTTP or git endpoint, it is classified as other. Anything else (e.g. local directory, file: protocol) is classified as local.

func New ¶ added in v0.1.2

func New(cfg *cpb.PluginConfig) (filesystem.Extractor, error)

New returns a package-lock.json extractor.

Types ¶

type Extractor ¶

type Extractor struct {
	Stats stats.Collector
	// contains filtered or unexported fields
}

Extractor extracts npm packages from package-lock.json files.

func (Extractor) Extract ¶

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

Extract extracts packages from package-lock.json files passed through the scan input.

func (Extractor) FileRequired ¶

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

FileRequired returns true if the specified file matches npm lockfile patterns.

func (Extractor) Name ¶

func (e Extractor) Name() string

Name of the extractor.

func (Extractor) Requirements ¶ added in v0.1.3

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

Requirements of the extractor.

func (Extractor) Version ¶

func (e Extractor) Version() int

Version of the extractor.

Source Files ¶

View all Source files

packagelockjson.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL