chore(lint): various linting and formatting updates

- migrated away from ioutil as it's been deprecated since go 1.16
- also believe this fixes a few cases of unhandled errors
- added golangci-lint config

Signed-off-by: Liam Stanley <[email protected]>

Author: lrstanley

.golangci.yml

@@ -0,0 +1,19 @@
+run:
+  tests: False
+  timeout: 3m
+
+severity:
+  default-severity: error
+  rules:
+    - linters:
+        - errcheck
+        - gocritic
+      severity: warning
+
+linters:
+  enable:
+    - asciicheck
+    - exportloopref
+    - gci
+    - gofmt
+    - misspell

cmd/tfplugindocs/main.go

@@ -3,9 +3,8 @@ package main
 import (
 	"os"
 
-	"github.com/mattn/go-colorable"
-
 	"github.com/hashicorp/terraform-plugin-docs/internal/cmd"
+	"github.com/mattn/go-colorable"
 )
 
 func main() {

internal/cmd/generate.go

@@ -42,7 +42,7 @@ func (cmd *generateCmd) Help() string {
 		}
 	})
 
-	strBuilder.WriteString(fmt.Sprintf("\nUsage: tfplugindocs generate [<args>]\n\n"))
+	strBuilder.WriteString("\nUsage: tfplugindocs generate [<args>]\n\n")
 	cmd.Flags().VisitAll(func(f *flag.Flag) {
 		if f.DefValue != "" {
 			strBuilder.WriteString(fmt.Sprintf("    --%s <ARG> %s%s%s  (default: %q)\n",

internal/cmd/run.go

@@ -54,7 +54,7 @@ func initCommands(ui cli.Ui) map[string]cli.CommandFactory {
 		"":         defaultFactory,
 		"generate": generateFactory,
 		"validate": validateFactory,
-		//"serve": serveFactory,
+		// "serve": serveFactory,
 	}
 }
 
@@ -81,7 +81,7 @@ func Run(name, version string, args []string, stdin io.Reader, stdout, stderr io
 
 	commands := initCommands(ui)
 
-	cli := cli.CLI{
+	cmd := cli.CLI{
 		Name:       name,
 		Args:       args,
 		Commands:   commands,
@@ -90,7 +90,7 @@ func Run(name, version string, args []string, stdin io.Reader, stdout, stderr io
 		Version:    version,
 	}
 
-	exitCode, err := cli.Run()
+	exitCode, err := cmd.Run()
 	if err != nil {
 		return 1
 	}

internal/cmd/validate.go

@@ -30,7 +30,7 @@ func (cmd *validateCmd) Help() string {
 		}
 	})
 
-	strBuilder.WriteString(fmt.Sprintf("\nUsage: tfplugindocs validate [<args>]\n\n"))
+	strBuilder.WriteString("\nUsage: tfplugindocs validate [<args>]\n\n")
 	cmd.Flags().VisitAll(func(f *flag.Flag) {
 		if f.DefValue != "" {
 			strBuilder.WriteString(fmt.Sprintf("    --%s <ARG> %s%s%s  (default: %q)\n",

internal/mdplain/renderer.go

@@ -18,7 +18,7 @@ func (options *Text) GetFlags() int {
 
 func (options *Text) TitleBlock(out *bytes.Buffer, text []byte) {
 	text = bytes.TrimPrefix(text, []byte("% "))
-	text = bytes.Replace(text, []byte("\n% "), []byte("\n"), -1)
+	text = bytes.ReplaceAll(text, []byte("\n% "), []byte("\n"))
 	out.Write(text)
 	out.WriteString("\n")
 }
@@ -29,7 +29,6 @@ func (options *Text) Header(out *bytes.Buffer, text func() bool, level int, id s
 
 	if !text() {
 		out.Truncate(marker)
-		return
 	}
 }
 
@@ -57,7 +56,7 @@ func (options *Text) BlockQuote(out *bytes.Buffer, text []byte) {
 	out.Write(text)
 }
 
-func (options *Text) Table(out *bytes.Buffer, header []byte, body []byte, columnData []int) {
+func (options *Text) Table(out *bytes.Buffer, header, body []byte, columnData []int) {
 	doubleSpace(out)
 	out.Write(header)
 	out.Write(body)
@@ -93,7 +92,6 @@ func (options *Text) List(out *bytes.Buffer, text func() bool, flags int) {
 
 	if !text() {
 		out.Truncate(marker)
-		return
 	}
 }
 
@@ -107,7 +105,6 @@ func (options *Text) Paragraph(out *bytes.Buffer, text func() bool) {
 
 	if !text() {
 		out.Truncate(marker)
-		return
 	}
 }
 
@@ -130,26 +127,19 @@ func (options *Text) Emphasis(out *bytes.Buffer, text []byte) {
 	out.Write(text)
 }
 
-func (options *Text) Image(out *bytes.Buffer, link []byte, title []byte, alt []byte) {
-	return
-}
+func (options *Text) Image(out *bytes.Buffer, link, title, alt []byte) {}
 
-func (options *Text) LineBreak(out *bytes.Buffer) {
-	return
-}
+func (options *Text) LineBreak(out *bytes.Buffer) {}
 
-func (options *Text) Link(out *bytes.Buffer, link []byte, title []byte, content []byte) {
+func (options *Text) Link(out *bytes.Buffer, link, title, content []byte) {
 	out.Write(content)
 	if !isRelativeLink(link) {
 		out.WriteString(" ")
 		out.Write(link)
 	}
-	return
 }
 
-func (options *Text) RawHtmlTag(out *bytes.Buffer, text []byte) {
-	return
-}
+func (options *Text) RawHtmlTag(out *bytes.Buffer, text []byte) {}
 
 func (options *Text) TripleEmphasis(out *bytes.Buffer, text []byte) {
 	out.Write(text)
@@ -159,9 +149,7 @@ func (options *Text) StrikeThrough(out *bytes.Buffer, text []byte) {
 	out.Write(text)
 }
 
-func (options *Text) FootnoteRef(out *bytes.Buffer, ref []byte, id int) {
-	return
-}
+func (options *Text) FootnoteRef(out *bytes.Buffer, ref []byte, id int) {}
 
 func (options *Text) Entity(out *bytes.Buffer, entity []byte) {
 	out.Write(entity)
@@ -171,25 +159,15 @@ func (options *Text) NormalText(out *bytes.Buffer, text []byte) {
 	out.Write(text)
 }
 
-func (options *Text) Smartypants(out *bytes.Buffer, text []byte) {
-	return
-}
+func (options *Text) Smartypants(out *bytes.Buffer, text []byte) {}
 
-func (options *Text) DocumentHeader(out *bytes.Buffer) {
-	return
-}
+func (options *Text) DocumentHeader(out *bytes.Buffer) {}
 
-func (options *Text) DocumentFooter(out *bytes.Buffer) {
-	return
-}
+func (options *Text) DocumentFooter(out *bytes.Buffer) {}
 
-func (options *Text) TocHeader(text []byte, level int) {
-	return
-}
+func (options *Text) TocHeader(text []byte, level int) {}
 
-func (options *Text) TocFinalize() {
-	return
-}
+func (options *Text) TocFinalize() {}
 
 func doubleSpace(out *bytes.Buffer) {
 	if out.Len() > 0 {
@@ -214,5 +192,5 @@ func isRelativeLink(link []byte) (yes bool) {
 	if len(link) == 1 && link[0] == '/' {
 		yes = true
 	}
-	return
+	return yes
 }

internal/provider/generate.go

@@ -3,7 +3,6 @@ package provider
 import (
 	"context"
 	"fmt"
-	"io/ioutil"
 	"os"
 	"os/exec"
 	"path/filepath"
@@ -128,7 +127,7 @@ func (g *generator) Generate(ctx context.Context) error {
 
 	switch {
 	case g.websiteTmpDir == "":
-		g.websiteTmpDir, err = ioutil.TempDir("", "tfws")
+		g.websiteTmpDir, err = os.MkdirTemp("", "tfws")
 		if err != nil {
 			return fmt.Errorf("unable to create temporary directory: %w", err)
 		}
@@ -190,7 +189,14 @@ func (g *generator) Generate(ctx context.Context) error {
 	return nil
 }
 
-func (g *generator) renderMissingResourceDoc(providerName, name, typeName string, schema *tfjson.Schema, websiteFileTemplate resourceFileTemplate, fallbackWebsiteFileTemplate resourceFileTemplate, websiteStaticCandidateTemplates []resourceFileTemplate, examplesFileTemplate resourceFileTemplate, examplesImportTemplate *resourceFileTemplate) error {
+func (g *generator) renderMissingResourceDoc(
+	providerName, name, typeName string,
+	schema *tfjson.Schema,
+	websiteFileTemplate, fallbackWebsiteFileTemplate resourceFileTemplate,
+	websiteStaticCandidateTemplates []resourceFileTemplate,
+	examplesFileTemplate resourceFileTemplate,
+	examplesImportTemplate *resourceFileTemplate,
+) error {
 	tmplPath, err := websiteFileTemplate.Render(name, providerName)
 	if err != nil {
 		return fmt.Errorf("unable to render path for resource %q: %w", name, err)
@@ -247,7 +253,7 @@ func (g *generator) renderMissingResourceDoc(providerName, name, typeName string
 	fallbackTmplPath = filepath.Join(g.websiteTmpDir, g.websiteSourceDir, fallbackTmplPath)
 	if fileExists(fallbackTmplPath) {
 		g.infof("resource %q fallback template exists", name)
-		tmplData, err := ioutil.ReadFile(fallbackTmplPath)
+		tmplData, err := os.ReadFile(fallbackTmplPath)
 		if err != nil {
 			return fmt.Errorf("unable to read file %q: %w", fallbackTmplPath, err)
 		}
@@ -376,6 +382,10 @@ func (g *generator) renderStaticWebsite(providerName string, providerSchema *tfj
 	g.infof("rendering templated website to static markdown")
 
 	err = filepath.Walk(g.websiteTmpDir, func(path string, info os.FileInfo, err error) error {
+		if err != nil {
+			return fmt.Errorf("unable to walk dir %q: %w", g.websiteTmpDir, err)
+		}
+
 		if info.IsDir() {
 			// skip directories
 			return nil
@@ -411,7 +421,7 @@ func (g *generator) renderStaticWebsite(providerName string, providerSchema *tfj
 
 		renderedPath = strings.TrimSuffix(renderedPath, ext)
 
-		tmplData, err := ioutil.ReadFile(path)
+		tmplData, err := os.ReadFile(path)
 		if err != nil {
 			return fmt.Errorf("unable to read file %q: %w", rel, err)
 		}
@@ -493,7 +503,7 @@ func (g *generator) terraformProviderSchema(ctx context.Context, providerName st
 
 	shortName := providerShortName(providerName)
 
-	tmpDir, err := ioutil.TempDir("", "tfws")
+	tmpDir, err := os.MkdirTemp("", "tfws")
 	if err != nil {
 		return nil, fmt.Errorf("unable to create temp dir: %w", err)
 	}
@@ -507,9 +517,8 @@ func (g *generator) terraformProviderSchema(ctx context.Context, providerName st
 	g.infof("compiling provider %q", shortName)
 	providerPath := fmt.Sprintf("plugins/registry.terraform.io/hashicorp/%s/0.0.1/%s_%s", shortName, runtime.GOOS, runtime.GOARCH)
 	outFile := filepath.Join(tmpDir, providerPath, fmt.Sprintf("terraform-provider-%s", shortName))
-	switch runtime.GOOS {
-	case "windows":
-		outFile = outFile + ".exe"
+	if runtime.GOOS == "windows" {
+		outFile += ".exe"
 	}
 	buildCmd := exec.Command("go", "build", "-o", outFile)
 	// TODO: constrain env here to make it a little safer?

internal/provider/template.go

@@ -7,14 +7,12 @@ import (
 	"strings"
 	"text/template"
 
-	"golang.org/x/text/cases"
-	"golang.org/x/text/language"
-
 	tfjson "github.com/hashicorp/terraform-json"
-
 	"github.com/hashicorp/terraform-plugin-docs/internal/mdplain"
 	"github.com/hashicorp/terraform-plugin-docs/internal/tmplfuncs"
 	"github.com/hashicorp/terraform-plugin-docs/schemamd"
+	"golang.org/x/text/cases"
+	"golang.org/x/text/language"
 )
 
 const (
@@ -62,7 +60,7 @@ func terraformCodeFile(file string) (string, error) {
 	return tmplfuncs.CodeFile("terraform", file)
 }
 
-func renderTemplate(name string, text string, out io.Writer, data interface{}) error {
+func renderTemplate(name, text string, out io.Writer, data interface{}) error {
 	tmpl, err := newTemplate(name, text)
 	if err != nil {
 		return fmt.Errorf("unable to parse template %q: %w", text, err)

internal/provider/util.go

@@ -3,7 +3,6 @@ package provider
 import (
 	"fmt"
 	"io"
-	"io/ioutil"
 	"log"
 	"os"
 	"os/exec"
@@ -71,14 +70,14 @@ func resourceSchema(schemas map[string]*tfjson.Schema, providerShortName, templa
 	return nil, resName
 }
 
-func writeFile(path string, data string) error {
+func writeFile(path, data string) error {
 	dir, _ := filepath.Split(path)
 	err := os.MkdirAll(dir, 0o755)
 	if err != nil {
 		return fmt.Errorf("unable to make dir %q: %w", dir, err)
 	}
 
-	err = ioutil.WriteFile(path, []byte(data), 0o644)
+	err = os.WriteFile(path, []byte(data), 0o644)
 	if err != nil {
 		return fmt.Errorf("unable to write file %q: %w", path, err)
 	}
@@ -90,7 +89,7 @@ func runCmd(cmd *exec.Cmd) ([]byte, error) {
 	output, err := cmd.CombinedOutput()
 	if err != nil {
 		log.Printf("error executing %q, %v", cmd.Path, cmd.Args)
-		log.Printf(string(output))
+		log.Println(string(output))
 		return nil, fmt.Errorf("error executing %q: %w", cmd.Path, err)
 	}
 	return output, nil

internal/tmplfuncs/tmplfuncs.go

@@ -2,7 +2,6 @@ package tmplfuncs
 
 import (
 	"fmt"
-	"io/ioutil"
 	"os"
 	"path/filepath"
 	"strings"
@@ -21,7 +20,7 @@ func CodeFile(format, file string) (string, error) {
 	}
 
 	fullPath := filepath.Join(wd, file)
-	content, err := ioutil.ReadFile(fullPath)
+	content, err := os.ReadFile(fullPath)
 	if err != nil {
 		return "", fmt.Errorf("unable to read content from %q: %w", file, err)
 	}