prompt

package

v0.6.1 Latest Latest Go to latest Published: May 11, 2019 License: MIT Imports: 12 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

This section is empty.

This section is empty.

This section is empty.

type Prompt struct {
	Page      *pages.Page
	Questions []*survey.Question
}

Prompt struct is responsible for maintaining the life cycle of a tldr man page

func New(p *pages.Page) *Prompt

New creates a new *prompt.Prompt obj. from a tldr Page

func (p *Prompt) GenerateCommand(t *pages.Tip) (string, error)

GenerateCommand generates command form *pages.Tip

func (p *Prompt) RenderPage(static bool) error

RenderPage prints the tldr man page as is

func (p *Prompt) Run(command string) error

Run gets final confirmation from user and executes the command with its args

func (p *Prompt) Selection() (t *pages.Tip, err error)

Selection is where user interaction starts, hence we can *pages.Tip to iterate user interaction