flagsfromhost

Documentation

Index

• func InjectRemotes(list *remotes.List)
• func ParseRemoteAddress(remoteAddress string) (remote string, err error)
• type ErrorContainerWithNoProject
  • func (ErrorContainerWithNoProject) Error() string
• type ErrorFoundMultipleRemote
  • func (e ErrorFoundMultipleRemote) Error() string
• type ErrorFoundNoRemote
  • func (e ErrorFoundNoRemote) Error() string
• type ErrorLoadingRemoteList
  • func (ErrorLoadingRemoteList) Error() string
• type ErrorMultiMode
  • func (ErrorMultiMode) Error() string
• type ErrorNotFound
  • func (e ErrorNotFound) Error() string
• type ErrorRemoteFlagAndHost
  • func (ErrorRemoteFlagAndHost) Error() string
• type FlagsFromHost
  • func Parse(pf ParseFlags) (*FlagsFromHost, error)
  • func ParseWithDefaultCustomRemote(pf ParseFlagsWithDefaultCustomRemote, customRemote string) (*FlagsFromHost, error)
  • func (f *FlagsFromHost) Container() string
  • func (f *FlagsFromHost) IsRemoteFromHost() bool
  • func (f *FlagsFromHost) Project() string
  • func (f *FlagsFromHost) Remote() string
• type ParseFlags
• type ParseFlagsWithDefaultCustomRemote

Functions

func InjectRemotes

func InjectRemotes(list *remotes.List)

InjectRemotes list into the flagsfromhost module

func ParseRemoteAddress

func ParseRemoteAddress(remoteAddress string) (remote string, err error)

ParseRemoteAddress to get related remote

Types

type ErrorContainerWithNoProject

type ErrorContainerWithNoProject struct{}

ErrorContainerWithNoProject hapens when --container is used without --project

func (ErrorContainerWithNoProject) Error

func (ErrorContainerWithNoProject) Error() string

type ErrorFoundMultipleRemote

type ErrorFoundMultipleRemote struct {
	Host    string
	Remotes []string
}

ErrorFoundMultipleRemote happens when multiple resolutions are found for a given host address

func (ErrorFoundMultipleRemote) Error

func (e ErrorFoundMultipleRemote) Error() string

type ErrorFoundNoRemote

type ErrorFoundNoRemote struct {
	Host string
}

ErrorFoundNoRemote happens when a remote isn't found for a given host address

func (ErrorFoundNoRemote) Error

func (e ErrorFoundNoRemote) Error() string

type ErrorLoadingRemoteList

type ErrorLoadingRemoteList struct{}

ErrorLoadingRemoteList happens when the remote list is needed, but not injected into the module

func (ErrorLoadingRemoteList) Error

func (ErrorLoadingRemoteList) Error() string

type ErrorMultiMode

type ErrorMultiMode struct{}

ErrorMultiMode happens when --project and --container are used with host URL flag

func (ErrorMultiMode) Error

func (ErrorMultiMode) Error() string

type ErrorNotFound

type ErrorNotFound struct {
	Remote string
}

ErrorNotFound happens when a remote isn't found

func (ErrorNotFound) Error

func (e ErrorNotFound) Error() string

type ErrorRemoteFlagAndHost

type ErrorRemoteFlagAndHost struct{}

ErrorRemoteFlagAndHost happens when both --remote and host remote are used together

func (ErrorRemoteFlagAndHost) Error

func (ErrorRemoteFlagAndHost) Error() string

type FlagsFromHost

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

FlagsFromHost holds the project, container, and remote parsed

func Parse

func Parse(pf ParseFlags) (*FlagsFromHost, error)

Parse host and flags

func ParseWithDefaultCustomRemote

func ParseWithDefaultCustomRemote(pf ParseFlagsWithDefaultCustomRemote, customRemote string) (*FlagsFromHost, error)

ParseWithDefaultCustomRemote parses the flags using a custom default remote value

func (*FlagsFromHost) Container

func (f *FlagsFromHost) Container() string

Container of the parsed flags or host

func (*FlagsFromHost) IsRemoteFromHost

func (f *FlagsFromHost) IsRemoteFromHost() bool

IsRemoteFromHost tells if the Remote was parsed from a host or not

func (*FlagsFromHost) Project

func (f *FlagsFromHost) Project() string

Project of the parsed flags or host

func (*FlagsFromHost) Remote

func (f *FlagsFromHost) Remote() string

Remote of the parsed flags or host

type ParseFlags

type ParseFlags struct {
	Project   string
	Container string
	Remote    string
	Host      string
}

ParseFlags for the flags received by the CLI

type ParseFlagsWithDefaultCustomRemote

type ParseFlagsWithDefaultCustomRemote struct {
	Project       string
	Container     string
	Remote        string
	Host          string
	RemoteChanged bool
}

ParseFlagsWithDefaultCustomRemote is similar to ParseFlags, but with 'default custom remote' support