mirror of
https://github.com/terraform-docs/terraform-docs.git
synced 2026-03-27 12:58:35 +07:00
114 lines
2.7 KiB
Go
114 lines
2.7 KiB
Go
/*
|
|
Copyright 2021 The terraform-docs Authors.
|
|
Licensed under the MIT license (the "License"); you may not
|
|
use this file except in compliance with the License.
|
|
|
|
You may obtain a copy of the License at the LICENSE file in
|
|
the root directory of this source tree.
|
|
*/
|
|
|
|
package format
|
|
|
|
import (
|
|
_ "embed" //nolint
|
|
"fmt"
|
|
"reflect"
|
|
"strings"
|
|
gotemplate "text/template"
|
|
|
|
"github.com/terraform-docs/terraform-docs/internal/print"
|
|
"github.com/terraform-docs/terraform-docs/internal/types"
|
|
"github.com/terraform-docs/terraform-docs/template"
|
|
"github.com/terraform-docs/terraform-docs/terraform"
|
|
)
|
|
|
|
//go:embed templates/tfvars_hcl.tmpl
|
|
var tfvarsHCLTpl []byte
|
|
|
|
// TfvarsHCL represents Terraform tfvars HCL format.
|
|
type TfvarsHCL struct {
|
|
template *template.Template
|
|
settings *print.Settings
|
|
}
|
|
|
|
var padding []int
|
|
|
|
// NewTfvarsHCL returns new instance of TfvarsHCL.
|
|
func NewTfvarsHCL(settings *print.Settings) print.Engine {
|
|
tt := template.New(settings, &template.Item{
|
|
Name: "tfvars",
|
|
Text: string(tfvarsHCLTpl),
|
|
})
|
|
tt.CustomFunc(gotemplate.FuncMap{
|
|
"align": func(s string, i int) string {
|
|
return fmt.Sprintf("%-*s", padding[i], s)
|
|
},
|
|
"value": func(s string) string {
|
|
if s == "" || s == "null" {
|
|
return "\"\""
|
|
}
|
|
return s
|
|
},
|
|
"convertToComment": func(s types.String) string {
|
|
return "\n# " + strings.ReplaceAll(string(s), "\n", "\n# ")
|
|
},
|
|
"showDescription": func() bool {
|
|
return settings.ShowDescription
|
|
},
|
|
})
|
|
return &TfvarsHCL{
|
|
template: tt,
|
|
settings: settings,
|
|
}
|
|
}
|
|
|
|
// Generate a Terraform module as Terraform tfvars HCL.
|
|
func (h *TfvarsHCL) Generate(module *terraform.Module) (*print.Generator, error) {
|
|
alignments(module.Inputs, h.settings)
|
|
|
|
rendered, err := h.template.Render("tfvars", module)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return print.NewGenerator(
|
|
"tfvars hcl",
|
|
print.WithContent(strings.TrimSuffix(sanitize(rendered), "\n")),
|
|
), nil
|
|
}
|
|
|
|
func isMultilineFormat(input *terraform.Input) bool {
|
|
isList := input.Type == "list" || reflect.TypeOf(input.Default).Name() == "List"
|
|
isMap := input.Type == "map" || reflect.TypeOf(input.Default).Name() == "Map"
|
|
return (isList || isMap) && input.Default.Length() > 0
|
|
}
|
|
|
|
func alignments(inputs []*terraform.Input, settings *print.Settings) {
|
|
padding = make([]int, len(inputs))
|
|
maxlen := 0
|
|
index := 0
|
|
for i, input := range inputs {
|
|
isDescribed := settings.ShowDescription && input.Description.Length() > 0
|
|
l := len(input.Name)
|
|
if isMultilineFormat(input) || isDescribed {
|
|
for j := index; j < i; j++ {
|
|
padding[j] = maxlen
|
|
}
|
|
padding[i] = l
|
|
maxlen = 0
|
|
index = i + 1
|
|
} else if l > maxlen {
|
|
maxlen = l
|
|
}
|
|
}
|
|
for i := index; i < len(inputs); i++ {
|
|
padding[i] = maxlen
|
|
}
|
|
}
|
|
|
|
func init() {
|
|
register(map[string]initializerFn{
|
|
"tfvars hcl": NewTfvarsHCL,
|
|
})
|
|
}
|