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>
111 lines
2.8 KiB
Go
111 lines
2.8 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 (
|
|
"bytes"
|
|
"encoding/json"
|
|
"sort"
|
|
"strings"
|
|
|
|
"github.com/terraform-docs/terraform-docs/internal/types"
|
|
"github.com/terraform-docs/terraform-docs/print"
|
|
)
|
|
|
|
// Input represents a Terraform input.
|
|
type Input struct {
|
|
Name string `json:"name" toml:"name" xml:"name" yaml:"name"`
|
|
Type types.String `json:"type" toml:"type" xml:"type" yaml:"type"`
|
|
Description types.String `json:"description" toml:"description" xml:"description" yaml:"description"`
|
|
Default types.Value `json:"default" toml:"default" xml:"default" yaml:"default"`
|
|
Required bool `json:"required" toml:"required" xml:"required" yaml:"required"`
|
|
Position Position `json:"-" toml:"-" xml:"-" yaml:"-"`
|
|
}
|
|
|
|
// GetValue returns JSON representation of the 'Default' value, which is an 'interface'.
|
|
// If 'Default' is a primitive type, the primitive value of 'Default' will be returned
|
|
// and not the JSON formatted of it.
|
|
func (i *Input) GetValue() string {
|
|
var buf bytes.Buffer
|
|
encoder := json.NewEncoder(&buf)
|
|
encoder.SetIndent("", " ")
|
|
encoder.SetEscapeHTML(false)
|
|
err := encoder.Encode(i.Default)
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
value := strings.TrimSpace(buf.String())
|
|
if value == `null` {
|
|
if i.Required {
|
|
return ""
|
|
}
|
|
return `null` // explicit 'null' value
|
|
}
|
|
return value // everything else
|
|
}
|
|
|
|
// HasDefault indicates if a Terraform variable has a default value set.
|
|
func (i *Input) HasDefault() bool {
|
|
return i.Default.HasDefault() || !i.Required
|
|
}
|
|
|
|
func sortInputsByName(x []*Input) {
|
|
sort.Slice(x, func(i, j int) bool {
|
|
return x[i].Name < x[j].Name
|
|
})
|
|
}
|
|
|
|
func sortInputsByRequired(x []*Input) {
|
|
sort.Slice(x, func(i, j int) bool {
|
|
if x[i].HasDefault() == x[j].HasDefault() {
|
|
return x[i].Name < x[j].Name
|
|
}
|
|
return !x[i].HasDefault() && x[j].HasDefault()
|
|
})
|
|
}
|
|
|
|
func sortInputsByPosition(x []*Input) {
|
|
sort.Slice(x, func(i, j int) bool {
|
|
if x[i].Position.Filename == x[j].Position.Filename {
|
|
return x[i].Position.Line < x[j].Position.Line
|
|
}
|
|
return x[i].Position.Filename < x[j].Position.Filename
|
|
})
|
|
}
|
|
|
|
func sortInputsByType(x []*Input) {
|
|
sort.Slice(x, func(i, j int) bool {
|
|
if x[i].Type == x[j].Type {
|
|
return x[i].Name < x[j].Name
|
|
}
|
|
return x[i].Type < x[j].Type
|
|
})
|
|
}
|
|
|
|
type inputs []*Input
|
|
|
|
func (ii inputs) sort(enabled bool, by string) {
|
|
if !enabled {
|
|
sortInputsByPosition(ii)
|
|
} else {
|
|
switch by {
|
|
case print.SortType:
|
|
sortInputsByType(ii)
|
|
case print.SortRequired:
|
|
sortInputsByRequired(ii)
|
|
case print.SortName:
|
|
sortInputsByName(ii)
|
|
default:
|
|
sortInputsByPosition(ii)
|
|
}
|
|
}
|
|
}
|