lockfile

Documentation

Index

• Constants
• func CachedMustCompile(exp string) *regexp.Regexp
• type Dependency
• type DependencyState
• type Ecosystem
• type NpmLockDependency
• type NpmLockPackage
• type NpmLockfile
• type PackageDetails
  • func ParseNpmLock(pathToLockfile string) ([]PackageDetails, error)
  • func ParsePnpmLock(pathToLockfile string) ([]PackageDetails, error)
  • func ParseYarnLock(pathToLockfile string) ([]PackageDetails, error)
• type PackageDetailsParser
• type PackageFlattened
  • func ExpandPackage(packageName string, packages []PackageDetails) (*PackageFlattened, error)
• type PnpmLockPackage
• type PnpmLockPackageResolution
• type PnpmLockfile
  • func (l *PnpmLockfile) UnmarshalYAML(unmarshal func(interface{}) error) error

Constants

const PnpmEcosystem = NpmEcosystem

Functions

func CachedMustCompile

func CachedMustCompile(exp string) *regexp.Regexp

Types

type Dependency

type Dependency struct {
	Name    string
	Version string
}

type DependencyState

type DependencyState struct {
	Package   Dependency
	Processed bool
}

type Ecosystem

type Ecosystem string

const NpmEcosystem Ecosystem = "npm"

type NpmLockDependency

type NpmLockDependency struct {
	Version      string                       `json:"version"`
	Dependencies map[string]NpmLockDependency `json:"dependencies,omitempty"`
}

type NpmLockPackage

type NpmLockPackage struct {
	Version      string            `json:"version"`
	Resolved     string            `json:"resolved"`
	Dependencies map[string]string `json:"dependencies"`
}

type NpmLockfile

type NpmLockfile struct {
	Version int `json:"lockfileVersion"`
	// npm v1- lockfiles use "dependencies"
	Dependencies map[string]NpmLockDependency `json:"dependencies"`
	// npm v2+ lockfiles use "packages"
	Packages map[string]NpmLockPackage `json:"packages,omitempty"`
}

type PackageDetails

type PackageDetails struct {
	Name         string       `json:"name"`
	Version      string       `json:"version"`
	Commit       string       `json:"commit,omitempty"`
	Ecosystem    Ecosystem    `json:"ecosystem,omitempty"`
	CompareAs    Ecosystem    `json:"compareAs,omitempty"`
	Dependencies []Dependency `json:"dependencies,omitempty"`
}

func ParseNpmLock

func ParseNpmLock(pathToLockfile string) ([]PackageDetails, error)

func ParsePnpmLock

func ParsePnpmLock(pathToLockfile string) ([]PackageDetails, error)

func ParseYarnLock

func ParseYarnLock(pathToLockfile string) ([]PackageDetails, error)

type PackageDetailsParser

type PackageDetailsParser = func(pathToLockfile string) ([]PackageDetails, error)

type PackageFlattened

type PackageFlattened struct {
	Name         string
	Version      string
	Dependencies []DependencyState
}

func ExpandPackage

func ExpandPackage(packageName string, packages []PackageDetails) (*PackageFlattened, error)

type PnpmLockPackage

type PnpmLockPackage struct {
	Resolution   PnpmLockPackageResolution `yaml:"resolution"`
	Name         string                    `yaml:"name"`
	Version      string                    `yaml:"version"`
	Dependencies map[string]string         `yaml:"dependencies"`
}

type PnpmLockPackageResolution

type PnpmLockPackageResolution struct {
	Tarball string `yaml:"tarball"`
	Commit  string `yaml:"commit"`
	Repo    string `yaml:"repo"`
	Type    string `yaml:"type"`
}

type PnpmLockfile

type PnpmLockfile struct {
	Version  float64                    `yaml:"lockfileVersion"`
	Packages map[string]PnpmLockPackage `yaml:"packages,omitempty"`
}

func (*PnpmLockfile) UnmarshalYAML

func (l *PnpmLockfile) UnmarshalYAML(unmarshal func(interface{}) error) error