pkg

package

v0.0.0-...-a9402ed Latest Latest Go to latest Published: Nov 4, 2020 License: Apache-2.0 Imports: 6 Imported by: 0

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 CompletedEvent = "complete!"

CompletedEvent indicate the process completed

View Source

var RenderProgressBars bool

RenderProgressBars indicate if we need to display progress in UI

This section is empty.

type Progress struct {
	Name string
	Bar  *uiprogress.Bar

	State string
	// contains filtered or unexported fields
}

Progress define the progress on command execution

func (progress *Progress) SetText(text string)

SetText define text to display during progress

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

UIProgressCoordinator coortinate display of progress in UI

func NewProgressCoordinator() *UIProgressCoordinator

NewProgressCoordinator create a new progress coordinator UI

func (c *UIProgressCoordinator) AddEvent(progressName string, eventName string)

AddEvent add an new event in the progress UI

func (c *UIProgressCoordinator) CompleteProgress(nodeName string)

CompleteProgress sends an completed event

func (c *UIProgressCoordinator) StartProgress(name string, steps int)

StartProgress start the progress UI

func (c *UIProgressCoordinator) Wait()

Wait temporary stop the progress UI