gotemplate

type BoolValue ¶

type BoolValue bool

func (v BoolValue) Value(_ *OptionValues) bool

type BoolValuer ¶

type BoolValuer interface {
	Value(vals *OptionValues) bool
}

type Category ¶

type Category struct {
	Name    string
	Options []Option
}

Category is used to wrap multiple extensions into one organizational unit. This is to reduce the amount of required user input if certain categories if extensions can be skipped as a category instead of needing to skip all one by one.

type DynamicBoolValue ¶

type DynamicBoolValue func(vals *OptionValues) bool

DefferedValue is a func that calculates the Value based on earlier inputs.

func (f DynamicBoolValue) Value(vals *OptionValues) bool

type DynamicStringValue ¶

type DynamicStringValue func(vals *OptionValues) string

DefferedValue is a func that calculates the Value based on earlier inputs.

func (f DynamicStringValue) Value(vals *OptionValues) string

type DynamicValue ¶

type DynamicValue func(vals *OptionValues) interface{}

DefferedValue is a func that calculates the Value based on earlier inputs.

func (f DynamicValue) Value(vals *OptionValues) interface{}

type ErrInvalidPattern ¶

type ErrInvalidPattern struct {
	Value       string
	Pattern     string
	Description string
}

ErrInvalidPattern indicates that an error occurred while matching a value with a pattern. The pattern as well as a description for the pattern is included in the error message.

func (e *ErrInvalidPattern) Error() string

type ErrOutOfRange ¶

type ErrOutOfRange struct {
	Value int
	Min   int
	Max   int
}

func (e *ErrOutOfRange) Error() string

type ErrTypeMismatch ¶

type ErrTypeMismatch struct {
	Expected string
	Actual   string
}

func (e *ErrTypeMismatch) Error() string

type GT ¶

type GT struct {
	Streams
	Options         *Options
	FuncMap         template.FuncMap
	GithubTagLister repos.GithubTagLister
	// contains filtered or unexported fields
}

func New() *GT

func (gt *GT) CheckVersion()

func (gt *GT) InitNewProject(opts *NewRepositoryOptions) (err error)

func (gt *GT) LoadConfigValuesFromFile(file string) (*OptionValues, error)

func (gt *GT) LoadConfigValuesInteractively() (*OptionValues, error)

func (gt *GT) PrintVersion()

type NewOptionOption ¶

type NewOptionOption func(*Option)

func WithPosthook(postHook PostHookFunc) NewOptionOption

func WithShouldDisplay(shouldDisplay BoolValuer) NewOptionOption

func WithValidator(validator Validator) NewOptionOption

type NewRepositoryOptions ¶

type NewRepositoryOptions struct {
	OutputDir    string
	OptionValues *OptionValues
}

func (opts NewRepositoryOptions) Validate() error

type Option ¶

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

Option is a struct containing all needed configuration for options to customize the template.

func NewOption(name, description string, defaultValue Valuer, opts ...NewOptionOption) Option

func (s *Option) Default(currentValues *OptionValues) interface{}

func (s *Option) Description() string

func (s *Option) Name() string

func (s *Option) PostHook(v interface{}, optionValues *OptionValues, targetDir string) error

func (s *Option) ShouldDisplay(currentValues *OptionValues) bool

func (s *Option) Validate(value interface{}) error

type OptionNameToValue ¶

type OptionNameToValue map[string]interface{}

type OptionValues ¶

type OptionValues struct {
	Base       OptionNameToValue            `yaml:"base"`
	Extensions map[string]OptionNameToValue `yaml:"extensions"`
}

OptionValues is a struct mirroring the structure of Options but using maps. Instead of the whole option only the set value of the option is kept. This makes looking up already supplied option values easier than it would be in the Options struct.

func NewOptionValues() *OptionValues

type Options ¶

type Options struct {
	Base       []Option
	Extensions []Category
}

Options is the main struct wrapping the configuration for all allowed parameters and extensions. Slices are used instead of maps since the iteration order of maps is undefined/random. which could lead to confusion.

func NewOptions(githubTagLister repos.GithubTagLister) *Options

type PostHookFunc ¶

type PostHookFunc func(value interface{}, optionValues *OptionValues, targetDir string) error

type Streams ¶

type Streams struct {
	Out       io.Writer
	Err       io.Writer
	InScanner *bufio.Scanner
}

type StringValue ¶

type StringValue string

func (v StringValue) Value(_ *OptionValues) string

type StringValuer ¶

type StringValuer interface {
	Value(vals *OptionValues) string
}

type Validator ¶

type Validator interface {
	Validate(value interface{}) error
}

Validator is a single method interface that validates that a given value is valid. If any error happens during validation or if the value is not valid an error will be returned.

type ValidatorFunc ¶

type ValidatorFunc func(value interface{}) error

ValidatorFunc is a function implementing the Validator interface.

func RangeValidator(min, max int) ValidatorFunc

func RegexValidator(pattern, description string) ValidatorFunc

func (f ValidatorFunc) Validate(value interface{}) error

type Value ¶

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

func StaticValue(v interface{}) *Value

func (v *Value) Value(_ *OptionValues) interface{}

type Valuer ¶

type Valuer interface {
	Value(vals *OptionValues) interface{}
}