app

Documentation

Index

• Constants
• func Run(gitRev string, gomod []byte)
• type Template
• type VariableInfo
  • func (vi VariableInfo) IsValid(value string) bool
• type VariableInfoStore
• type Variables
  • func (v Variables) Count() int
  • func (v Variables) Has(name string) bool

Constants

const (
	APP  = "scratch"
	VER  = "0.3.3"
	DESC = "Utility for generating blank files for apps and services"
)

const (
	OPT_NO_COLOR = "nc:no-color"
	OPT_HELP     = "h:help"
	OPT_VER      = "v:version"

	OPT_VERB_VER     = "vv:verbose-version"
	OPT_COMPLETION   = "completion"
	OPT_GENERATE_MAN = "generate-man"
)

const (
	VAR_NAME        = "NAME"
	VAR_SHORT_NAME  = "SHORT_NAME"
	VAR_VERSION     = "VERSION"
	VAR_DESC        = "DESC"
	VAR_DESC_README = "DESC_README"

	VAR_CODEBEAT_UUID  = "CODEBEAT_UUID"
	VAR_CODECLIMATE_ID = "CODECLIMATE_ID"

	VAR_SHORT_NAME_TITLE    = "SHORT_NAME_TITLE"
	VAR_SHORT_NAME_LOWER    = "SHORT_NAME_LOWER"
	VAR_SHORT_NAME_UPPER    = "SHORT_NAME_UPPER"
	VAR_SPEC_CHANGELOG_DATE = "SPEC_CHANGELOG_DATE"
)

Functions

func Run

func Run(gitRev string, gomod []byte)

Run is main utility function

Types

type Template

type Template struct {
	Name string // Name of template
	Path string // Path to directory with template data

	Vars Variables // Variables
	Data []string  // List of files and directories of template
}

type VariableInfo

type VariableInfo struct {
	Desc      string
	Validator string
	IsDynamic bool
}

func (VariableInfo) IsValid

func (vi VariableInfo) IsValid(value string) bool

IsValid validates value

type VariableInfoStore

type VariableInfoStore struct {
	Info map[string]VariableInfo
	List []string
}

type Variables

type Variables map[string]string // name → value

func (Variables) Count

func (v Variables) Count() int

Count returns number of variables which requires user input

func (Variables) Has

func (v Variables) Has(name string) bool

Has returns true if map contains variable with given name