app

Documentation

Overview

Package app defines an application framework used to create application.

Index

• func FormatBaseName(basename string) string
• type App
  • func NewApp(name, basename string, opts ...Option) *App
  • func (a *App) Run()
• type Option
  • func WithDescription(commandDesc string) Option
  • func WithOptions(opt Optioners) Option
  • func WithRunFunc(runFunc RunFunc) Option
• type Optioners
• type RunFunc

Functions

func FormatBaseName

func FormatBaseName(basename string) string

Types

type App

type App struct {
	// contains filtered or unexported fields
}

func NewApp

func NewApp(name, basename string, opts ...Option) *App

func (*App) Run

func (a *App) Run()

type Option

type Option func(*App)

func WithDescription

func WithDescription(commandDesc string) Option

func WithOptions

func WithOptions(opt Optioners) Option

func WithRunFunc

func WithRunFunc(runFunc RunFunc) Option

type Optioners

type Optioners interface {
	Validate() []error
}

type RunFunc

type RunFunc func(basename string) error

RunFunc defines the application's startup callback function.