selfinstall

Documentation

Index

• type Plan
  • func PlanInstall(executablePath, homeDir, pathEnv, shell string, create bool) (Plan, error)
  • func PlanInstallWith(executablePath, homeDir, pathEnv, shell string, create bool, ...) (Plan, error)
  • func WithInstallDir(plan Plan, homeDir, pathEnv, shell, installDir string) Plan
• type Result
  • func Install(plan Plan, updateShell bool) (Result, error)
  • func InstallWith(plan Plan, updateShell bool, readFile func(string) ([]byte, error), ...) (Result, error)
  • func Uninstall(plan Plan) (Result, error)
  • func UninstallWith(plan Plan, readFile func(string) ([]byte, error), remove func(string) error) (Result, error)

Types

type Plan

type Plan struct {
	ExecutablePath string
	InstallDir     string
	TargetPath     string
	ShellName      string
	ShellRCPath    string
	ShellSnippet   string
	PathContains   bool
}

func PlanInstall

func PlanInstall(executablePath, homeDir, pathEnv, shell string, create bool) (Plan, error)

func PlanInstallWith

func PlanInstallWith(
	executablePath, homeDir, pathEnv, shell string,
	create bool,
	stat func(string) (os.FileInfo, error),
	mkdirAll func(string, os.FileMode) error,
) (Plan, error)

func WithInstallDir

func WithInstallDir(plan Plan, homeDir, pathEnv, shell, installDir string) Plan

type Result

type Result struct {
	Plan            Plan
	Installed       bool
	Removed         bool
	ShellConfigured bool
	ShellUpdated    bool
}

func Install

func Install(plan Plan, updateShell bool) (Result, error)

func InstallWith

func InstallWith(
	plan Plan,
	updateShell bool,
	readFile func(string) ([]byte, error),
	writeFile func(string, []byte, os.FileMode) error,
	mkdirAll func(string, os.FileMode) error,
) (Result, error)

func Uninstall

func Uninstall(plan Plan) (Result, error)

func UninstallWith

func UninstallWith(
	plan Plan,
	readFile func(string) ([]byte, error),
	remove func(string) error,
) (Result, error)