mirror of
https://github.com/terraform-docs/terraform-docs.git
synced 2026-03-27 12:58:35 +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>
60 lines
1.1 KiB
Go
60 lines
1.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 (
|
|
"bytes"
|
|
"strings"
|
|
|
|
tomlsdk "github.com/BurntSushi/toml"
|
|
|
|
"github.com/terraform-docs/terraform-docs/print"
|
|
"github.com/terraform-docs/terraform-docs/terraform"
|
|
)
|
|
|
|
// toml represents TOML format.
|
|
type toml struct {
|
|
*generator
|
|
|
|
config *print.Config
|
|
}
|
|
|
|
// NewTOML returns new instance of TOML.
|
|
func NewTOML(config *print.Config) Type {
|
|
return &toml{
|
|
generator: newGenerator(config, false),
|
|
config: config,
|
|
}
|
|
}
|
|
|
|
// Generate a Terraform module as toml.
|
|
func (t *toml) Generate(module *terraform.Module) error {
|
|
copy := copySections(t.config, module)
|
|
|
|
buffer := new(bytes.Buffer)
|
|
encoder := tomlsdk.NewEncoder(buffer)
|
|
|
|
if err := encoder.Encode(copy); err != nil {
|
|
return err
|
|
}
|
|
|
|
t.generator.funcs(withContent(strings.TrimSuffix(buffer.String(), "\n")))
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
func init() {
|
|
register(map[string]initializerFn{
|
|
"toml": NewTOML,
|
|
})
|
|
}
|