javascript

package
v0.1.0-beta.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 26, 2020 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Overview

Package javascript provides a concrete Cataloger implementation for JavaScript ecosystem files (yarn and npm).

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Cataloger

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

Cataloger catalogs pkg.YarnPkg and pkg.NpmPkg Package Types defined in package-lock.json and yarn.lock files.

func New

func New() *Cataloger

New returns a new JavaScript cataloger object.

func (*Cataloger) Catalog

func (a *Cataloger) Catalog(contents map[file.Reference]string) ([]pkg.Package, error)

Catalog returns the Packages indexed from all Javascript ecosystem files discovered.

func (*Cataloger) Name

func (a *Cataloger) Name() string

Name returns a string that uniquely describes this cataloger.

func (*Cataloger) SelectFiles

func (a *Cataloger) SelectFiles(resolver scope.FileResolver) []file.Reference

SelectFiles returns a set of discovered Javascript ecosystem files from the user content source.

type Dependency

type Dependency struct {
	Version   string `json:"version"`
	Resolved  string `json:"resolved"`
	Integrity string `json:"integrity"`
	Requires  map[string]string
}

Dependency represents a single package dependency listed in the package.lock json file

type PackageLock

type PackageLock struct {
	Requires        bool `json:"requires"`
	LockfileVersion int  `json:"lockfileVersion"`
	Dependencies    map[string]Dependency
}

PackageLock represents a JavaScript package.lock json file

Jump to

Keyboard shortcuts

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