npm

Documentation

Index

• type ExecRunner
• type Execute
  • func (exec *Execute) FindPackageJSONFiles() []string
  • func (exec *Execute) FindPackageJSONFilesWithExcludes(excludeList []string) ([]string, error)
  • func (exec *Execute) FindPackageJSONFilesWithScript(packageJSONFiles []string, script string) ([]string, error)
  • func (exec *Execute) InstallAllDependencies(packageJSONFiles []string) error
  • func (exec *Execute) RunScriptsInAllPackages(runScripts []string, runOptions []string, scriptOptions []string, ...) error
  • func (exec *Execute) SetNpmRegistries() error
• type Executor
  • func NewExecutor(executorOptions ExecutorOptions) Executor
• type ExecutorOptions
• type Utils

Types

type ExecRunner

type ExecRunner interface {
	SetEnv(e []string)
	Stdout(out io.Writer)
	Stderr(out io.Writer)
	RunExecutable(executable string, params ...string) error
	RunExecutableInBackground(executable string, params ...string) (command.Execution, error)
}

ExecRunner interface to enable mocking for testing

type Execute

type Execute struct {
	Utils   Utils
	Options ExecutorOptions
}

Execute struct holds utils to enable mocking and common parameters

func (*Execute) FindPackageJSONFiles

func (exec *Execute) FindPackageJSONFiles() []string

FindPackageJSONFiles returns a list of all package.json files of the project excluding node_modules and gen/ directories

func (*Execute) FindPackageJSONFilesWithExcludes

func (exec *Execute) FindPackageJSONFilesWithExcludes(excludeList []string) ([]string, error)

FindPackageJSONFilesWithExcludes returns a list of all package.json files of the project excluding node_modules, gen/ and directories/patterns defined by excludeList

func (*Execute) FindPackageJSONFilesWithScript

func (exec *Execute) FindPackageJSONFilesWithScript(packageJSONFiles []string, script string) ([]string, error)

FindPackageJSONFilesWithScript returns a list of package.json fileUtils that contain the script

func (*Execute) InstallAllDependencies

func (exec *Execute) InstallAllDependencies(packageJSONFiles []string) error

InstallAllDependencies executes npm or yarn Install for all package.json fileUtils defined in packageJSONFiles

func (*Execute) RunScriptsInAllPackages

func (exec *Execute) RunScriptsInAllPackages(runScripts []string, runOptions []string, scriptOptions []string, virtualFrameBuffer bool, excludeList []string) error

RunScriptsInAllPackages runs all scripts defined in ExecuteOptions.RunScripts

func (*Execute) SetNpmRegistries

func (exec *Execute) SetNpmRegistries() error

SetNpmRegistries configures the given npm registries. CAUTION: This will change the npm configuration in the user's home directory.

type Executor

type Executor interface {
	FindPackageJSONFiles() []string
	FindPackageJSONFilesWithExcludes(excludeList []string) ([]string, error)
	FindPackageJSONFilesWithScript(packageJSONFiles []string, script string) ([]string, error)
	RunScriptsInAllPackages(runScripts []string, runOptions []string, scriptOptions []string, virtualFrameBuffer bool, excludeList []string) error
	InstallAllDependencies(packageJSONFiles []string) error
	SetNpmRegistries() error
}

Executor interface to enable mocking for testing

func NewExecutor

func NewExecutor(executorOptions ExecutorOptions) Executor

NewExecutor instantiates Execute struct and sets executeOptions

type ExecutorOptions

type ExecutorOptions struct {
	DefaultNpmRegistry string
	ExecRunner         ExecRunner
}

ExecutorOptions holds common parameters for functions of Executor

type Utils

type Utils interface {
	Chdir(path string) error
	FileExists(filename string) (bool, error)
	FileRead(path string) ([]byte, error)
	Getwd() (string, error)
	Glob(pattern string) (matches []string, err error)

	GetExecRunner() ExecRunner
}

Utils interface for mocking