templates

README

templates

import "github.com/slalombuild/fusion/templates"

Package templates includes go text/templates for terraform resources

Index

• Variables
• func Execute(templateString string, data interface{}) (*bytes.Buffer, error)
• func FormatHCL(template string) string
• func Highlight(w io.Writer, text string, lang Language, skipColor bool) error
• type Language
• type Renderer

Variables

var (
    ErrTemplateParse = "failed to parse text/template during template.Execute"
    ErrTemplateExec  = "failed to execute template during exec()"
)

var (
    ErrNoColor   = "failed to print output with NO_COLOR"
    ErrHighlight = "failed to highlight %s source"
    ErrFmt       = "failed to format %s source"
)

go:embed aws/*.tmpl gcp/*.tmpl azure/*.tmpl

var ALL_TEMPLATES embed.FS

func Execute

func Execute(templateString string, data interface{}) (*bytes.Buffer, error)

Execute renders the template string into a buffer and includes some useful helper functions

func FormatHCL

func FormatHCL(template string) string

FormatHCL formats an HCL string and trims whitespace

func Highlight

func Highlight(w io.Writer, text string, lang Language, skipColor bool) error

Highlight and format text

type Language

type Language int

const (
    GO  Language = iota
    HCL
    PLAINTEXT
)

type Renderer

Renderer is the required interface for terraform templates to be rendered

type Renderer interface {
    Render(w io.Writer, skipColor bool) error
}

Generated by gomarkdoc

Documentation

Overview

Package templates includes go text/templates for terraform resources

Index

• Variables
• func Execute(templateString string, data interface{}) (*bytes.Buffer, error)
• func FormatHCL(template string) string
• func Highlight(w io.Writer, text string, lang Language, skipColor bool) error
• type Language
• type Renderer

Variables

var (
	ErrTemplateParse = "failed to parse text/template during template.Execute"
	ErrTemplateExec  = "failed to execute template during exec()"
)

var (
	ErrNoColor   = "failed to print output with NO_COLOR"
	ErrHighlight = "failed to highlight %s source"
	ErrFmt       = "failed to format %s source"
)

var ALL_TEMPLATES embed.FS

Functions

func Execute

func Execute(templateString string, data interface{}) (*bytes.Buffer, error)

Execute renders the template string into a buffer and includes some useful helper functions

func FormatHCL

func FormatHCL(template string) string

FormatHCL formats an HCL string and trims whitespace

func Highlight

func Highlight(w io.Writer, text string, lang Language, skipColor bool) error

Highlight and format text

Types

type Language

type Language int

const (
	GO Language = iota
	HCL
	PLAINTEXT
)

type Renderer

type Renderer interface {
	Render(w io.Writer, skipColor bool) error
}

Renderer is the required interface for terraform templates to be rendered