util

package

v0.4.1 Latest Latest Go to latest Published: Jan 9, 2023 License: Apache-2.0 Imports: 12 Imported by: 2

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

View Source

const (
	Homebrew = "homebrew"
)

View Source

var (
	AppName    = "ankor"
	TemplateFS embed.FS

	Force bool
)

View Source

var (
	ErrMissingExecutable = errors.New("must be installed on your system and available in your $PATH")
)

func AddToPath(path string) (string, error)

AddToPath attempts to add supplied path to the systems shell environment as well as adding it to the os.Environ for teh current run.

func AddToPathCmd(sub string, cmd ...string) (string, error)

AddToPathCmd will use the supplied cmd to retrieve the value for a path and add the sub suffix to the pat for adding to PATH.

func GetPath(name string, installers ...DependencyInstaller) string

GetPath attempts to retrieve path for specified executable name.

func IsBrewInstallation() bool

func PathByName(name string) string

type DependencyInstaller func() (string, error)

type Dirs struct {
	HomeDir   string
	AnkorDir  string
	ConfigDir string
	OptDir    string
	BinDir    string
	TmpDir    string
}

func NewDirs() Dirs

func (d *Dirs) GetAnkorDir() string

func (d *Dirs) GetBinDir() string

func (d *Dirs) GetCompletionDir() string

func (d *Dirs) GetConfigDir() string

func (d *Dirs) GetHomeDir() string

func (d *Dirs) GetLogsDir() string

func (d *Dirs) GetOptDir() string

func (d *Dirs) GetPluginsDir() string

func (d *Dirs) GetTmpDir() string

type PluginInfo struct {
	Name         *PluginName
	Dependencies []*PluginName
	Fields       map[string]string
}

type PluginName struct {
	Name string
	Type string
}

Path	Synopsis
deprecate Package deprecate provides simple functions to standardize the output of deprecation notices on Ankor CLI	Package deprecate provides simple functions to standardize the output of deprecation notices on Ankor CLI
encoding
env
errorhandling
exec
exit
factory
filesystem
flags
gio Package gio provides io functions for GoReleaser.	Package gio provides io functions for GoReleaser.
git
github
utils
golden Package golden asserts golden files contents.	Package golden asserts golden files contents.
hash
interrupt
log
logext
logo
middleware Package middleware define middlewares for Actions.	Package middleware define middlewares for Actions.
errhandler
logging
skip Package skip can skip an entire Action.	Package skip can skip an entire Action.
pipeline
pipes Package pipes provides generic erros for pipes to use.	Package pipes provides generic erros for pipes to use.
processor
randutil
scanner
survey
template
terminal
tomb The tomb package handles clean goroutine tracking and termination.	The tomb package handles clean goroutine tracking and termination.
v2
github