mirror of
https://github.com/terraform-docs/terraform-docs.git
synced 2026-03-27 04:48:33 +07:00
4a9ffe7c33
Moving terraform-docs/plugin-sdk standalone module to in-tree, because
maintaining both of them, specifically if anything needs to be added to
Config, or terraform will required dual effort on both repository. As
such now everything is consolidated under one repository. Example usage
for plugin developer after this move is as follow:
```go
package main
import (
_ "embed" //nolint
"github.com/terraform-docs/terraform-docs/plugin"
"github.com/terraform-docs/terraform-docs/print"
"github.com/terraform-docs/terraform-docs/template"
"github.com/terraform-docs/terraform-docs/terraform"
)
func main() {
plugin.Serve(&plugin.ServeOpts{
Name: "template",
Version: "0.1.0",
Printer: printer,
})
}
//go:embed sections.tmpl
var tplCustom []byte
// Print the custom format template. You have all the flexibility to generate
// the output however you choose to.
func printer(config *print.Config, module *terraform.Module) (string, error) {
tpl := template.New(config,
&template.Item{Name: "custom", Text: string(tplCustom)},
)
rendered, err := tpl.Render("custom", module)
if err != nil {
return "", err
}
return rendered, nil
}
```
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
73 lines
2.3 KiB
Go
73 lines
2.3 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 terraform
|
|
|
|
import (
|
|
"encoding/xml"
|
|
)
|
|
|
|
// Module represents a Terraform module. It consists of
|
|
type Module struct {
|
|
XMLName xml.Name `json:"-" toml:"-" xml:"module" yaml:"-"`
|
|
|
|
Header string `json:"header" toml:"header" xml:"header" yaml:"header"`
|
|
Footer string `json:"footer" toml:"footer" xml:"footer" yaml:"footer"`
|
|
Inputs []*Input `json:"inputs" toml:"inputs" xml:"inputs>input" yaml:"inputs"`
|
|
ModuleCalls []*ModuleCall `json:"modules" toml:"modules" xml:"modules>module" yaml:"modules"`
|
|
Outputs []*Output `json:"outputs" toml:"outputs" xml:"outputs>output" yaml:"outputs"`
|
|
Providers []*Provider `json:"providers" toml:"providers" xml:"providers>provider" yaml:"providers"`
|
|
Requirements []*Requirement `json:"requirements" toml:"requirements" xml:"requirements>requirement" yaml:"requirements"`
|
|
Resources []*Resource `json:"resources" toml:"resources" xml:"resources>resource" yaml:"resources"`
|
|
|
|
RequiredInputs []*Input `json:"-" toml:"-" xml:"-" yaml:"-"`
|
|
OptionalInputs []*Input `json:"-" toml:"-" xml:"-" yaml:"-"`
|
|
}
|
|
|
|
// HasHeader indicates if the module has header.
|
|
func (m *Module) HasHeader() bool {
|
|
return len(m.Header) > 0
|
|
}
|
|
|
|
// HasFooter indicates if the module has footer.
|
|
func (m *Module) HasFooter() bool {
|
|
return len(m.Footer) > 0
|
|
}
|
|
|
|
// HasInputs indicates if the module has inputs.
|
|
func (m *Module) HasInputs() bool {
|
|
return len(m.Inputs) > 0
|
|
}
|
|
|
|
// HasModuleCalls indicates if the module has modulecalls.
|
|
func (m *Module) HasModuleCalls() bool {
|
|
return len(m.ModuleCalls) > 0
|
|
}
|
|
|
|
// HasOutputs indicates if the module has outputs.
|
|
func (m *Module) HasOutputs() bool {
|
|
return len(m.Outputs) > 0
|
|
}
|
|
|
|
// HasProviders indicates if the module has providers.
|
|
func (m *Module) HasProviders() bool {
|
|
return len(m.Providers) > 0
|
|
}
|
|
|
|
// HasRequirements indicates if the module has requirements.
|
|
func (m *Module) HasRequirements() bool {
|
|
return len(m.Requirements) > 0
|
|
}
|
|
|
|
// HasResources indicates if the module has resources.
|
|
func (m *Module) HasResources() bool {
|
|
return len(m.Resources) > 0
|
|
}
|