helium

README

Helium

• bind - simple replacement for echo.Binder
• cli - simple cli-wrapper for building apps
• examples - of application
• logger - simple package with global / echo logger
• orm - connect to PG database and check connection
• redis - connect to redis and check connection
• settings - wrapper around viper
• validate - simple replacement for echo.Validate

Documentation

Index

• func Run(cfg *Config)
• type ActionFunc
• type App
• type Command
• type Config
• type Container
• type Context
• type InvokeOption
• type ProvideOption

Functions

func Run

func Run(cfg *Config)

Types

type ActionFunc

type ActionFunc func(ctx Context) error

type App

type App interface {
	Commands() []Command
}

type Command

type Command struct {
	// Init method to invoke dependencies
	Init func(di Container) error
	// An action to execute after any subcommands are run, but after the subcommand has finished
	// It is run even if Action() panics
	After cli.AfterFunc
	// An action to execute before any sub-subcommands are run, but after the context is ready
	// If a non-nil error is returned, no sub-subcommands are run
	Before cli.BeforeFunc
	// The function to call when this command is invoked
	Action ActionFunc
	// The name of the command
	Name string
	// short name of the command. Typically one character (deprecated, use `Aliases`)
	ShortName string
	// A list of aliases for the command
	Aliases []string
	// A short description of the usage of this command
	Usage string
}

type Config

type Config struct {
	App       App
	File      string
	Name      string
	Version   string
	BuildTime string
}

type Container

type Container interface {
	Invoke(function interface{}, opts ...InvokeOption) error
	Provide(constructor interface{}, opts ...ProvideOption) error
}

type Context

type Context interface {
	Command() *cli.Context
	Graceful() context.Context
}

type InvokeOption

type InvokeOption = dig.InvokeOption

type ProvideOption

type ProvideOption = dig.ProvideOption