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>
64 lines
1.6 KiB
Go
64 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 terraform
|
|
|
|
import (
|
|
"fmt"
|
|
"sort"
|
|
|
|
"github.com/terraform-docs/terraform-docs/internal/types"
|
|
)
|
|
|
|
// Provider represents a Terraform output.
|
|
type Provider struct {
|
|
Name string `json:"name" toml:"name" xml:"name" yaml:"name"`
|
|
Alias types.String `json:"alias" toml:"alias" xml:"alias" yaml:"alias"`
|
|
Version types.String `json:"version" toml:"version" xml:"version" yaml:"version"`
|
|
Position Position `json:"-" toml:"-" xml:"-" yaml:"-"`
|
|
}
|
|
|
|
// FullName returns full name of the provider, with alias if available
|
|
func (p *Provider) FullName() string {
|
|
if p.Alias != "" {
|
|
return fmt.Sprintf("%s.%s", p.Name, p.Alias)
|
|
}
|
|
return p.Name
|
|
}
|
|
|
|
func sortProvidersByName(x []*Provider) {
|
|
sort.Slice(x, func(i, j int) bool {
|
|
if x[i].Name == x[j].Name {
|
|
return x[i].Name == x[j].Name && x[i].Alias < x[j].Alias
|
|
}
|
|
return x[i].Name < x[j].Name
|
|
})
|
|
}
|
|
|
|
func sortProvidersByPosition(x []*Provider) {
|
|
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
|
|
})
|
|
}
|
|
|
|
type providers []*Provider
|
|
|
|
func (pp providers) sort(enabled bool, by string) { //nolint:unparam
|
|
if !enabled {
|
|
sortProvidersByPosition(pp)
|
|
} else {
|
|
// always sort by name if sorting is enabled
|
|
sortProvidersByName(pp)
|
|
}
|
|
}
|