Back to godoc.org
github.com/nathmclean/tf_docs

Package tf_docs

v0.0.0-...-e15d8b7
Latest Go to latest

The highest tagged major version is .

Published: Jun 21, 2018 | License: MPL-2.0 | Module: github.com/nathmclean/tf_docs

Index

Constants

const (
	VARIABLE = "variable"
	OUTPUT   = "output"
	MODULE   = "module"
	RESOURCE = "resource"
)

func ListModuleFiles

func ListModuleFiles(directory string) ([]string, error)

listModuleFiles returns a list ouf files with a .tf extension within a directory.

type Comment

type Comment struct {
	Text string
	Col  int
	Line int
}

type Module

type Module struct {
	Name        string
	Description string
	Source      string
}

type Output

type Output struct {
	Description string
	Name        string
}

type Resource

type Resource struct {
	Type        string
	Name        string
	Description string
}

type TFModule

type TFModule struct {
	Path        string
	Title       string
	Link        string
	Variables   []*Variable
	Outputs     []*Output
	Resources   []*Resource
	Modules     []*Module
	Description string
}

func FindAndParse

func FindAndParse(directory string) ([]*TFModule, error)

FindAndParse finds all of the modules within a directory and parses them all.

func Parse

func Parse(hclText []string, moduleName string) (*TFModule, error)

Parse generates a TFModule given a number of Terraform files (as strings) as input

type Value

type Value struct {
	Key     map[string][]string
	Val     map[string]string
	Comment Comment
}

type Variable

type Variable struct {
	Name        string
	Type        string
	Description string
	Default     string
	Required    bool
}

Package Files

Documentation was rendered with GOOS=linux and GOARCH=amd64.

Jump to identifier

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to identifier