helloworld

Documentation

Index

• Constants
• func Start() error
• type Config
• type Flags
• type HelloWorld
  • func (u *HelloWorld) GetConfig() error
  • func (u *HelloWorld) ParseFlags(args []string)
  • func (u *HelloWorld) Run() error

Constants

const Binary = "hello-world"

Binary is the app name.

Functions

func Start

func Start() error

Start begins the application from a CLI. Parses flags, parses config and executes Run().

Types

type Config

type Config struct {
	Worlds int `json:"worlds" xml:"worlds" toml:"worlds" yaml:"worlds"`
	Hellos int `json:"hellos" xml:"hellos" toml:"hellos" yaml:"hellos"`
}

Config defines our applications's config file parameters.

type Flags

type Flags struct {
	VersionReq bool
	ConfigFile string
}

Flags defines our application's CLI arguments.

type HelloWorld

type HelloWorld struct {
	Flag *flag.FlagSet
	*Flags
	*Config
}

HelloWorld is the main application struct.

func (*HelloWorld) GetConfig

func (u *HelloWorld) GetConfig() error

GetConfig parses and returns our configuration data. Supports any format for config file: xml, yaml, json, toml.

func (*HelloWorld) ParseFlags

func (u *HelloWorld) ParseFlags(args []string)

ParseFlags runs the parser for CLI arguments.

func (*HelloWorld) Run

func (u *HelloWorld) Run() error

Run starts doing things.