mirror of
https://github.com/terraform-docs/terraform-docs.git
synced 2026-03-27 04:48:33 +07:00
465dd14cff
Add one extra special variable the `content`:
- `{{ .Module }}`
As opposed to the other variables, which are generated sections based on
a selected formatter, the `{{ .Module }}` variable is just a `struct`
representing a Terraform module.
It can be used to build highly complex and highly customized content:
```yaml
content: |-
## Resources
{{ range .Module.Resources }}
- {{ .GetMode }}.{{ .Spec }} ({{ .Position.Filename }}#{{ .Position.Line }})
{{- end }}
```
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
77 lines
1.6 KiB
Go
77 lines
1.6 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"
|
|
"regexp"
|
|
gotemplate "text/template"
|
|
|
|
"github.com/terraform-docs/terraform-docs/print"
|
|
"github.com/terraform-docs/terraform-docs/template"
|
|
"github.com/terraform-docs/terraform-docs/terraform"
|
|
)
|
|
|
|
//go:embed templates/pretty.tmpl
|
|
var prettyTpl []byte
|
|
|
|
// pretty represents colorized pretty format.
|
|
type pretty struct {
|
|
*generator
|
|
|
|
config *print.Config
|
|
template *template.Template
|
|
}
|
|
|
|
// NewPretty returns new instance of Pretty.
|
|
func NewPretty(config *print.Config) Type {
|
|
tt := template.New(config, &template.Item{
|
|
Name: "pretty",
|
|
Text: string(prettyTpl),
|
|
})
|
|
tt.CustomFunc(gotemplate.FuncMap{
|
|
"colorize": func(c string, s string) string {
|
|
r := "\033[0m"
|
|
if !config.Settings.Color {
|
|
c = ""
|
|
r = ""
|
|
}
|
|
return fmt.Sprintf("%s%s%s", c, s, r)
|
|
},
|
|
})
|
|
|
|
return &pretty{
|
|
generator: newGenerator(config, true),
|
|
config: config,
|
|
template: tt,
|
|
}
|
|
}
|
|
|
|
// Generate a Terraform module document.
|
|
func (p *pretty) Generate(module *terraform.Module) error {
|
|
rendered, err := p.template.Render("pretty", module)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
p.generator.funcs(withContent(regexp.MustCompile(`(\r?\n)*$`).ReplaceAllString(rendered, "")))
|
|
p.generator.funcs(withModule(module))
|
|
|
|
return nil
|
|
}
|
|
|
|
func init() {
|
|
register(map[string]initializerFn{
|
|
"pretty": NewPretty,
|
|
})
|
|
}
|