generators

Documentation

Index

• Variables
• func Build(data any, templateName, templateContent string) (string, error)
• func CreateFilesMap(files []config.File) map[string]File
• func CreateTemplatesMap(filenameTemplatesList []config.FilenameTemplateMap) map[string]string
• func FilterTemplatesMap(filter string, templatesMap map[string]string) map[string]string
• func GenerateFile(templatesMap map[string]string, fileName, fileTmpl, outputFile string, ...) error
• func GenerateFiles(templatesMap map[string]string, filesMap map[string]File, data any, ...) error
• type File

Variables

var ErrUnsupportedFileType = errors.New("unsupported file type")

Functions

func Build

func Build(data any, templateName, templateContent string) (string, error)

Build executes the provided templateContent using the data supplied and returns the resulting string. The templateContent is parsed using the given templateName and executed with the provided data. The data parameter can be of any type.

Parameters:

• data: The input data to be used for populating the template.
• templateName: The name of the template. This could serve as an identifier.
• templateContent: The content of the template in the Go text/template format.

Returns:

• string: The output generated from executing the template with the provided data.
• error: An error, if any, encountered during parsing or execution of the template.

func CreateFilesMap

func CreateFilesMap(files []config.File) map[string]File

CreateFilesMap takes a slice of config.File structs and creates a map where the keys are strings and the values are File structs. Each element in the slice is used to populate the corresponding key-value pair in the map.

Parameters:

• files: A slice of config.File structs representing the files to be mapped.

Returns:

• A map[string]File: A map containing the files where the keys are file names and the values are File structs containing the file's template and imports.

func CreateTemplatesMap

func CreateTemplatesMap(filenameTemplatesList []config.FilenameTemplateMap) map[string]string

CreateTemplatesMap creates a map[string]string from a slice of config.FilenameTemplateMap.

The function takes a slice of config.FilenameTemplateMap as input. Each element in the slice represents a map where keys are filenames (strings) and values are corresponding templates (strings). It iterates over each map in the slice and merges them into a single map[string]string where each filename is mapped to its respective template.

Parameters:

• filenameTemplatesList: A slice of config.FilenameTemplateMap, where each element is a map representing filename-template pairs.

Returns:

• map[string]string: A map where keys are filenames and values are corresponding templates.

Example:

filenameTemplatesList := []config.FilenameTemplateMap{
    {"file1.txt": "template1"},
    {"file2.txt": "template2"},
    {"file3.txt": "template3"},
}
templatesMap := CreateTemplatesMap(filenameTemplatesList)
fmt.Println(templatesMap)

Output:

map[file1.txt:template1 file2.txt:template2 file3.txt:template3]

func FilterTemplatesMap

func FilterTemplatesMap(filter string, templatesMap map[string]string) map[string]string

FilterTemplatesMap filters a map of filenames to templates based on a given filter string.

The function takes a filter string and a map of filenames to templates as input. It iterates over each key-value pair in the input map and adds those pairs to a new map if the filename contains the filter string. The function then returns the filtered map.

Parameters:

• filter: A string representing the filter condition. Only filenames containing this string will be included in the filtered map.
• templatesMap: A map[string]string representing filenames mapped to their corresponding templates.

Returns:

• map[string]string: A map containing key-value pairs from the input map where the filenames contain the filter string.

Example:

templatesMap := map[string]string{
    "file1.txt": "template1",
    "file2.txt": "template2",
    "file3.txt": "template3",
}
filtered := FilterTemplatesMap("2", templatesMap)
fmt.Println(filtered)

Output:

map[file2.txt:template2 file3.txt:template3]

func GenerateFile

func GenerateFile(templatesMap map[string]string, fileName, fileTmpl, outputFile string, data any) error

GenerateFile generates a file using the provided template and data, and writes the output to the specified outputFile. If fileTmpl is provided, it uses that specific template; otherwise, it looks up the template based on the fileName in the templatesMap. The generated file is then formatted based on its extension. If an error occurs during the generation or formatting process, it is returned. If a formatting error occurs and it is not due to an unsupported file type, the error is printed to stdout, but the function proceeds without returning an error.

Parameters:

• templatesMap: A map containing template strings where the keys are file names.
• fileName: The name of the file.
• fileTmpl: A specific template to use for generating the file (optional).
• outputFile: The name of the output file to be generated.
• data: The data to be used in the template for file generation.

Returns:

• An error, if any occurred during the generation or formatting process.

func GenerateFiles

func GenerateFiles(templatesMap map[string]string, filesMap map[string]File, data any, output string) error

GenerateFiles generates multiple files using the provided templates and data, and writes the outputs to the specified output directory. It iterates over templates from the templatesMap and files from the filesMap, merging them into a single map of templates. For each template, it generates a file, applies formatting based on its extension, and saves it to the output directory. Errors that occur during file generation or formatting are collected and returned as a single error. If any errors occur, the function returns an error indicating that errors occurred during file generation or formatting.

Parameters:

• templatesMap: A map containing template strings where the keys are file names.
• filesMap: A map containing File objects where the keys are file names.
• data: The data to be used in the templates for file generation.
• output: The directory where the generated files will be saved.

Returns:

• An error if any occurred during file generation or formatting, otherwise returns nil.

Types

type File

type File struct {
	Tmpl    string
	Imports []string
}