scaffolder

Documentation

Index

• func ParseKeyValueFromString(contents string) (key, value string, err error)
• func Scaffold(scaffoldingDir, outputDir string, values Values, scheme Scheme) error
• type Scheme
  • func ParseScheme(path string, val Values) (Scheme, error)
• type SchemeEntry
• type Values

Functions

func ParseKeyValueFromString

func ParseKeyValueFromString(contents string) (key, value string, err error)

func Scaffold

func Scaffold(scaffoldingDir, outputDir string, values Values, scheme Scheme) error

Scaffold processes all scaffolding rules from Scheme and populates scaffolding templates with given values.

Types

type Scheme

type Scheme struct {
	Entries []SchemeEntry `yaml:"scheme"`
}

Scheme holds a set of rules for scaffolding processFile.

func ParseScheme

func ParseScheme(path string, val Values) (Scheme, error)

ParseScheme compiles scheme from given file, completing it with given Values.

type SchemeEntry

type SchemeEntry struct {
	Source      string `yaml:"source"`
	Destination string `yaml:"destination"`
	Recursive   bool   `yaml:"recursive,omitempty"`
}

SchemeEntry holds one rule for scaffolding processFile.

type Values

type Values map[string]string

Values is a container with strings that are to be substituted in scaffolding and scheme.