levels.go

package egcmd

import (
	"fmt"
)

// A Level provides a context for examples to be found,
// whether this is at the top-level of your app or at a command.
type Level struct {
	name     string
	examples []*Example
}

// Example adds a new example to the command.
func (l *Level) Example(args, decription string) (example *Example) {
	example = &Example{
		Arguments:   args,
		Description: decription,
	}
	l.examples = append(l.examples, example)
	return
}

// Envs adds a new top-level example that includes env details.
func (l *Level) Envs(env, args, decription string) (example *Example) {
	example = &Example{
		EnvVars:     env,
		Arguments:   args,
		Description: decription,
	}
	l.examples = append(l.examples, example)
	return
}

// App provides a container for top-level and command examples to be instantiated
type App struct {
	Level
	commands map[string]*Command
}

// Command adds a new top-level command.
func (a *App) Command(name string) (command *Command) {
	command, ok := a.commands[name]
	if !ok {
		command = &Command{Level: Level{name: name}}
		a.commands[name] = command
	}

	return
}

// Find returns the examples that belong to a particular command
// or to the application top level when empty string provided
func (a *App) Find(command string) (examples ExamplesFound) {

	if command == "" {
		examples = ExamplesFound{Context: a.name, Examples: a.examples}
		return
	}

	examples = ExamplesFound{Context: fmt.Sprintf("%s %s", a.name, command)}

	if value, found := a.commands[command]; found {
		examples.Examples = value.examples
	}

	return
}

// ExamplesFound provides a list of examples along with the context that the belong to
type ExamplesFound struct {
	Context  string
	Examples []*Example
}

// Command provides a container for top-level and command examples to be instantiated
type Command struct {
	Level
}