package
0.5.16
Repository: https://github.com/gruntwork-io/boilerplate.git
Documentation: pkg.go.dev

# Functions

Check that the given value matches the type we're expecting in the given variable and return an error if it doesn't.
ConvertValidationStringtoRules takes the string representation of the variable's validations and parses it into CustomValidationRules that should be run on the variable's value when submitted by a user.
convertYAMLToStringMap modifies an input with type map[interface{}]interface{} to map[string]interface{} so that it may be properly marshalled in to JSON.
Create a new variable that holds a bool.
Create a new variable that holds an enum with the given possible values.
Create a new variable that holds a float.
Create a new variable that holds an int.
Create a new variable that holds a list of strings.
Create a new variable that holds a map of string to string.
Create a new variable that holds a string.
Convert the given string to a BoilerplateType enum, or return an error if this is not a valid value for the BoilerplateType enum.
Parse the variables in the given YAML file into a map of variable name to variable value.
Parse variables passed in via command line options, either as a list of NAME=VALUE variable pairs in varsList, or a list of paths to YAML files that define NAME: VALUE pairs.
Parse a YAML string into a Go type.
Given a unique variable name, return a tuple that contains the dependency name (if any) and the variable name.
Given a map of key:value pairs read from a Boilerplate YAML config file of the format: dependencies: - name: <NAME> template-url: <TEMPLATE_URL> output-folder: <OUTPUT_FOLDER> - name: <NAME> template-url: <TEMPLATE_URL> output-folder: <OUTPUT_FOLDER> This method takes the data above and unmarshals it into a list of Dependency objects.
Given a map of key:value pairs read from a Boilerplate YAML config file of the format: name: <NAME> template-url: <TEMPLATE_URL> output-folder: <OUTPUT_FOLDER> This method takes the data above and unmarshals it into a Dependency object.
Given a list of key:value pairs read from a Boilerplate YAML config file of the format: engines: - path: <PATH> template_engine: <TEMPLATE_ENGINE> convert to a list of Engine structs.
Given a map of key:value pairs read from a Boilerplate YAML config file of the format: hooks: before: - command: <CMD> args: - <ARG> env: <KEY>: <VALUE> skip: <CONDITION> after: - command: <CMD> args: - <ARG> env: <KEY>: <VALUE> skip: <CONDITION> This method takes the data above and unmarshals it into a Hooks struct.
Given a map of key:value pairs read from a Boilerplate YAML config file of the format: fieldName: - value1 - value2 - value3 This method takes looks up the given fieldName in the map and unmarshals the data inside of it it into a list of strings with the given values.
Given a list of key:value pairs read from a Boilerplate YAML config file of the format: skip_files: - path: <PATH> if: <SKIPIF> - path: <PATH> - not_path: <PATH> convert to a list of SkipFile structs.
UnmarshalString is the public convenience interface for unmarshalStringField.
Given a map of key:value pairs read from a Boilerplate YAML config file of the format: name: <NAME> description: <DESCRIPTION> type: <TYPE> default: <DEFAULT> This method takes the data above and unmarshals it into a Variable object.
Given a map of key:value pairs read from a Boilerplate YAML config file of the format: variables: - name: <NAME> description: <DESCRIPTION> type: <TYPE> - name: <NAME> description: <DESCRIPTION> default: <DEFAULT> This method takes the data above and unmarshals it into a list of Variable objects.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author

# Variables

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

No description provided by the author
A single boilerplate template that this boilerplate.yml depends on being executed first.
A single engine entry, which specifies which template engine should be used to render the given files grabbed by the glob.
No description provided by the author
A single hook, which is a command that is executed by boilerplate.
All the scripts to execute as boilerplate hooks.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A single skip_file entry, which is a file that (conditionally) should be excluded from the rendered output.
No description provided by the author
No description provided by the author
No description provided by the author

# Interfaces

An interface for a variable defined in a boilerplate.yml config file.

# Type aliases

An enum that represents the types we support for boilerplate variables.
No description provided by the author
No description provided by the author
No description provided by the author
Custom errors.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author