Overview¶

Package print provides configuration, and a Generator.

Configuration¶

`print.Config` is the data structure representation for `.terraform-docs.yml`which will be read and extracted upon execution of terraform-docs cli. On theother hand it can be used directly if you are using terraform-docs as a library.

This will return an instance of `Config` with default values set:

config := print.DefaultConfig()

Alternatively this will return an empty instance of `Config`:

config := print.NewConfig()

Generator¶

`Generator` is an abstract implementation of `format.Type`. It doesn't implement`Generate(*terraform.Module) error` function. It is used directly by differentformat types, i.e. each format extends `Generator` and provides its implementationof `Generate` function.

Generator holds a reference to all the sections (e.g. header, footer, inputs, etc)and also it renders all of them, in a predefined order, in `Content()`.

It also provides `Render(string)` function to process and render the template to generatethe final output content. Following variables and functions are available:

• `{{ .Header }}`• `{{ .Footer }}`• `{{ .Inputs }}`• `{{ .Modules }}`• `{{ .Outputs }}`• `{{ .Providers }}`• `{{ .Requirements }}`• `{{ .Resources }}`• `{{ include "path/fo/file" }}`

Index¶

• Constants
• Variables
• type Config
• • func DefaultConfig() *Config
  • func NewConfig() *Config
  • func ReadConfig(rootDir string, filename string) (*Config, error)
• • func (c *Config) Parse()
  • func (c *Config) Validate() error

const (OutputModeInject  = "inject"OutputModeReplace = "replace")

Output modes.

const (OutputBeginComment = "<!-- BEGIN_TF_DOCS -->"OutputContent      = "{{ .Content }}"OutputEndComment   = "<!-- END_TF_DOCS -->")

Output template.

const (SortName     = "name"SortRequired = "required"SortType     = "type")

Sort types.

var (OutputTemplate =fmt.Sprintf("%s\n%s\n%s",OutputBeginComment,OutputContent,OutputEndComment)OutputModes    =strings.Join([]string{OutputModeInject,OutputModeReplace}, ", "))

Output to file template and modes.

var AllSections =strings.Join(allSections, ", ")

AllSections list.

var SortTypes =strings.Join(allSorts, ", ")

SortTypes list.

This section is empty.