jsdependency

Documentation

Index

• func AddCommand(packageManager Tool, commandScope CommandScope, pkg ...string) (*command.Model, error)
• func RemoveCommand(packageManager Tool, commandScope CommandScope, pkg ...string) (*command.Model, error)
• type CommandScope
• type InstallCommand
  • func InstallGlobalDependencyCommand(packageManager Tool, dependency string, version string) ([]InstallCommand, error)
• type Tool
  • func DetectTool(absPackageJSONDir string) (Tool, error)

Functions

func AddCommand

func AddCommand(packageManager Tool, commandScope CommandScope, pkg ...string) (*command.Model, error)

AddCommand returns command model to install js dependencies

func RemoveCommand

func RemoveCommand(packageManager Tool, commandScope CommandScope, pkg ...string) (*command.Model, error)

RemoveCommand returns command model to remove js dependencies

Types

type CommandScope

type CommandScope string

CommandScope describes package manager command scope (global, or not)

const (
	Local  CommandScope = "local"
	Global CommandScope = "global"
)

PackageScope types

type InstallCommand

type InstallCommand struct {
	Slice       *command.Model
	IgnoreError bool
}

InstallCommand contains the command to be executed and wether the resulting error can be ignored. (yarn exits with error if removing a not yet added package)

func InstallGlobalDependencyCommand

func InstallGlobalDependencyCommand(packageManager Tool, dependency string, version string) ([]InstallCommand, error)

InstallGlobalDependencyCommand returns command model to install a global js dependency

type Tool

type Tool string

Tool identifies a package manager tool

const (
	Npm  Tool = "npm"
	Yarn Tool = "yarn"
)

Package manager types

func DetectTool

func DetectTool(absPackageJSONDir string) (Tool, error)

DetectTool returns the Js package manager used, e.g. npm or yarn