Documentation
¶
Overview ¶
Package print provides a specific definition of a printer Engine.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Engine ¶
Engine represents a plugin printer format. This interface must be satisfied by plugin for terraform-docs core to be able to pick it up and execute it properly.
type Settings ¶
type Settings struct {
// EscapeCharacters escapes special characters (such as _ * in Markdown and > < in JSON)
//
// default: true
// scope: Markdown
EscapeCharacters bool
// IndentLevel control the indentation of headers [available: 1, 2, 3, 4, 5]
//
// default: 2
// scope: Asciidoc, Markdown
IndentLevel int
// OutputValues extract and show Output values from Terraform module output
//
// default: false
// scope: Global
OutputValues bool
// ShowColor print "colorized" version of result in the terminal
//
// default: true
// scope: Pretty
ShowColor bool
// ShowDataSources shows the data sources in the "Resources" section
//
// default: true
// scope: Global
ShowDataSources bool
// ShowDefault show "Default" column
//
// default: true
// scope: Asciidoc, Markdown
ShowDefault bool
// ShowDescription show "Descriptions" as comment on variables
//
// default: false
// scope: tfvars hcl
ShowDescription bool
//
// default: false
// scope: Global
ShowFooter bool
// ShowHeader show "Header" module information
//
// default: true
// scope: Global
ShowHeader bool
// ShowInputs show "Inputs" information
//
// default: true
// scope: Global
ShowInputs bool
// ShowModuleCalls show "ModuleCalls" information
//
// default: true
// scope: Global
ShowModuleCalls bool
// ShowOutputs show "Outputs" information
//
// default: true
// scope: Global
ShowOutputs bool
// ShowProviders show "Providers" information
//
// default: true
// scope: Global
ShowProviders bool
// ShowRequired show "Required" column
//
// default: true
// scope: Asciidoc, Markdown
ShowRequired bool
// ShowSensitivity show "Sensitive" column
//
// default: true
// scope: Asciidoc, Markdown
ShowSensitivity bool
// ShowRequirements show "Requirements" section
//
// default: true
// scope: Global
ShowRequirements bool
// ShowResources show "Resources" section
//
// default: true
// scope: Global
ShowResources bool
// ShowType show "Type" column
//
// default: true
// scope: Asciidoc, Markdown
ShowType bool
}
Settings represents all settings.
Click to show internal directories.
Click to hide internal directories.