Unify description text of inputs and outputs (terraform-docs#96)

Author: metmajer

internal/pkg/print/markdown/document/document.go

@@ -60,26 +60,6 @@ func getInputDefaultValue(input *doc.Input, settings settings.Settings) string {
 	return result
 }
 
-func getInputDescription(input *doc.Input) string {
-	var result = "-"
-
-	if input.HasDescription() {
-		result = input.Description
-	}
-
-	return result
-}
-
-func getOutputDescription(output *doc.Output) string {
-	var result = "-"
-
-	if output.HasDescription() {
-		result = output.Description
-	}
-
-	return result
-}
-
 func printComment(buffer *bytes.Buffer, comment string, settings settings.Settings) {
 	buffer.WriteString(fmt.Sprintf("%s\n", comment))
 }
@@ -97,7 +77,7 @@ func printFencedCodeBlock(code string) string {
 func printInput(buffer *bytes.Buffer, input doc.Input, settings settings.Settings) {
 	buffer.WriteString("\n")
 	buffer.WriteString(fmt.Sprintf("### %s\n\n", strings.Replace(input.Name, "_", "\\_", -1)))
-	buffer.WriteString(fmt.Sprintf("Description: %s\n\n", markdown.ConvertMultiLineText(getInputDescription(&input))))
+	buffer.WriteString(fmt.Sprintf("Description: %s\n\n", markdown.ConvertMultiLineText(input.Description)))
 	buffer.WriteString(fmt.Sprintf("Type: `%s`\n", input.Type))
 
 	// Don't print defaults for required inputs when we're already explicit about it being required
@@ -143,6 +123,6 @@ func printOutputs(buffer *bytes.Buffer, outputs []doc.Output, settings settings.
 	for _, output := range outputs {
 		buffer.WriteString("\n")
 		buffer.WriteString(fmt.Sprintf("### %s\n\n", strings.Replace(output.Name, "_", "\\_", -1)))
-		buffer.WriteString(fmt.Sprintf("Description: %s\n", markdown.ConvertMultiLineText(getOutputDescription(&output))))
+		buffer.WriteString(fmt.Sprintf("Description: %s\n", markdown.ConvertMultiLineText(output.Description)))
 	}
 }

internal/pkg/print/markdown/document/testdata/document-WithAggregateTypeDefaults.golden

@@ -21,7 +21,7 @@ The following input variables are supported:
 
 ### unquoted
 
-Description: -
+Description:
 
 Type: `string`
 
@@ -45,7 +45,7 @@ Default: `bar`
 
 ### map-3
 
-Description: -
+Description:
 
 Type: `map`
 
@@ -81,7 +81,7 @@ Default:
 
 ### list-3
 
-Description: -
+Description:
 
 Type: `list`
 

internal/pkg/print/markdown/document/testdata/document-WithRequired.golden

@@ -21,7 +21,7 @@ The following input variables are required:
 
 ### unquoted
 
-Description: -
+Description:
 
 Type: `string`
 
@@ -63,7 +63,7 @@ Default: `bar`
 
 ### map-3
 
-Description: -
+Description:
 
 Type: `map`
 
@@ -79,7 +79,7 @@ Default: `<map>`
 
 ### list-3
 
-Description: -
+Description:
 
 Type: `list`
 

internal/pkg/print/markdown/document/testdata/document-WithSortByName.golden

@@ -45,7 +45,7 @@ Default: -
 
 ### list-3
 
-Description: -
+Description:
 
 Type: `list`
 
@@ -69,7 +69,7 @@ Default: -
 
 ### map-3
 
-Description: -
+Description:
 
 Type: `map`
 
@@ -93,7 +93,7 @@ Default: -
 
 ### unquoted
 
-Description: -
+Description:
 
 Type: `string`
 

internal/pkg/print/markdown/document/testdata/document-WithSortInputsByRequired.golden

@@ -53,7 +53,7 @@ Default: -
 
 ### unquoted
 
-Description: -
+Description:
 
 Type: `string`
 
@@ -69,7 +69,7 @@ Default: `<list>`
 
 ### list-3
 
-Description: -
+Description:
 
 Type: `list`
 
@@ -85,7 +85,7 @@ Default: `<map>`
 
 ### map-3
 
-Description: -
+Description:
 
 Type: `map`
 

internal/pkg/print/markdown/document/testdata/document.golden

@@ -21,7 +21,7 @@ The following input variables are supported:
 
 ### unquoted
 
-Description: -
+Description:
 
 Type: `string`
 
@@ -45,7 +45,7 @@ Default: `bar`
 
 ### map-3
 
-Description: -
+Description:
 
 Type: `map`
 
@@ -69,7 +69,7 @@ Default: `<map>`
 
 ### list-3
 
-Description: -
+Description:
 
 Type: `list`
 

internal/pkg/print/markdown/table/table.go

@@ -56,26 +56,6 @@ func getInputDefaultValue(input *doc.Input, settings settings.Settings) string {
 	return result
 }
 
-func getInputDescription(input *doc.Input) string {
-	var result = "-"
-
-	if input.HasDescription() {
-		result = input.Description
-	}
-
-	return result
-}
-
-func getOutputDescription(output *doc.Output) string {
-	var result = "-"
-
-	if output.HasDescription() {
-		result = output.Description
-	}
-
-	return result
-}
-
 func printComment(buffer *bytes.Buffer, comment string, settings settings.Settings) {
 	buffer.WriteString(fmt.Sprintf("%s\n", comment))
 }
@@ -102,7 +82,7 @@ func printInputs(buffer *bytes.Buffer, inputs []doc.Input, settings settings.Set
 		buffer.WriteString(
 			fmt.Sprintf("| %s | %s | %s | %s |",
 				strings.Replace(input.Name, "_", "\\_", -1),
-				markdown.ConvertMultiLineText(getInputDescription(&input)),
+				markdown.ConvertMultiLineText(input.Description),
 				input.Type,
 				getInputDefaultValue(&input, settings)))
 
@@ -131,6 +111,6 @@ func printOutputs(buffer *bytes.Buffer, outputs []doc.Output, settings settings.
 		buffer.WriteString(
 			fmt.Sprintf("| %s | %s |\n",
 				strings.Replace(output.Name, "_", "\\_", -1),
-				markdown.ConvertMultiLineText(getOutputDescription(&output))))
+				markdown.ConvertMultiLineText(output.Description)))
 	}
 }

internal/pkg/print/markdown/table/testdata/table-WithAggregateTypeDefaults.golden

@@ -19,13 +19,13 @@ module "foo" {
 
 | Name | Description | Type | Default |
 |------|-------------|:----:|:-----:|
-| unquoted | - | string | - |
+| unquoted |  | string | - |
 | string-2 | It's string number two. | string | - |
 | string-1 | It's string number one. | string | `bar` |
-| map-3 | - | map | `{}` |
+| map-3 |  | map | `{}` |
 | map-2 | It's map number two. | map | - |
 | map-1 | It's map number one. | map | `{ "a": 1, "b": 2, "c": 3 }` |
-| list-3 | - | list | `[]` |
+| list-3 |  | list | `[]` |
 | list-2 | It's list number two. | list | - |
 | list-1 | It's list number one. | list | `[ "a", "b", "c" ]` |
 | input\_with\_underscores | A variable with underscores. | string | - |

internal/pkg/print/markdown/table/testdata/table-WithRequired.golden

@@ -19,13 +19,13 @@ module "foo" {
 
 | Name | Description | Type | Default | Required |
 |------|-------------|:----:|:-----:|:-----:|
-| unquoted | - | string | - | yes |
+| unquoted |  | string | - | yes |
 | string-2 | It's string number two. | string | - | yes |
 | string-1 | It's string number one. | string | `bar` | no |
-| map-3 | - | map | `<map>` | no |
+| map-3 |  | map | `<map>` | no |
 | map-2 | It's map number two. | map | - | yes |
 | map-1 | It's map number one. | map | `<map>` | no |
-| list-3 | - | list | `<list>` | no |
+| list-3 |  | list | `<list>` | no |
 | list-2 | It's list number two. | list | - | yes |
 | list-1 | It's list number one. | list | `<list>` | no |
 | input\_with\_underscores | A variable with underscores. | string | - | yes |

internal/pkg/print/markdown/table/testdata/table-WithSortByName.golden

@@ -22,13 +22,13 @@ module "foo" {
 | input\_with\_underscores | A variable with underscores. | string | - |
 | list-1 | It's list number one. | list | `<list>` |
 | list-2 | It's list number two. | list | - |
-| list-3 | - | list | `<list>` |
+| list-3 |  | list | `<list>` |
 | map-1 | It's map number one. | map | `<map>` |
 | map-2 | It's map number two. | map | - |
-| map-3 | - | map | `<map>` |
+| map-3 |  | map | `<map>` |
 | string-1 | It's string number one. | string | `bar` |
 | string-2 | It's string number two. | string | - |
-| unquoted | - | string | - |
+| unquoted |  | string | - |
 
 ## Outputs
 

internal/pkg/print/markdown/table/testdata/table-WithSortInputsByRequired.golden

@@ -23,11 +23,11 @@ module "foo" {
 | list-2 | It's list number two. | list | - |
 | map-2 | It's map number two. | map | - |
 | string-2 | It's string number two. | string | - |
-| unquoted | - | string | - |
+| unquoted |  | string | - |
 | list-1 | It's list number one. | list | `<list>` |
-| list-3 | - | list | `<list>` |
+| list-3 |  | list | `<list>` |
 | map-1 | It's map number one. | map | `<map>` |
-| map-3 | - | map | `<map>` |
+| map-3 |  | map | `<map>` |
 | string-1 | It's string number one. | string | `bar` |
 
 ## Outputs

internal/pkg/print/markdown/table/testdata/table.golden

@@ -19,13 +19,13 @@ module "foo" {
 
 | Name | Description | Type | Default |
 |------|-------------|:----:|:-----:|
-| unquoted | - | string | - |
+| unquoted |  | string | - |
 | string-2 | It's string number two. | string | - |
 | string-1 | It's string number one. | string | `bar` |
-| map-3 | - | map | `<map>` |
+| map-3 |  | map | `<map>` |
 | map-2 | It's map number two. | map | - |
 | map-1 | It's map number one. | map | `<map>` |
-| list-3 | - | list | `<list>` |
+| list-3 |  | list | `<list>` |
 | list-2 | It's list number two. | list | - |
 | list-1 | It's list number one. | list | `<list>` |
 | input\_with\_underscores | A variable with underscores. | string | - |

internal/pkg/print/pretty/pretty.go

@@ -50,26 +50,6 @@ func getInputDefaultValue(input *doc.Input, settings settings.Settings) string {
 	return result
 }
 
-func getInputDescription(input *doc.Input) string {
-	var result = "-"
-
-	if input.HasDescription() {
-		result = input.Description
-	}
-
-	return result
-}
-
-func getOutputDescription(output *doc.Output) string {
-	var result = "-"
-
-	if output.HasDescription() {
-		result = output.Description
-	}
-
-	return result
-}
-
 func printComment(buffer *bytes.Buffer, comment string, settings settings.Settings) {
 	buffer.WriteString(fmt.Sprintf("\n%s\n", comment))
 }
@@ -84,7 +64,7 @@ func printInputs(buffer *bytes.Buffer, inputs []doc.Input, settings settings.Set
 				format,
 				input.Name,
 				getInputDefaultValue(&input, settings),
-				getInputDescription(&input)))
+				input.Description))
 	}
 
 	buffer.WriteString("\n")
@@ -100,7 +80,7 @@ func printOutputs(buffer *bytes.Buffer, outputs []doc.Output, settings settings.
 			fmt.Sprintf(
 				format,
 				output.Name,
-				getOutputDescription(&output)))
+				output.Description))
 	}
 
 	buffer.WriteString("\n")