centersl/terraform-docs
1
0
Fork 0
mirror of https://github.com/terraform-docs/terraform-docs.git synced 2026-03-27 04:48:33 +07:00
Code Issues Packages Projects Releases Wiki Activity

chore: fix golangci-lint issues

Browse Source 
Signed-off-by: Pascal Hofmann <mail@pascalhofmann.de>
This commit is contained in:
Pascal Hofmann
2025-12-12 14:21:54 +01:00
parent 4ac0a6a524
commit dd450a5352
16 changed files with 26 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
format/asciidoc_document.go
View File

@@ -69,7 +69,7 @@ func NewAsciidocDocument(config *print.Config) Type {
// Generate a Terraform module as AsciiDoc document. // Generate a Terraform module as AsciiDoc document.
func (d *asciidocDocument) Generate(module *terraform.Module) error { func (d *asciidocDocument) Generate(module *terraform.Module) error {
err := d.generator.forEach(func(name string) (string, error) { err := d.forEach(func(name string) (string, error) {
rendered, err := d.template.Render(name, module) rendered, err := d.template.Render(name, module)
if err != nil { if err != nil {
return "", err return "", err
@@ -77,7 +77,7 @@ func (d *asciidocDocument) Generate(module *terraform.Module) error {
return sanitize(rendered), nil return sanitize(rendered), nil
}) })
d.generator.funcs(withModule(module)) d.funcs(withModule(module))
return err return err
} }

4
format/asciidoc_table.go
View File

@@ -60,7 +60,7 @@ func NewAsciidocTable(config *print.Config) Type {
// Generate a Terraform module as AsciiDoc tables. // Generate a Terraform module as AsciiDoc tables.
func (t *asciidocTable) Generate(module *terraform.Module) error { func (t *asciidocTable) Generate(module *terraform.Module) error {
err := t.generator.forEach(func(name string) (string, error) { err := t.forEach(func(name string) (string, error) {
rendered, err := t.template.Render(name, module) rendered, err := t.template.Render(name, module)
if err != nil { if err != nil {
return "", err return "", err
@@ -68,7 +68,7 @@ func (t *asciidocTable) Generate(module *terraform.Module) error {
return sanitize(rendered), nil return sanitize(rendered), nil
}) })
t.generator.funcs(withModule(module)) t.funcs(withModule(module))
return err return err
} }

2
format/json.go
View File

@@ -47,7 +47,7 @@ func (j *json) Generate(module *terraform.Module) error {
return err return err
} }
j.generator.funcs(withContent(strings.TrimSuffix(buffer.String(), "\n"))) j.funcs(withContent(strings.TrimSuffix(buffer.String(), "\n")))
return nil return nil
} }

4
format/markdown_document.go
View File

@@ -67,7 +67,7 @@ func NewMarkdownDocument(config *print.Config) Type {
// Generate a Terraform module as Markdown document. // Generate a Terraform module as Markdown document.
func (d *markdownDocument) Generate(module *terraform.Module) error { func (d *markdownDocument) Generate(module *terraform.Module) error {
err := d.generator.forEach(func(name string) (string, error) { err := d.forEach(func(name string) (string, error) {
rendered, err := d.template.Render(name, module) rendered, err := d.template.Render(name, module)
if err != nil { if err != nil {
return "", err return "", err
@@ -75,7 +75,7 @@ func (d *markdownDocument) Generate(module *terraform.Module) error {
return sanitize(rendered), nil return sanitize(rendered), nil
}) })
d.generator.funcs(withModule(module)) d.funcs(withModule(module))
return err return err
} }

4
format/markdown_table.go
View File

@@ -58,7 +58,7 @@ func NewMarkdownTable(config *print.Config) Type {
// Generate a Terraform module as Markdown tables. // Generate a Terraform module as Markdown tables.
func (t *markdownTable) Generate(module *terraform.Module) error { func (t *markdownTable) Generate(module *terraform.Module) error {
err := t.generator.forEach(func(name string) (string, error) { err := t.forEach(func(name string) (string, error) {
rendered, err := t.template.Render(name, module) rendered, err := t.template.Render(name, module)
if err != nil { if err != nil {
return "", err return "", err
@@ -66,7 +66,7 @@ func (t *markdownTable) Generate(module *terraform.Module) error {
return sanitize(rendered), nil return sanitize(rendered), nil
}) })
t.generator.funcs(withModule(module)) t.funcs(withModule(module))
return err return err
} }

4
format/pretty.go
View File

@@ -64,8 +64,8 @@ func (p *pretty) Generate(module *terraform.Module) error {
return err return err
} }
p.generator.funcs(withContent(regexp.MustCompile(`(\r?\n)*$`).ReplaceAllString(rendered, ""))) p.funcs(withContent(regexp.MustCompile(`(\r?\n)*$`).ReplaceAllString(rendered, "")))
p.generator.funcs(withModule(module)) p.funcs(withModule(module))
return nil return nil
} }

2
format/tfvars_hcl.go
View File

@@ -76,7 +76,7 @@ func (h *tfvarsHCL) Generate(module *terraform.Module) error {
return err return err
} }
h.generator.funcs(withContent(strings.TrimSuffix(sanitize(rendered), "\n"))) h.funcs(withContent(strings.TrimSuffix(sanitize(rendered), "\n")))
return nil return nil
} }

2
format/tfvars_json.go
View File

@@ -53,7 +53,7 @@ func (j *tfvarsJSON) Generate(module *terraform.Module) error {
return err return err
} }
j.generator.funcs(withContent(strings.TrimSuffix(buffer.String(), "\n"))) j.funcs(withContent(strings.TrimSuffix(buffer.String(), "\n")))
return nil return nil
} }

2
format/toml.go
View File

@@ -46,7 +46,7 @@ func (t *toml) Generate(module *terraform.Module) error {
return err return err
} }
t.generator.funcs(withContent(strings.TrimSuffix(buffer.String(), "\n"))) t.funcs(withContent(strings.TrimSuffix(buffer.String(), "\n")))
return nil return nil

2
format/xml.go
View File

@@ -42,7 +42,7 @@ func (x *xml) Generate(module *terraform.Module) error {
return err return err
} }
x.generator.funcs(withContent(strings.TrimSuffix(string(out), "\n"))) x.funcs(withContent(strings.TrimSuffix(string(out), "\n")))
return nil return nil
} }

2
format/yaml.go
View File

@@ -47,7 +47,7 @@ func (y *yaml) Generate(module *terraform.Module) error {
return err return err
} }
y.generator.funcs(withContent(strings.TrimSuffix(buffer.String(), "\n"))) y.funcs(withContent(strings.TrimSuffix(buffer.String(), "\n")))
return nil return nil
} }

3
internal/plugin/discovery.go
View File

@@ -11,6 +11,7 @@ the root directory of this source tree.
package plugin package plugin
import ( import (
"context"
"fmt" "fmt"
"os" "os"
"os/exec" "os/exec"
@@ -71,7 +72,7 @@ func findPlugins(dir string) (*List, error) {
// path on the fly per directory. // path on the fly per directory.
// //
// nolint:gosec // nolint:gosec
cmd := exec.Command(path) cmd := exec.CommandContext(context.TODO(), path)
client := pluginsdk.NewClient(&pluginsdk.ClientOpts{ client := pluginsdk.NewClient(&pluginsdk.ClientOpts{
Cmd: cmd, Cmd: cmd,

5
plugin/plugin.go
View File

@@ -19,6 +19,9 @@ import (
"github.com/terraform-docs/terraform-docs/internal/types" "github.com/terraform-docs/terraform-docs/internal/types"
) )
// Ensure formatter fully satisfy plugin interface.
var _ goplugin.Plugin = &formatter{}
// handshakeConfig is used for UX. ProcotolVersion will be updated by incompatible changes. // handshakeConfig is used for UX. ProcotolVersion will be updated by incompatible changes.
var handshakeConfig = goplugin.HandshakeConfig{ var handshakeConfig = goplugin.HandshakeConfig{
ProtocolVersion: 7, ProtocolVersion: 7,
@@ -59,7 +62,7 @@ func (f *formatter) Server(b *goplugin.MuxBroker) (interface{}, error) {
} }
// Client returns an RPC client for the host. // Client returns an RPC client for the host.
func (formatter) Client(b *goplugin.MuxBroker, c *rpc.Client) (interface{}, error) { func (*formatter) Client(b *goplugin.MuxBroker, c *rpc.Client) (interface{}, error) {
return &Client{rpcClient: c, broker: b}, nil return &Client{rpcClient: c, broker: b}, nil
} }

2
print/config.go
View File

@@ -287,7 +287,7 @@ func (o *output) validate() error {
for _, t := range tests { for _, t := range tests {
if t.condition() { if t.condition() {
return fmt.Errorf(t.errMessage) return fmt.Errorf("%s", t.errMessage)
} }
} }

2
template/template.go
View File

@@ -51,7 +51,7 @@ func New(config *print.Config, items ...*Item) *Template {
} }
// Funcs return available template out of the box and custom functions. // Funcs return available template out of the box and custom functions.
func (t Template) Funcs() gotemplate.FuncMap { func (t *Template) Funcs() gotemplate.FuncMap {
return t.funcMap return t.funcMap
} }

3
terraform/load.go
View File

@@ -11,6 +11,7 @@ the root directory of this source tree.
package terraform package terraform
import ( import (
"context"
"encoding/json" "encoding/json"
"errors" "errors"
"fmt" "fmt"
@@ -336,7 +337,7 @@ func loadOutputValues(config *print.Config) (map[string]*output, error) {
var out []byte var out []byte
var err error var err error
if config.OutputValues.From == "" { if config.OutputValues.From == "" {
cmd := exec.Command("terraform", "output", "-json") cmd := exec.CommandContext(context.TODO(), "terraform", "output", "-json")
cmd.Dir = config.ModuleRoot cmd.Dir = config.ModuleRoot
if out, err = cmd.Output(); err != nil { if out, err = cmd.Output(); err != nil {
return nil, fmt.Errorf("caught error while reading the terraform outputs: %w", err) return nil, fmt.Errorf("caught error while reading the terraform outputs: %w", err)