project

Documentation

Index

• Constants
• func Clean(output string, err error) (string, error)
• func DeleteModuleBoilerplate(ctx *Context, module string) error
• func GenerateModuleBoilerplate(ctx *Context, module string) error
• func GenerateProjectBoilerplate(ctx *Context) error
• func GetAppNameFromPkgName(s string) string
• func GetPackageName(args []string) string
• func GitRepoName() (string, error)
• func OpenDirectory(workDir string) error
• func RandomName() string
• type Context
  • func NewContext(args []string) *Context
  • func (ctx *Context) WriteDefaultConfig() error
• type TemplateConfig
  • func GetTemplateConfig(ctx *Context, module string) *TemplateConfig

Constants

const (
	DEFAULT_WORKDIR = "./"
	CONFIG_FILENAME = ".stk.yaml"
)

const DEFAULT_MODULE = "ping"

const MODULE_PLACEHOLDER = "ping"

const MODULE_PLACEHOLDER_UPPER = "Ping"

Functions

func Clean

func Clean(output string, err error) (string, error)

func DeleteModuleBoilerplate

func DeleteModuleBoilerplate(ctx *Context, module string) error

func GenerateModuleBoilerplate

func GenerateModuleBoilerplate(ctx *Context, module string) error

func GenerateProjectBoilerplate

func GenerateProjectBoilerplate(ctx *Context) error

func GetAppNameFromPkgName

func GetAppNameFromPkgName(s string) string

getAppNameFromPkgName transforms package name into an app name in lowerCamelCase.

func GetPackageName

func GetPackageName(args []string) string

GetPackageName determines the package name by checking various sources in order of priority.

func GitRepoName

func GitRepoName() (string, error)

func OpenDirectory

func OpenDirectory(workDir string) error

func RandomName

func RandomName() string

Types

type Context

type Context struct {
	IsGitRepo  bool
	IsGoModule bool

	PackageName string
	AppName     string

	WorkDir string

	GitCmd commands.GitCmd
	GoCmd  commands.GoCmd
}

func NewContext

func NewContext(args []string) *Context

func (*Context) WriteDefaultConfig

func (ctx *Context) WriteDefaultConfig() error

type TemplateConfig

type TemplateConfig struct {
	PkgName      string
	AppName      string
	ModName      string
	ExportedName string
}

func GetTemplateConfig

func GetTemplateConfig(ctx *Context, module string) *TemplateConfig