format

Documentation

Index

• func Factory(name string, settings *print.Settings) (print.Engine, error)
• func NewAsciidocDocument(settings *print.Settings) print.Engine
• func NewAsciidocTable(settings *print.Settings) print.Engine
• func NewJSON(settings *print.Settings) print.Engine
• func NewMarkdownDocument(settings *print.Settings) print.Engine
• func NewMarkdownTable(settings *print.Settings) print.Engine
• func NewPretty(settings *print.Settings) print.Engine
• func NewTOML(settings *print.Settings) print.Engine
• func NewTfvarsHCL(settings *print.Settings) print.Engine
• func NewTfvarsJSON(settings *print.Settings) print.Engine
• func NewXML(settings *print.Settings) print.Engine
• func NewYAML(settings *print.Settings) print.Engine
• type AsciidocDocument
  • func (d *AsciidocDocument) Generate(module *terraform.Module) (*print.Generator, error)
• type AsciidocTable
  • func (t *AsciidocTable) Generate(module *terraform.Module) (*print.Generator, error)
• type JSON
  • func (j *JSON) Generate(module *terraform.Module) (*print.Generator, error)
• type MarkdownDocument
  • func (d *MarkdownDocument) Generate(module *terraform.Module) (*print.Generator, error)
• type MarkdownTable
  • func (t *MarkdownTable) Generate(module *terraform.Module) (*print.Generator, error)
• type Pretty
  • func (p *Pretty) Generate(module *terraform.Module) (*print.Generator, error)
• type TOML
  • func (t *TOML) Generate(module *terraform.Module) (*print.Generator, error)
• type TfvarsHCL
  • func (h *TfvarsHCL) Generate(module *terraform.Module) (*print.Generator, error)
• type TfvarsJSON
  • func (j *TfvarsJSON) Generate(module *terraform.Module) (*print.Generator, error)
• type XML
  • func (x *XML) Generate(module *terraform.Module) (*print.Generator, error)
• type YAML
  • func (y *YAML) Generate(module *terraform.Module) (*print.Generator, error)

Functions

func Factory

func Factory(name string, settings *print.Settings) (print.Engine, error)

Factory initializes and returns the concrete implementation of format.Engine based on the provided 'name', for example for name of 'json' it will return '*format.JSON' through 'format.NewJSON' function.

func NewAsciidocDocument

func NewAsciidocDocument(settings *print.Settings) print.Engine

NewAsciidocDocument returns new instance of AsciidocDocument.

func NewAsciidocTable

func NewAsciidocTable(settings *print.Settings) print.Engine

NewAsciidocTable returns new instance of AsciidocTable.

func NewJSON

func NewJSON(settings *print.Settings) print.Engine

NewJSON returns new instance of JSON.

func NewMarkdownDocument

func NewMarkdownDocument(settings *print.Settings) print.Engine

NewMarkdownDocument returns new instance of Document.

func NewMarkdownTable

func NewMarkdownTable(settings *print.Settings) print.Engine

NewMarkdownTable returns new instance of Table.

func NewPretty

func NewPretty(settings *print.Settings) print.Engine

NewPretty returns new instance of Pretty.

func NewTOML

func NewTOML(settings *print.Settings) print.Engine

NewTOML returns new instance of TOML.

func NewTfvarsHCL

func NewTfvarsHCL(settings *print.Settings) print.Engine

NewTfvarsHCL returns new instance of TfvarsHCL.

func NewTfvarsJSON

func NewTfvarsJSON(settings *print.Settings) print.Engine

NewTfvarsJSON returns new instance of TfvarsJSON.

func NewXML

func NewXML(settings *print.Settings) print.Engine

NewXML returns new instance of XML.

func NewYAML

func NewYAML(settings *print.Settings) print.Engine

NewYAML returns new instance of YAML.

Types

type AsciidocDocument

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

AsciidocDocument represents AsciiDoc Document format.

func (*AsciidocDocument) Generate

func (d *AsciidocDocument) Generate(module *terraform.Module) (*print.Generator, error)

Generate a Terraform module as AsciiDoc document.

type AsciidocTable

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

AsciidocTable represents AsciiDoc Table format.

func (*AsciidocTable) Generate

func (t *AsciidocTable) Generate(module *terraform.Module) (*print.Generator, error)

Generate a Terraform module as AsciiDoc tables.

type JSON

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

JSON represents JSON format.

func (*JSON) Generate

func (j *JSON) Generate(module *terraform.Module) (*print.Generator, error)

Generate a Terraform module as json.

type MarkdownDocument

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

MarkdownDocument represents Markdown Document format.

func (*MarkdownDocument) Generate

func (d *MarkdownDocument) Generate(module *terraform.Module) (*print.Generator, error)

Generate a Terraform module as Markdown document.

type MarkdownTable

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

MarkdownTable represents Markdown Table format.

func (*MarkdownTable) Generate

func (t *MarkdownTable) Generate(module *terraform.Module) (*print.Generator, error)

Generate a Terraform module as Markdown tables.

type Pretty

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

Pretty represents colorized pretty format.

func (*Pretty) Generate

func (p *Pretty) Generate(module *terraform.Module) (*print.Generator, error)

Generate a Terraform module document.

type TOML

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

TOML represents TOML format.

func (*TOML) Generate

func (t *TOML) Generate(module *terraform.Module) (*print.Generator, error)

Generate a Terraform module as toml.

type TfvarsHCL

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

TfvarsHCL represents Terraform tfvars HCL format.

func (*TfvarsHCL) Generate

func (h *TfvarsHCL) Generate(module *terraform.Module) (*print.Generator, error)

Generate a Terraform module as Terraform tfvars HCL.

type TfvarsJSON

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

TfvarsJSON represents Terraform tfvars JSON format.

func (*TfvarsJSON) Generate

func (j *TfvarsJSON) Generate(module *terraform.Module) (*print.Generator, error)

Generate a Terraform module as Terraform tfvars JSON.

type XML

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

XML represents XML format.

func (*XML) Generate

func (x *XML) Generate(module *terraform.Module) (*print.Generator, error)

Generate a Terraform module as xml.

type YAML

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

YAML represents YAML format.

func (*YAML) Generate

func (y *YAML) Generate(module *terraform.Module) (*print.Generator, error)

Generate a Terraform module as yaml.