editor

Documentation

Overview

Package editor is an interactive command-line editor that supports sub-commands with arguments.

Index

• Variables
• type Command
  • func NewCommand(shortName, description string, args []string, ...) Command
• type Editor
  • func New(prompt *cli.Prompter, helpText string, commands ...Command) *Editor
  • func (e *Editor) Loop()

Variables

var ErrCommandNotFound = errors.New("command not found")

var ErrExitEditor = errors.New("exit editor")

Types

type Command

type Command interface {
	// contains filtered or unexported methods
}

func NewCommand

func NewCommand(shortName, description string, args []string, handler func(args []string) error) Command

type Editor

type Editor struct {
	*cli.Prompter
	// contains filtered or unexported fields
}

An Editor handles simple subcommand abstraction.

Note that this structure is not intended to be modified after creation. This removes the need for any kind of synchronization.

func New

func New(prompt *cli.Prompter, helpText string, commands ...Command) *Editor

func (*Editor) Loop

func (e *Editor) Loop()