usecase

package

v2.0.0+incompatible Latest Latest Go to latest Published: Nov 7, 2018 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/suzuki-shunsuke/go-gencfg

Links

Open Source Insights

Documentation ¶

Overview ¶

Package usecase provides application logic.

Index ¶

Constants
func Compare(args domain.CompareArgs) error
func GenCfgFile(args domain.GenCfgFileArgs) error
func InitGenCfgFile(args domain.InitGenCfgFileArgs) error
func ValidateGenCfgFileArgs(args domain.GenCfgFileArgs) error
type CfgUsecase
type EnvUsecase
type FlagUsecase
- func (fuc FlagUsecase) IsBind(f domain.Flag, def *bool) bool
type ParamUsecase

Constants ¶

View Source

const DefaultCfgTmpl = `` /* 3266-byte string literal not displayed */

DefaultCfgTmpl is the default template of the generated wrapper code.

View Source

const GenCfgTmpl = `` /* 643-byte string literal not displayed */

GenCfgTmpl is the template of the configuration file.

Variables ¶

This section is empty.

Functions ¶

func Compare ¶

func Compare(args domain.CompareArgs) error

Compare generates the configuration wrapper and test file.

func GenCfgFile ¶

func GenCfgFile(args domain.GenCfgFileArgs) error

GenCfgFile generates the configuration wrapper and test file.

func InitGenCfgFile ¶

func InitGenCfgFile(args domain.InitGenCfgFileArgs) error

InitGenCfgFile generates the configuration wrapper and test file.

func ValidateGenCfgFileArgs ¶

func ValidateGenCfgFileArgs(args domain.GenCfgFileArgs) error

ValidateGenCfgFileArgs validates domain.GenCfgFileArgs .

Types ¶

type CfgUsecase ¶

type CfgUsecase struct{}

CfgUsecase implements domain.CfgUsecase interface.

func (CfgUsecase) GetPkg ¶

func (uc CfgUsecase) GetPkg(cfg domain.Cfg) string

GetPkg returns the package path.

func (CfgUsecase) GetPkgName ¶

func (uc CfgUsecase) GetPkgName(cfg domain.Cfg) string

GetPkgName returns the package name.

func (CfgUsecase) HasFlag ¶

func (uc CfgUsecase) HasFlag(flagUC domain.FlagUsecase, cfg domain.Cfg) bool

HasFlag returns whether there is a bound flag.

func (CfgUsecase) Update ¶

func (uc CfgUsecase) Update(cfg *domain.Cfg)

Update updates cfg before rendering.

type EnvUsecase ¶

type EnvUsecase struct{}

EnvUsecase represents environment variable.

func (EnvUsecase) GetName ¶

func (envUC EnvUsecase) GetName(e domain.Env, pName string, gPrefix *string) string

GetName returns the environment variable name.

func (EnvUsecase) GetPrefix ¶

func (envUC EnvUsecase) GetPrefix(e domain.Env, gPrefix *string) string

GetPrefix returns the environment variable name's prefix.

func (EnvUsecase) IsBind ¶

func (envUC EnvUsecase) IsBind(e domain.Env, def *bool) bool

IsBind returns whether the environment variable is bound.

type FlagUsecase ¶

type FlagUsecase struct{}

FlagUsecase represents flag.

func (FlagUsecase) IsBind ¶

func (fuc FlagUsecase) IsBind(f domain.Flag, def *bool) bool

IsBind returns whether the flag is bound.

type ParamUsecase ¶

type ParamUsecase struct{}

ParamUsecase represents a parameter.

func (ParamUsecase) CamelCaseLowerName ¶

func (pUC ParamUsecase) CamelCaseLowerName(p domain.Param) string

CamelCaseLowerName returns the camel case lower parameter name.

func (ParamUsecase) CamelCaseName ¶

func (pUC ParamUsecase) CamelCaseName(p domain.Param) string

CamelCaseName returns the camel case parameter name.

func (ParamUsecase) GetDefaultStr ¶

func (pUC ParamUsecase) GetDefaultStr(p domain.Param) string

GetDefaultStr returns a string embedded the code as default value.

func (ParamUsecase) GetEnvName ¶

func (pUC ParamUsecase) GetEnvName(p domain.Param) string

GetEnvName returns the environment variable name.

func (ParamUsecase) GetFlagDescription ¶

func (pUC ParamUsecase) GetFlagDescription(p domain.Param) string

GetFlagDescription returns the flag's description.

func (ParamUsecase) GetFlagName ¶

func (pUC ParamUsecase) GetFlagName(p domain.Param) string

GetFlagName returns the flag name.

func (ParamUsecase) GetPFlagName ¶

func (pUC ParamUsecase) GetPFlagName(p domain.Param) string

GetPFlagName returns the PFlag name.

func (ParamUsecase) GetType ¶

func (pUC ParamUsecase) GetType(p domain.Param) string

GetType returns the name of parameter's data type (ex. "int", "string").

func (ParamUsecase) GetViperGetterName ¶

func (pUC ParamUsecase) GetViperGetterName(p domain.Param) string

GetViperGetterName returns the paramter's getter name.

func (ParamUsecase) IsSetDefault ¶

func (pUC ParamUsecase) IsSetDefault(p domain.Param) bool

IsSetDefault returns whether the parameter is set the default value.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL