helpers

Documentation

Index

• func LoadEnvfile(env *env.Env, path string) error
• func NewDownloader(url string) *downloader
• func VirtualenvName(proj *project.Project, version string) string
• type GitRepo
  • func NewGitRepo(path string) *GitRepo
  • func (r *GitRepo) BuildGithubProjectURL() (string, error)
  • func (r *GitRepo) BuildGithubPullrequestURL() (string, error)
  • func (r *GitRepo) GetCurrentBranch() (string, error)
  • func (r *GitRepo) GetRemoteURL() (string, error)
• type Github
  • func NewGithub() *Github
  • func NewGithubWithClient(client *http.Client) *Github
  • func (g *Github) Get(url string) (data []byte, err error)
  • func (g *Github) LatestRelease(platform string) (*GithubReleaseItem, error)
• type GithubReleaseItem
• type GithubReleaseList
• type Golang
  • func NewGolang(cfg *config.Config, version string) *Golang
  • func (g *Golang) BinPath() string
  • func (g *Golang) Exists() bool
  • func (g *Golang) Install() (err error)
  • func (g *Golang) Path() string
  • func (g *Golang) Which(program string) string
• type Homebrew
  • func NewHomebrew() *Homebrew
  • func NewHomebrewWithPrefix(prefixes ...string) *Homebrew
  • func (h *Homebrew) IsInstalled(formula string) (installed bool)
• type Node
  • func NewNode(cfg *config.Config, version string) *Node
  • func (n *Node) BinPath() string
  • func (n *Node) Exists() bool
  • func (n *Node) Install() error
  • func (n *Node) Path() string
  • func (n *Node) Which(program string) string
• type PyEnv
  • func NewPyEnv() (*PyEnv, error)
  • func (p *PyEnv) VersionInstalled(version string) (installed bool, err error)
  • func (p *PyEnv) Which(version string, command string) string
• type Upgrader
  • func NewUpgrader(useSudo bool) (u *Upgrader)
  • func NewUpgraderWithHTTPClient(client *http.Client, useSudo bool) (u *Upgrader)
  • func (u *Upgrader) LatestRelease(plateform string) (release *GithubReleaseItem, err error)
  • func (u *Upgrader) Perform(ui *termui.UI, destinationPath string, sourceURL string) (err error)
• type Virtualenv
  • func NewVirtualenv(cfg *config.Config, name string) *Virtualenv
  • func (v *Virtualenv) BinPath() string
  • func (v *Virtualenv) Exists() bool
  • func (v *Virtualenv) Path() string
  • func (v *Virtualenv) Which(cmd string) string

Functions

func LoadEnvfile

func LoadEnvfile(env *env.Env, path string) error

LoadEnvfile sets all the environment variables defined in an envfile

func NewDownloader

func NewDownloader(url string) *downloader

func VirtualenvName

func VirtualenvName(proj *project.Project, version string) string

Types

type GitRepo

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

GitRepo represents a local git repository

func NewGitRepo

func NewGitRepo(path string) *GitRepo

NewGitRepo returns a GitRepo

func (*GitRepo) BuildGithubProjectURL

func (r *GitRepo) BuildGithubProjectURL() (string, error)

BuildGithubProjectURL builds the Github page url from the git remote url for a specific branch

func (*GitRepo) BuildGithubPullrequestURL

func (r *GitRepo) BuildGithubPullrequestURL() (string, error)

BuildGithubPullrequestURL builds the Github pullrequest url from the git remote url for a specific branch

func (*GitRepo) GetCurrentBranch

func (r *GitRepo) GetCurrentBranch() (string, error)

GetCurrentBranch returns the name of the branch or "HEAD" for special cases

func (*GitRepo) GetRemoteURL

func (r *GitRepo) GetRemoteURL() (string, error)

GetRemoteURL returns the URL of the origin remote

type Github

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

func NewGithub

func NewGithub() *Github

func NewGithubWithClient

func NewGithubWithClient(client *http.Client) *Github

func (*Github) Get

func (g *Github) Get(url string) (data []byte, err error)

Get download the content at `url`

func (*Github) LatestRelease

func (g *Github) LatestRelease(platform string) (*GithubReleaseItem, error)

LatestRelease get latest release url for a specific `platform`

type GithubReleaseItem

type GithubReleaseItem struct {
	Platform    string `json:"name"`
	DownloadURL string `json:"browser_download_url"`
}

type GithubReleaseList

type GithubReleaseList struct {
	TagName string              `json:"tag_name"`
	Items   []GithubReleaseItem `json:"assets"`
}

type Golang

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

func NewGolang

func NewGolang(cfg *config.Config, version string) *Golang

func (*Golang) BinPath

func (g *Golang) BinPath() string

func (*Golang) Exists

func (g *Golang) Exists() bool

func (*Golang) Install

func (g *Golang) Install() (err error)

func (*Golang) Path

func (g *Golang) Path() string

func (*Golang) Which

func (g *Golang) Which(program string) string

type Homebrew

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

Homebrew represent an homebrew installation

func NewHomebrew

func NewHomebrew() *Homebrew

NewHomebrew is returning a new Cellar

func NewHomebrewWithPrefix

func NewHomebrewWithPrefix(prefixes ...string) *Homebrew

NewHomebrewWithPrefix is returning a new Cellar at prefix

func (*Homebrew) IsInstalled

func (h *Homebrew) IsInstalled(formula string) (installed bool)

IsInstalled returns true if `pkg` is installed in cellar or in caskroom

type Node

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

func NewNode

func NewNode(cfg *config.Config, version string) *Node

func (*Node) BinPath

func (n *Node) BinPath() string

func (*Node) Exists

func (n *Node) Exists() bool

func (*Node) Install

func (n *Node) Install() error

func (*Node) Path

func (n *Node) Path() string

func (*Node) Which

func (n *Node) Which(program string) string

type PyEnv

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

func NewPyEnv

func NewPyEnv() (*PyEnv, error)

func (*PyEnv) VersionInstalled

func (p *PyEnv) VersionInstalled(version string) (installed bool, err error)

func (*PyEnv) Which

func (p *PyEnv) Which(version string, command string) string

type Upgrader

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

func NewUpgrader

func NewUpgrader(useSudo bool) (u *Upgrader)

NewUpgrader returns a new upgrade helper using the default http client

func NewUpgraderWithHTTPClient

func NewUpgraderWithHTTPClient(client *http.Client, useSudo bool) (u *Upgrader)

NewUpgraderWithHTTPClient returns a new upgrade helper using the provided http client

func (*Upgrader) LatestRelease

func (u *Upgrader) LatestRelease(plateform string) (release *GithubReleaseItem, err error)

LatestRelease get latest release item for current platform

func (*Upgrader) Perform

func (u *Upgrader) Perform(ui *termui.UI, destinationPath string, sourceURL string) (err error)

Perform is fetching a new executable from `release` and upgrading the executable at `destinationPath` with it

type Virtualenv

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

func NewVirtualenv

func NewVirtualenv(cfg *config.Config, name string) *Virtualenv

func (*Virtualenv) BinPath

func (v *Virtualenv) BinPath() string

func (*Virtualenv) Exists

func (v *Virtualenv) Exists() bool

func (*Virtualenv) Path

func (v *Virtualenv) Path() string

func (*Virtualenv) Which

func (v *Virtualenv) Which(cmd string) string