console

package module

v0.2.1 Latest Latest Go to latest Published: Jun 4, 2022 License: MIT Imports: 10 Imported by: 1

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

Repository

github.com/jon4hz/console

Links

Open Source Insights

README ¶

Console

Documentation ¶

Index ¶

Variables
type Cmd
- func (c *Cmd) Handle(cmd string) error
- func (c *Cmd) Match(cmd string) bool
type Console
- func New(opts ...Opts) (*Console, error)
type Opts

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrCmdNoHandler = errors.New("command has no handler")
)

View Source

var StyleError = lipgloss.NewStyle().Foreground(lipgloss.AdaptiveColor{Light: "#FF4672", Dark: "#FF4672"})

Functions ¶

This section is empty.

Types ¶

type Cmd ¶

type Cmd struct {
	Name                 string
	Aliases              []string
	Description          string
	IgnorePipe           bool
	Matcher              func(cmd string) bool
	IgnoreDefaultMatcher bool
	Handler              func(c *Console, args []string) error
	Console              *Console
}

func (*Cmd) Handle ¶

func (c *Cmd) Handle(cmd string) error

func (*Cmd) Match ¶

func (c *Cmd) Match(cmd string) bool

type Console ¶

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

func New ¶

func New(opts ...Opts) (*Console, error)

func (*Console) Close ¶

func (c *Console) Close() error

func (*Console) Ctx ¶ added in v0.2.1

func (c *Console) Ctx() context.Context

func (*Console) ExitCmd ¶

func (c *Console) ExitCmd() (*Cmd, bool)

func (*Console) RegisterCommands ¶

func (c *Console) RegisterCommands(cmds ...*Cmd) error

func (*Console) Start ¶

func (c *Console) Start() error

type Opts ¶

type Opts func(*Console)

func WithContext ¶

func WithContext(ctx context.Context) Opts

func WithDynamicPrompt ¶ added in v0.2.0

func WithDynamicPrompt(promtC <-chan string) Opts

func WithExitCmd ¶

func WithExitCmd(e *Cmd) Opts

func WithHandleCtrlC ¶

func WithHandleCtrlC(handle bool) Opts

func WithHistoryFile ¶

func WithHistoryFile(file string) Opts

func WithPrompt ¶ added in v0.2.0

func WithPrompt(prompt string) Opts

func WithWelcomeMsg ¶

func WithWelcomeMsg(msg string) Opts

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
example
echo Module

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