ui

package

v0.1.0-dev.20260314201016 Latest Latest Go to latest Published: Mar 14, 2026 License: MIT Imports: 4 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/NobleFactor/devlore-cli

Links

Open Source Insights

Documentation ¶

Overview ¶

Package ui provides user-facing terminal messaging for the operation graph.

Index ¶

type Provider
- func NewProvider(ctx op.Context) *Provider

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Provider ¶

type Provider struct {
	op.ProviderBase
	// Writer is the output destination. Defaults to os.Stderr.
	Writer io.Writer
	// ProgramName is the prefix for messages. Defaults to "devlore".
	ProgramName string
	// Silent suppresses all output when true.
	Silent bool
	// Color enables ANSI color codes. Defaults to true.
	Color bool
}

Provider provides terminal status messaging.

+devlore:access=immediate

func NewProvider ¶

func NewProvider(ctx op.Context) *Provider

func (*Provider) Error ¶

func (p *Provider) Error(msg string)

Error reports a non-fatal problem to the user.

Parameters:

msg: the error message to display.

func (*Provider) Fail ¶

func (p *Provider) Fail(msg string) error

Fail prints an error message and returns an error.

Parameters:

msg: the error message to display and return.

Returns:

error: an error wrapping msg.

func (*Provider) Note ¶

func (p *Provider) Note(msg string)

Note informs the user of progress.

Parameters:

msg: the informational message to display.

func (*Provider) Success ¶

func (p *Provider) Success(msg string)

Success confirms completion to the user.

Parameters:

msg: the success message to display.

func (*Provider) Warn ¶

func (p *Provider) Warn(msg string)

Warn alerts the user to a potential issue.

Parameters:

msg: the warning message to display.

Source Files ¶

View all Source files

provider.go

Directories ¶

Path	Synopsis
gen

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL