utils

Documentation

Index

• Constants
• Variables
• func BoolValue(b *bool) bool
• func Confirm(msg string) bool
• func DownloadAndExtract(url, dest, targetName string, giveExec bool) error
• func DownloadUrl(url, dest string) error
• func ExtractArchive(src, dest string) error
• func ExtractBinary(src, dest, binaryName string) error
• func ExtractBz2(src, dest string) error
• func ExtractSingleFile(archivePath, destPath, targetName string) error
• func ExtractTgz(src, dest string) error
• func ExtractZip(src, dest string) error
• func FindBinary(binaryNames map[string]string, destFolder string) (string, error)
• func FormatErrors(errs []error) string
• func FormatFileSize(bytes int64) string
• func GetFileExtensionFromURL(rawurl string) (string, error)
• func GetRemoteFileSize(url string) string
• func GiveExecutePerms(path string) error
• func HandleError(err error, msg ...string)
• func NewSpinner(cfg yacspin.Config)
• func OpenURL(url string) error
• func SetSpinnerQuiet(quiet bool)
• func SpinnerConfig() yacspin.Config

Constants

const (
	RedColor    = "\033[31m"
	YellowColor = "\033[33m"
	BlueColor   = "\033[34m"
	ResetColor  = "\033[0m"
)

ANSI escape codes for color

Variables

var (
	Spinner *yacspin.Spinner
)

global spinner

Functions

func BoolValue

func BoolValue(b *bool) bool

boolValue safely dereferences a bool pointer, returning false if nil

func Confirm

func Confirm(msg string) bool

func DownloadAndExtract

func DownloadAndExtract(url, dest, targetName string, giveExec bool) error

DownloadAndExtract downloads an archive from url, extracts it to dest. If targetName is specified, only that file is kept (others are removed). If giveExec is true, execute permissions are added to the target file. The archive is cleaned up after extraction.

func DownloadUrl

func DownloadUrl(url, dest string) error

downloads a file from a url and places it in a specified destination

func ExtractArchive

func ExtractArchive(src, dest string) error

ExtractArchive auto-detects the archive format and extracts it.

func ExtractBinary

func ExtractBinary(src, dest, binaryName string) error

ExtractBinary extracts an archive and gives execute permissions to the specified binary.

func ExtractBz2

func ExtractBz2(src, dest string) error

ExtractBz2 extracts a .tar.bz2 archive to the destination directory.

func ExtractSingleFile

func ExtractSingleFile(archivePath, destPath, targetName string) error

ExtractSingleFile extracts a single file from an archive to destPath. It searches for a file matching targetName anywhere in the archive.

func ExtractTgz

func ExtractTgz(src, dest string) error

ExtractTgz extracts a .tar.gz or .tgz archive to the destination directory.

func ExtractZip

func ExtractZip(src, dest string) error

ExtractZip extracts a zip archive to the destination directory.

func FindBinary

func FindBinary(binaryNames map[string]string, destFolder string) (string, error)

FindBinary checks that the binary exists in dest or $PATH, preferring $PATH. Checks that binary also has executable permissions.

func FormatErrors

func FormatErrors(errs []error) string

Formats a slice of errors to a single error, each seperated by a new line

func FormatFileSize

func FormatFileSize(bytes int64) string

FormatFileSize formats bytes into human-readable format (KB, MB, GB).

func GetFileExtensionFromURL

func GetFileExtensionFromURL(rawurl string) (string, error)

func GetRemoteFileSize

func GetRemoteFileSize(url string) string

GetRemoteFileSize returns the size of a remote file in a human-readable format. Returns empty string if size cannot be determined.

func GiveExecutePerms

func GiveExecutePerms(path string) error

GiveExecutePerms adds execute permissions to a file.

func HandleError

func HandleError(err error, msg ...string)

Prints the error in red and exits

func NewSpinner

func NewSpinner(cfg yacspin.Config)

Creates a new global spinner

func OpenURL

func OpenURL(url string) error

opens a URL in your default browser of your operating system

func SetSpinnerQuiet

func SetSpinnerQuiet(quiet bool)

Sets the spinner to quiet mode by discarding all output to not interfere with Unix pipes or redirections

func SpinnerConfig

func SpinnerConfig() yacspin.Config