npm

Documentation

Index

• Variables
• func FromLockfile(path string, devDeps bool) (graph.Deps, error)
• func FromNodeModules(path string, devDeps bool) (graph.Deps, error)
• func PackageFromManifest(devDeps bool, pathElems ...string) (pkg.Package, error)
• type DeepDepIdsSet
• type Dependencies
• type DependencyLockEntry
• type DependencyMap
• type Lockfile
  • func FindAndReadLockfile(path string) (Lockfile, error)
• type Manifest
  • func FromManifest(pathElems ...string) (Manifest, error)
• type NPM
  • func New() (NPM, error)
• type Options
• type Output
• type SystemNPM
  • func (n SystemNPM) Clean(dir string) error
  • func (n SystemNPM) Exists() bool
  • func (n SystemNPM) Install(dir string) error
  • func (n SystemNPM) List(dir string, devDeps bool) (Output, error)

Variables

var PossibleLockfileFilenames = []string{"npm-shrinkwrap.json", "package-lock.json"}

Functions

func FromLockfile

func FromLockfile(path string, devDeps bool) (graph.Deps, error)

FromLockfile generates the dep graph based on the lockfile provided at the supplied path.

func FromNodeModules

func FromNodeModules(path string, devDeps bool) (graph.Deps, error)

FromNodeModules generates the dep graph based on the manifest provided at the supplied path

func PackageFromManifest

func PackageFromManifest(devDeps bool, pathElems ...string) (pkg.Package, error)

PackageFromManifest generates a package definition for the provided manifest in the supplied directory. Performs revision resolution

Types

type DeepDepIdsSet

type DeepDepIdsSet map[pkg.ID]bool

type Dependencies

type Dependencies map[string]*DependencyLockEntry

type DependencyLockEntry

type DependencyLockEntry struct {
	Version      string
	Requires     map[string]string
	Dependencies Dependencies
}

type DependencyMap

type DependencyMap map[pkg.ID][]pkg.ID

type Lockfile

type Lockfile struct {
	Name         string
	Version      string
	Dependencies Dependencies
}

func FindAndReadLockfile

func FindAndReadLockfile(path string) (Lockfile, error)

FindAndReadLockfile checks the root of the node project at the given path for lockfiles, then returns the parsed contents if one is found.

type Manifest

type Manifest struct {
	Name            string
	Version         string
	Dependencies    map[string]string
	DevDependencies map[string]string
}

func FromManifest

func FromManifest(pathElems ...string) (Manifest, error)

FromManifest creates a manifest from the filepath provided

type NPM

type NPM interface {
	List(dir string, devDeps bool) (Output, error)
	Clean(dir string) error
	Install(dir string) error
	Exists() bool
}

func New

func New() (NPM, error)

type Options

type Options struct {
	AllowNPMErr bool `mapstructure:"allow-npm-err"`
}

type Output

type Output struct {
	Version      string
	From         string
	Resolved     string
	Dependencies map[string]Output
}

type SystemNPM

type SystemNPM struct {
	Cmd      string
	AllowErr bool
}

func (SystemNPM) Clean

func (n SystemNPM) Clean(dir string) error

func (SystemNPM) Exists

func (n SystemNPM) Exists() bool

func (SystemNPM) Install

func (n SystemNPM) Install(dir string) error

func (SystemNPM) List

func (n SystemNPM) List(dir string, devDeps bool) (Output, error)