common

Documentation

Overview

Package common should not be imported by external consumers. It was not designed for external use.

Index

• Variables
• type HelpActor
• type HelpCommand
  • func (cmd HelpCommand) Execute(args []string) error
  • func (cmd *HelpCommand) Setup(config command.Config, ui command.UI) error
• type VersionCommand
  • func (cmd VersionCommand) Execute(args []string) error
  • func (cmd *VersionCommand) Setup(config command.Config, ui command.UI) error

Variables

var Commands commandList

Types

type HelpActor

type HelpActor interface {
	// CommandInfoByName returns back a help command information for the given
	// command
	CommandInfoByName(interface{}, string) (sharedaction.CommandInfo, error)

	// CommandInfos returns a list of all commands
	CommandInfos(interface{}) map[string]sharedaction.CommandInfo
}

HelpActor handles the business logic of the help command

type HelpCommand

type HelpCommand struct {
	UI     command.UI
	Actor  HelpActor
	Config command.Config

	OptionalArgs flag.CommandName `positional-args:"yes"`
	AllCommands  bool             `short:"a" description:"All available CLI commands"`
	// contains filtered or unexported fields
}

func (HelpCommand) Execute

func (cmd HelpCommand) Execute(args []string) error

func (*HelpCommand) Setup

func (cmd *HelpCommand) Setup(config command.Config, ui command.UI) error

type VersionCommand

type VersionCommand struct {
	UI     command.UI
	Config command.Config
	// contains filtered or unexported fields
}

func (VersionCommand) Execute

func (cmd VersionCommand) Execute(args []string) error

func (*VersionCommand) Setup

func (cmd *VersionCommand) Setup(config command.Config, ui command.UI) error