mirror of
https://github.com/terraform-docs/terraform-docs.git
synced 2026-03-27 21:08:41 +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>
91 lines
2.1 KiB
Go
91 lines
2.1 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"
|
|
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/markdown_document*.tmpl
|
|
var markdownDocumentFS embed.FS
|
|
|
|
// markdownDocument represents Markdown Document format.
|
|
type markdownDocument struct {
|
|
*generator
|
|
|
|
config *print.Config
|
|
template *template.Template
|
|
}
|
|
|
|
// NewMarkdownDocument returns new instance of Markdown Document.
|
|
func NewMarkdownDocument(config *print.Config) Type {
|
|
items := readTemplateItems(markdownDocumentFS, "markdown_document")
|
|
|
|
tt := template.New(config, items...)
|
|
tt.CustomFunc(gotemplate.FuncMap{
|
|
"type": func(t string) string {
|
|
result, extraline := PrintFencedCodeBlock(t, "hcl")
|
|
if !extraline {
|
|
result += "\n"
|
|
}
|
|
return result
|
|
},
|
|
"value": func(v string) string {
|
|
if v == "n/a" {
|
|
return v
|
|
}
|
|
result, extraline := PrintFencedCodeBlock(v, "json")
|
|
if !extraline {
|
|
result += "\n"
|
|
}
|
|
return result
|
|
},
|
|
"isRequired": func() bool {
|
|
return config.Settings.Required
|
|
},
|
|
})
|
|
|
|
return &markdownDocument{
|
|
generator: newGenerator(config, true),
|
|
config: config,
|
|
template: tt,
|
|
}
|
|
}
|
|
|
|
// Generate a Terraform module as Markdown document.
|
|
func (d *markdownDocument) Generate(module *terraform.Module) error {
|
|
err := d.generator.forEach(func(name string) (string, error) {
|
|
rendered, err := d.template.Render(name, module)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
return sanitize(rendered), nil
|
|
})
|
|
|
|
d.generator.funcs(withModule(module))
|
|
|
|
return err
|
|
}
|
|
|
|
func init() {
|
|
register(map[string]initializerFn{
|
|
"markdown document": NewMarkdownDocument,
|
|
"markdown doc": NewMarkdownDocument,
|
|
"md document": NewMarkdownDocument,
|
|
"md doc": NewMarkdownDocument,
|
|
})
|
|
}
|