Merge branch 'main' into SBGoods/rendered-provider-name

Author: SBGoods

.changes/unreleased/BUG FIXES-20250613-152846.yaml

@@ -0,0 +1,5 @@
+kind: BUG FIXES
+body: 'generate: Remove `subcategory` field from default provider templates'
+time: 2025-06-13T15:28:46.039473-04:00
+custom:
+    Issue: "446"

.changes/unreleased/ENHANCEMENTS-20250613-162958.yaml

@@ -0,0 +1,5 @@
+kind: ENHANCEMENTS
+body: 'generate: Remove trailing whitespace from default function template when `.HasVariadic` evaluates to false'
+time: 2025-06-13T16:29:58.411584-04:00
+custom:
+    Issue: "489"

cmd/tfplugindocs/testdata/scripts/provider-build/generate/framework_provider_success_no_templates.txtar

@@ -68,7 +68,6 @@ data "scaffolding_example" "example" {
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "scaffolding Provider"
-subcategory: ""
 description: |-
   Example provider
 ---

cmd/tfplugindocs/testdata/scripts/schema-json/generate/framework_provider_success_all_framework_types.txtar

@@ -32,7 +32,6 @@ rendering "resources/example.md.tmpl"
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "scaffolding Provider"
-subcategory: ""
 description: |-
   Example provider
 ---

cmd/tfplugindocs/testdata/scripts/schema-json/generate/framework_provider_success_no_templates.txtar

@@ -9,6 +9,7 @@ cmp docs/index.md expected-index.md
 cmp docs/data-sources/example.md expected-datasource.md
 cmp docs/resources/example.md expected-resource.md
 cmp docs/functions/example.md expected-function.md
+cmp docs/functions/no-variadic.md expected-no-variadic-function.md
 cmp docs/ephemeral-resources/example.md expected-ephemeral-resource.md
 
 -- expected-output.txt --
@@ -22,6 +23,7 @@ generating missing data source content
 generating new template for data-source "scaffolding_example"
 generating missing function content
 generating new template for function "example"
+generating new template for function "no-variadic"
 generating missing ephemeral resource content
 generating new template for "scaffolding_example"
 generating missing provider content
@@ -32,6 +34,7 @@ rendering templated website to static markdown
 rendering "data-sources/example.md.tmpl"
 rendering "ephemeral-resources/example.md.tmpl"
 rendering "functions/example.md.tmpl"
+rendering "functions/no-variadic.md.tmpl"
 rendering "index.md.tmpl"
 rendering "resources/example.md.tmpl"
 -- expected-datasource.md --
@@ -99,11 +102,42 @@ example(input string, variadicInput string...) string
 1. `input` (String) Value to echo.
 <!-- variadic argument generated by tfplugindocs -->
 1. `variadicInput` (Variadic, String) Variadic input to echo.
+-- expected-no-variadic-function.md --
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "no-variadic function - terraform-provider-scaffolding"
+subcategory: ""
+description: |-
+  Echo a string
+---
+
+# function: no-variadic
+
+Given a string value, returns the same value.
+
+## Example Usage
+
+```terraform
+output "test" {
+  value = provider::scaffolding::no-variadic("testvalue1")
+}
+```
+
+## Signature
+
+<!-- signature generated by tfplugindocs -->
+```text
+no-variadic(input string) string
+```
+
+## Arguments
+
+<!-- arguments generated by tfplugindocs -->
+1. `input` (String) Value to echo.
 -- expected-index.md --
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "Scaffolding Provider"
-subcategory: ""
 description: |-
   Example provider
 ---
@@ -208,6 +242,10 @@ data "scaffolding_example" "example" {
 output "test" {
   value = provider::scaffolding::example("testvalue1", "testvalue2")
 }
+-- examples/functions/no-variadic/function.tf --
+output "test" {
+  value = provider::scaffolding::no-variadic("testvalue1")
+}
 -- examples/provider/provider.tf --
 provider "scaffolding" {
   # example configuration here
@@ -341,6 +379,18 @@ resource "scaffolding_example" "example" {
                         "description": "Variadic input to echo.",
                         "type": "string"
                     }
+                },
+                 "no-variadic": {
+                    "description": "Given a string value, returns the same value.",
+                    "summary": "Echo a string",
+                    "return_type": "string",
+                    "parameters": [
+                        {
+                            "name": "input",
+                            "description": "Value to echo.",
+                            "type": "string"
+                        }
+                    ]
                 }
             }
         }

cmd/tfplugindocs/testdata/scripts/schema-json/generate/nested_id_attribute.txtar

@@ -29,7 +29,6 @@ rendering "resources/example.md.tmpl"
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "scaffolding Provider"
-subcategory: ""
 description: |-
   Example provider
 ---

go.mod

@@ -13,7 +13,7 @@ require (
 	github.com/hashicorp/terraform-json v0.25.0
 	github.com/mattn/go-colorable v0.1.14
 	github.com/rogpeppe/go-internal v1.14.1
-	github.com/yuin/goldmark v1.7.7
+	github.com/yuin/goldmark v1.7.12
 	github.com/yuin/goldmark-meta v1.1.0
 	github.com/zclconf/go-cty v1.16.3
 	go.abhg.dev/goldmark/frontmatter v0.2.0

go.sum

@@ -128,8 +128,8 @@ github.com/stretchr/testify v1.8.2/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o
 github.com/xanzy/ssh-agent v0.3.3 h1:+/15pJfg/RsTxqYcX6fHqOXZwwMP+2VyYWJeWM2qQFM=
 github.com/xanzy/ssh-agent v0.3.3/go.mod h1:6dzNDKs0J9rVPHPhaGCukekBHKqfl+L3KghI1Bc68Uw=
 github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
-github.com/yuin/goldmark v1.7.7 h1:5m9rrB1sW3JUMToKFQfb+FGt1U7r57IHu5GrYrG2nqU=
-github.com/yuin/goldmark v1.7.7/go.mod h1:uzxRWxtg69N339t3louHJ7+O03ezfj6PlliRlaOzY1E=
+github.com/yuin/goldmark v1.7.12 h1:YwGP/rrea2/CnCtUHgjuolG/PnMxdQtPMO5PvaE2/nY=
+github.com/yuin/goldmark v1.7.12/go.mod h1:ip/1k0VRfGynBgxOz0yCqHrbZXhcjxyuS66Brc7iBKg=
 github.com/yuin/goldmark-meta v1.1.0 h1:pWw+JLHGZe8Rk0EGsMVssiNb/AaPMHfSRszZeUeiOUc=
 github.com/yuin/goldmark-meta v1.1.0/go.mod h1:U4spWENafuA7Zyg+Lj5RqK/MF+ovMYtBvXi1lBb2VP0=
 github.com/zclconf/go-cty v1.16.3 h1:osr++gw2T61A8KVYHoQiFbFd1Lh3JOCXc/jFLJXKTxk=

internal/mdplain/renderer.go

@@ -26,59 +26,51 @@ func (r *TextRender) Render(w io.Writer, source []byte, n ast.Node) error {
 		}
 
 		switch node := node.(type) {
-		case *ast.Blockquote, *ast.Heading:
+		case *ast.Blockquote, *ast.CodeSpan:
+			return ast.WalkContinue, nil
+		case *ast.Heading, *ast.CodeBlock, *ast.List:
 			doubleSpace(out)
-			out.Write(node.Text(source))
-			return ast.WalkSkipChildren, nil
+			return ast.WalkContinue, nil
 		case *ast.ThematicBreak:
 			doubleSpace(out)
 			return ast.WalkSkipChildren, nil
-		case *ast.CodeBlock:
-			doubleSpace(out)
-			for i := 0; i < node.Lines().Len(); i++ {
-				line := node.Lines().At(i)
-				out.Write(line.Value(source))
-			}
-			return ast.WalkSkipChildren, nil
 		case *ast.FencedCodeBlock:
 			doubleSpace(out)
 			doubleSpace(out)
-			for i := 0; i < node.Lines().Len(); i++ {
-				line := node.Lines().At(i)
-				_, _ = out.Write(line.Value(source))
-			}
-			return ast.WalkSkipChildren, nil
-		case *ast.List:
-			doubleSpace(out)
+			out.Write(node.Lines().Value(source))
 			return ast.WalkContinue, nil
 		case *ast.Paragraph:
 			doubleSpace(out)
-			if node.Text(source)[0] == '|' { // Write tables as-is.
-				for i := 0; i < node.Lines().Len(); i++ {
-					line := node.Lines().At(i)
-					out.Write(line.Value(source))
-				}
+			if node.Lines().Value(source)[0] == '|' { // Write tables as-is.
+				out.Write(node.Lines().Value(source))
 				return ast.WalkSkipChildren, nil
 			}
 			return ast.WalkContinue, nil
 		case *extAST.Strikethrough:
-			out.Write(node.Text(source))
+			out.Write(node.Lines().Value(source))
 			return ast.WalkContinue, nil
 		case *ast.AutoLink:
 			out.Write(node.URL(source))
 			return ast.WalkSkipChildren, nil
-		case *ast.CodeSpan:
-			out.Write(node.Text(source))
-			return ast.WalkSkipChildren, nil
 		case *ast.Link:
-			_, err := out.Write(node.Text(source))
+			// we want to write the text of the
+			// link before the url
+			child := node.FirstChild()
+			if child != nil {
+				t, ok := child.(*ast.Text)
+				if ok {
+					out.Write(t.Value(source))
+				}
+			}
+
 			if !isRelativeLink(node.Destination) {
 				out.WriteString(" ")
 				out.Write(node.Destination)
 			}
-			return ast.WalkSkipChildren, err
+
+			return ast.WalkSkipChildren, nil
 		case *ast.Text:
-			out.Write(node.Text(source))
+			out.Write(node.Value(source))
 			if node.SoftLineBreak() {
 				doubleSpace(out)
 			}

internal/provider/migrate.go

@@ -296,7 +296,7 @@ func (m *migrator) ExtractCodeExamples(content []byte, newRelDir string, templat
 		if fencedNode, isFenced := node.(*ast.FencedCodeBlock); isFenced && fencedNode.Info != nil {
 			var ext, exampleName, examplePath, template string
 
-			lang := string(fencedNode.Info.Text(content)[:])
+			lang := string(fencedNode.Info.Value(content)[:])
 			switch lang {
 			case "hcl", "terraform":
 				exampleCount++