sample

Documentation

Overview

Provides sample commands used to demonstrate the command package.

Index

• Constants
• type HelloCommand
  • func NewHelloCommand() HelloCommand
  • func (cmd HelloCommand) Run(args []string) error
• type SampleConfig
  • func (SampleConfig) Load() error
  • func (cfg SampleConfig) Validate() ([]error, error)

Constants

const (
	COUNT_MIN = 5
	COUNT_MAX = 100
)

Types

type HelloCommand

type HelloCommand struct {
	command.CommandBase
}

Sample hello command for printing "Hello" to the console.

func NewHelloCommand

func NewHelloCommand() HelloCommand

Creates a new HelloCommand.

func (HelloCommand) Run

func (cmd HelloCommand) Run(args []string) error

Run the Hello commands. See usage string for details.

type SampleConfig

type SampleConfig struct {
	Path  string `json:"path"`
	Count int    `json:"count"`
}

A sample config object.

func (SampleConfig) Load

func (SampleConfig) Load() error

Implements Config interface Load method.

func (SampleConfig) Validate

func (cfg SampleConfig) Validate() ([]error, error)

Implements Config interface Validate method. Provides example implementation for writing validations.