npmutils

Documentation

Index

• func CalculateDependenciesList(typeRestriction TypeRestriction, npmArgs []string, ...) (dependenciesList map[string]*Dependency, err error)
• func GetNpmVersionAndExecPath() (*version.Version, string, error)
• func IsNpmCommand(cmd string) bool
• func RunList(flags, executablePath string) (stdResult, errResult []byte, err error)
• func Version(executablePath string) (*version.Version, error)
• type Dependency
  • func (dep *Dependency) GetPathToRoot() [][]string
• type NpmConfig
  • func (config *NpmConfig) GetCmd() *exec.Cmd
  • func (config *NpmConfig) GetEnv() map[string]string
  • func (config *NpmConfig) GetErrWriter() io.WriteCloser
  • func (config *NpmConfig) GetStdWriter() io.WriteCloser
• type PackageInfo
  • func ReadPackageInfo(data []byte, npmVersion *version.Version) (*PackageInfo, error)
  • func ReadPackageInfoFromPackageJson(packageJsonDirectory string, npmVersion *version.Version) (*PackageInfo, error)
  • func (pi *PackageInfo) BuildInfoModuleId() string
  • func (pi *PackageInfo) FullName() string
  • func (pi *PackageInfo) GetDeployPath() string
• type TypeRestriction

Functions

func CalculateDependenciesList

func CalculateDependenciesList(typeRestriction TypeRestriction, npmArgs []string, executablePath, buildInfoModuleId string) (dependenciesList map[string]*Dependency, err error)

func GetNpmVersionAndExecPath

func GetNpmVersionAndExecPath() (*version.Version, string, error)

func IsNpmCommand

func IsNpmCommand(cmd string) bool

func RunList

func RunList(flags, executablePath string) (stdResult, errResult []byte, err error)

func Version

func Version(executablePath string) (*version.Version, error)

Types

type Dependency

type Dependency struct {
	Name       string
	Version    string
	Scopes     []string
	FileType   string
	Checksum   *buildinfo.Checksum
	PathToRoot [][]string
}

func (*Dependency) GetPathToRoot

func (dep *Dependency) GetPathToRoot() [][]string

type NpmConfig

type NpmConfig struct {
	Npm          string
	Command      []string
	CommandFlags []string
	StrWriter    io.WriteCloser
	ErrWriter    io.WriteCloser
}

func (*NpmConfig) GetCmd

func (config *NpmConfig) GetCmd() *exec.Cmd

func (*NpmConfig) GetEnv

func (config *NpmConfig) GetEnv() map[string]string

func (*NpmConfig) GetErrWriter

func (config *NpmConfig) GetErrWriter() io.WriteCloser

func (*NpmConfig) GetStdWriter

func (config *NpmConfig) GetStdWriter() io.WriteCloser

type PackageInfo

type PackageInfo struct {
	Name    string `json:"name,omitempty"`
	Version string `json:"version,omitempty"`
	Scope   string
}

func ReadPackageInfo

func ReadPackageInfo(data []byte, npmVersion *version.Version) (*PackageInfo, error)

func ReadPackageInfoFromPackageJson

func ReadPackageInfoFromPackageJson(packageJsonDirectory string, npmVersion *version.Version) (*PackageInfo, error)

func (*PackageInfo) BuildInfoModuleId

func (pi *PackageInfo) BuildInfoModuleId() string

func (*PackageInfo) FullName

func (pi *PackageInfo) FullName() string

func (*PackageInfo) GetDeployPath

func (pi *PackageInfo) GetDeployPath() string

type TypeRestriction

type TypeRestriction int

const (
	DefaultRestriction TypeRestriction = iota
	All
	DevOnly
	ProdOnly
)