installer

Documentation

Index

• Constants
• func FetchLatestRepo(provider string, branch string, progress io.Writer) (err error)
• func FindCategories() (result []string)
• func GetConfigDir() (configDir string, err error)
• func IsSupport(cfg HDConfig) bool
• type CmdWithArgs
• type HDConfig
  • func FindPackagesByCategory(category string) (result []HDConfig)
• type HDPackage
• type Installer
  • func (o *Installer) CheckDepAndInstall(tools map[string]string) (err error)
  • func (o *Installer) GetVersion(path string) (version string, err error)
  • func (o *Installer) Install() (err error)
  • func (o *Installer) OverWriteBinary(sourceFile, targetPath string) (err error)
  • func (o *Installer) ProviderURLParse(path string, acceptPreRelease bool) (packageURL string, err error)
• type PackagingFormat

Constants

const (
	// ConfigGitHub is the default git repository URI
	ConfigGitHub = "https://github.com/LinuxSuRen/hd-home"
	// ConfigBranch is the default branch name of hd-home git repository
	ConfigBranch = "master"
)

const (
	// ProviderGitHub represents https://github.com
	ProviderGitHub = "github"
)

Functions

func FetchLatestRepo

func FetchLatestRepo(provider string, branch string,
	progress io.Writer) (err error)

FetchLatestRepo fetches the hd-home as the config

func FindCategories

func FindCategories() (result []string)

FindCategories returns the whole supported categories

func GetConfigDir

func GetConfigDir() (configDir string, err error)

GetConfigDir returns the directory of the config

func IsSupport

func IsSupport(cfg HDConfig) bool

IsSupport checks if support

Types

type CmdWithArgs

type CmdWithArgs struct {
	Cmd  string   `yaml:"cmd"`
	Args []string `yaml:"args"`
}

CmdWithArgs is a command with arguments

type HDConfig

type HDConfig struct {
	Name             string            `yaml:"Name"`
	Categories       []string          `yaml:"categories"`
	Filename         string            `yaml:"filename"`
	FormatOverrides  PackagingFormat   `yaml:"formatOverrides"`
	Binary           string            `yaml:"binary"`
	TargetBinary     string            `yaml:"targetBinary"`
	AdditionBinaries []string          `yaml:"additionBinaries"`
	FromSource       bool              `yaml:"fromSource"`
	URL              string            `yaml:"url"`
	Tar              string            `yaml:"tar"`
	LatestVersion    string            `yaml:"latestVersion"`
	SupportOS        []string          `yaml:"supportOS"`
	SupportArch      []string          `yaml:"supportArch"`
	Replacements     map[string]string `yaml:"replacements"`
	Requirements     []string          `yaml:"requirements"`
	Installation     *CmdWithArgs      `yaml:"installation"`
	PreInstalls      []CmdWithArgs     `yaml:"preInstalls"`
	PostInstalls     []CmdWithArgs     `yaml:"postInstalls"`
	TestInstalls     []CmdWithArgs     `yaml:"testInstalls"`

	Org, Repo string
}

HDConfig is the config of http-downloader

func FindPackagesByCategory

func FindPackagesByCategory(category string) (result []HDConfig)

FindPackagesByCategory returns the HDConfigs by category

type HDPackage

type HDPackage struct {
	Name             string
	Version          string // e.g. v1.0.1
	VersionNum       string // e.g. 1.0.1
	OS               string // e.g. linux, darwin
	Arch             string // e.g. amd64
	AdditionBinaries []string
}

HDPackage represents a package of http-downloader

type Installer

type Installer struct {
	Package          *HDConfig
	Tar              bool
	Output           string
	Source           string
	Name             string
	CleanPackage     bool
	Provider         string
	OS               string
	Arch             string
	Fetch            bool
	AdditionBinaries []string

	Org  string
	Repo string
}

Installer is a tool to install a package

func (*Installer) CheckDepAndInstall

func (o *Installer) CheckDepAndInstall(tools map[string]string) (err error)

CheckDepAndInstall checks the desired tools, install the missing packages

func (*Installer) GetVersion

func (o *Installer) GetVersion(path string) (version string, err error)

GetVersion parse install app info

func (*Installer) Install

func (o *Installer) Install() (err error)

Install installs a package

func (*Installer) OverWriteBinary

func (o *Installer) OverWriteBinary(sourceFile, targetPath string) (err error)

OverWriteBinary install a binrary file

func (*Installer) ProviderURLParse

func (o *Installer) ProviderURLParse(path string, acceptPreRelease bool) (packageURL string, err error)

ProviderURLParse parse the URL

type PackagingFormat

type PackagingFormat struct {
	Windows string `yaml:"windows"`
	Linux   string `yaml:"linux"`
}

PackagingFormat is used for containing config depending on machine