npm

package

v1.1.10 Latest Latest Go to latest Published: Jul 13, 2021 License: MPL-2.0 Imports: 9 Imported by: 4

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

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

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(path string, devDeps bool) (graph.Deps, error)

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

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

type DeepDepIdsSet map[pkg.ID]bool

type Dependencies map[string]*DependencyLockEntry

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

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

type Lockfile struct {
	Name         string
	Version      string
	Dependencies Dependencies
}

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 struct {
	Name            string
	Version         string
	Dependencies    map[string]string
	DevDependencies map[string]string
}

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

FromManifest creates a manifest from the filepath provided

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

func New() (NPM, error)

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

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

type SystemNPM struct {
	Cmd      string
	AllowErr bool
}

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)