Allowing single word resources to use templates

Author: bendbennett

internal/provider/generate.go

@@ -414,7 +414,7 @@ func (g *generator) renderStaticWebsite(providerName string, providerSchema *tfj
 		g.infof("rendering %q", rel)
 		switch relDir {
 		case "data-sources/":
-			resName := shortName + "_" + removeAllExt(relFile)
+			resName := resourceName(shortName, relFile)
 			resSchema, ok := providerSchema.DataSourceSchemas[resName]
 			if ok {
 				tmpl := resourceTemplate(tmplData)
@@ -429,7 +429,7 @@ func (g *generator) renderStaticWebsite(providerName string, providerSchema *tfj
 				return nil
 			}
 		case "resources/":
-			resName := shortName + "_" + removeAllExt(relFile)
+			resName := resourceName(shortName, relFile)
 			resSchema, ok := providerSchema.ResourceSchemas[resName]
 			if ok {
 				tmpl := resourceTemplate(tmplData)

internal/provider/template.go

@@ -8,6 +8,7 @@ import (
 	"text/template"
 
 	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"

internal/provider/util.go

@@ -52,6 +52,18 @@ func removeAllExt(file string) string {
 	}
 }
 
+// resourceName determines whether the shortname and the relFile
+// are identical after file extensions have been stripped from the
+// latter. This allows single word resources (e.g., http) to use
+// templates (e.g., http.md.tmpl).
+func resourceName(shortName, relFile string) string {
+	if shortName == removeAllExt(relFile) {
+		return shortName
+	}
+
+	return shortName + "_" + removeAllExt(relFile)
+}
+
 func writeFile(path string, data string) error {
 	dir, _ := filepath.Split(path)
 	err := os.MkdirAll(dir, 0755)