npm

Documentation

Index

• type CommonArgs
  • func (ca *CommonArgs) CreateTempNpmrc() error
  • func (ca *CommonArgs) GetRestoreNpmrcFunc() func() error
  • func (ca *CommonArgs) PreparePrerequisites(repo string, overrideNpmrc bool) error
  • func (ca *CommonArgs) SetCmdName(cmdName string) *CommonArgs
• type GenericCommand
  • func NewNpmGenericCommand(cmdName string) *GenericCommand
  • func (gc *GenericCommand) CommandName() string
  • func (gc *GenericCommand) Run() (err error)
• type GenericCommandArgs
  • func (gca *GenericCommandArgs) ServerDetails() (*config.ServerDetails, error)
• type NpmCommand
  • func (nc *NpmCommand) SetBuildConfiguration(buildConfiguration *utils.BuildConfiguration) *NpmCommand
  • func (nc *NpmCommand) SetNpmArgs(npmArgs []string) *NpmCommand
  • func (nc *NpmCommand) SetRepo(repo string) *NpmCommand
  • func (nc *NpmCommand) SetServerDetails(serverDetails *config.ServerDetails) *NpmCommand
• type NpmInstallOrCiCommand
  • func NewNpmCiCommand() *NpmInstallOrCiCommand
  • func NewNpmInstallCommand() *NpmInstallOrCiCommand
  • func (nic *NpmInstallOrCiCommand) CommandName() string
  • func (nic *NpmInstallOrCiCommand) Init() error
  • func (nic *NpmInstallOrCiCommand) Run() (err error)
  • func (nic *NpmInstallOrCiCommand) ServerDetails() (*config.ServerDetails, error)
  • func (nic *NpmInstallOrCiCommand) SetArgs(args []string) *NpmInstallOrCiCommand
  • func (nic *NpmInstallOrCiCommand) SetConfigFilePath(configFilePath string) *NpmInstallOrCiCommand
  • func (nic *NpmInstallOrCiCommand) SetRepoConfig(conf *utils.RepositoryConfig) *NpmInstallOrCiCommand
• type NpmPublishCommand
  • func NewNpmPublishCommand() *NpmPublishCommand
  • func (npc *NpmPublishCommand) CommandName() string
  • func (npc *NpmPublishCommand) Init() error
  • func (npc *NpmPublishCommand) IsDetailedSummary() bool
  • func (npc *NpmPublishCommand) Result() *commandsutils.Result
  • func (npc *NpmPublishCommand) Run() (err error)
  • func (npc *NpmPublishCommand) ServerDetails() (*config.ServerDetails, error)
  • func (npc *NpmPublishCommand) SetArgs(args []string) *NpmPublishCommand
  • func (npc *NpmPublishCommand) SetConfigFilePath(configFilePath string) *NpmPublishCommand
  • func (npc *NpmPublishCommand) SetDetailedSummary(detailedSummary bool) *NpmPublishCommand
  • func (npc *NpmPublishCommand) SetScanOutputFormat(format xrutils.OutputFormat) *NpmPublishCommand
  • func (npc *NpmPublishCommand) SetXrayScan(xrayScan bool) *NpmPublishCommand
• type NpmPublishCommandArgs
  • func NewNpmPublishCommandArgs() *NpmPublishCommandArgs

Types

type CommonArgs

type CommonArgs struct {
	NpmCommand
	// contains filtered or unexported fields
}

func (*CommonArgs) CreateTempNpmrc

func (ca *CommonArgs) CreateTempNpmrc() error

In order to make sure the npm resolves artifacts from Artifactory we create a .npmrc file in the project dir. If such a file exists we back it up as npmrcBackupFileName.

func (*CommonArgs) GetRestoreNpmrcFunc

func (ca *CommonArgs) GetRestoreNpmrcFunc() func() error

func (*CommonArgs) PreparePrerequisites

func (ca *CommonArgs) PreparePrerequisites(repo string, overrideNpmrc bool) error

func (*CommonArgs) SetCmdName

func (ca *CommonArgs) SetCmdName(cmdName string) *CommonArgs

type GenericCommand

type GenericCommand struct {
	*GenericCommandArgs
}

GenericCommand represents any npm command which is not "install", "ci" or "publish".

func NewNpmGenericCommand

func NewNpmGenericCommand(cmdName string) *GenericCommand

func (*GenericCommand) CommandName

func (gc *GenericCommand) CommandName() string

func (*GenericCommand) Run

func (gc *GenericCommand) Run() (err error)

type GenericCommandArgs

type GenericCommandArgs struct {
	CommonArgs
}

func (*GenericCommandArgs) ServerDetails

func (gca *GenericCommandArgs) ServerDetails() (*config.ServerDetails, error)

type NpmCommand

type NpmCommand struct {
	// contains filtered or unexported fields
}

func (*NpmCommand) SetBuildConfiguration

func (nc *NpmCommand) SetBuildConfiguration(buildConfiguration *utils.BuildConfiguration) *NpmCommand

func (*NpmCommand) SetNpmArgs

func (nc *NpmCommand) SetNpmArgs(npmArgs []string) *NpmCommand

func (*NpmCommand) SetRepo

func (nc *NpmCommand) SetRepo(repo string) *NpmCommand

func (*NpmCommand) SetServerDetails

func (nc *NpmCommand) SetServerDetails(serverDetails *config.ServerDetails) *NpmCommand

type NpmInstallOrCiCommand

type NpmInstallOrCiCommand struct {
	CommonArgs
	// contains filtered or unexported fields
}

func NewNpmCiCommand

func NewNpmCiCommand() *NpmInstallOrCiCommand

func NewNpmInstallCommand

func NewNpmInstallCommand() *NpmInstallOrCiCommand

func (*NpmInstallOrCiCommand) CommandName

func (nic *NpmInstallOrCiCommand) CommandName() string

func (*NpmInstallOrCiCommand) Init

func (nic *NpmInstallOrCiCommand) Init() error

func (*NpmInstallOrCiCommand) Run

func (nic *NpmInstallOrCiCommand) Run() (err error)

func (*NpmInstallOrCiCommand) ServerDetails

func (nic *NpmInstallOrCiCommand) ServerDetails() (*config.ServerDetails, error)

func (*NpmInstallOrCiCommand) SetArgs

func (nic *NpmInstallOrCiCommand) SetArgs(args []string) *NpmInstallOrCiCommand

func (*NpmInstallOrCiCommand) SetConfigFilePath

func (nic *NpmInstallOrCiCommand) SetConfigFilePath(configFilePath string) *NpmInstallOrCiCommand

func (*NpmInstallOrCiCommand) SetRepoConfig

func (nic *NpmInstallOrCiCommand) SetRepoConfig(conf *utils.RepositoryConfig) *NpmInstallOrCiCommand

type NpmPublishCommand

type NpmPublishCommand struct {
	*NpmPublishCommandArgs
	// contains filtered or unexported fields
}

func NewNpmPublishCommand

func NewNpmPublishCommand() *NpmPublishCommand

func (*NpmPublishCommand) CommandName

func (npc *NpmPublishCommand) CommandName() string

func (*NpmPublishCommand) Init

func (npc *NpmPublishCommand) Init() error

func (*NpmPublishCommand) IsDetailedSummary

func (npc *NpmPublishCommand) IsDetailedSummary() bool

func (*NpmPublishCommand) Result

func (npc *NpmPublishCommand) Result() *commandsutils.Result

func (*NpmPublishCommand) Run

func (npc *NpmPublishCommand) Run() (err error)

func (*NpmPublishCommand) ServerDetails

func (npc *NpmPublishCommand) ServerDetails() (*config.ServerDetails, error)

func (*NpmPublishCommand) SetArgs

func (npc *NpmPublishCommand) SetArgs(args []string) *NpmPublishCommand

func (*NpmPublishCommand) SetConfigFilePath

func (npc *NpmPublishCommand) SetConfigFilePath(configFilePath string) *NpmPublishCommand

func (*NpmPublishCommand) SetDetailedSummary

func (npc *NpmPublishCommand) SetDetailedSummary(detailedSummary bool) *NpmPublishCommand

func (*NpmPublishCommand) SetScanOutputFormat

func (npc *NpmPublishCommand) SetScanOutputFormat(format xrutils.OutputFormat) *NpmPublishCommand

func (*NpmPublishCommand) SetXrayScan

func (npc *NpmPublishCommand) SetXrayScan(xrayScan bool) *NpmPublishCommand

type NpmPublishCommandArgs

type NpmPublishCommandArgs struct {
	NpmCommand
	// contains filtered or unexported fields
}

func NewNpmPublishCommandArgs

func NewNpmPublishCommandArgs() *NpmPublishCommandArgs