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

fix: Add newline between code block and trailing lines (#184)

Browse Source
This commit is contained in:
Khosrow Moossavi
2020-01-30 18:09:45 -05:00
committed by GitHub
parent 84ceb57d66
commit bf38a75fe3
50 changed files with 187 additions and 92 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/formats/json.md
View File

@@ -35,7 +35,7 @@ generates the following output:
```json
{
"header": "Usage:\n\nExample of 'foo_bar' module in `foo_bar.tf`.\n\n```hcl\nmodule \"foo_bar\" {\n source = \"github.com/foo/bar\"\n\n id = \"1234567890\"\n name = \"baz\"\n\n zones = [\"us-east-1\", \"us-west-1\"]\n\n tags = {\n Name = \"baz\"\n Created-By = \"first.last@email.com\"\n Date-Created = \"20180101\"\n }\n}\n```",
"header": "Usage:\n\nExample of 'foo_bar' module in `foo_bar.tf`.\n\n```hcl\nmodule \"foo_bar\" {\n source = \"github.com/foo/bar\"\n\n id = \"1234567890\"\n name = \"baz\"\n\n zones = [\"us-east-1\", \"us-west-1\"]\n\n tags = {\n Name = \"baz\"\n Created-By = \"first.last@email.com\"\n Date-Created = \"20180101\"\n }\n}\n```\n\nHere is some trailing text after code block,\nfollowed by another line of text.",
"inputs": [
{
"name": "input-with-code-block",

4
docs/formats/markdown-document.md
View File

@@ -59,6 +59,9 @@ generates the following output:
}
```
Here is some trailing text after code block,
followed by another line of text.
## Providers
The following providers are used by this module:
@@ -113,7 +116,6 @@ generates the following output:
Description: This is a complicated one. We need a newline.
And an example in a code block
```
default = [
"machine rack01:neptune"

11
docs/formats/markdown-table.md
View File

@@ -59,6 +59,9 @@ generates the following output:
}
```
Here is some trailing text after code block,
followed by another line of text.
## Providers
| Name | Version |
@@ -72,14 +75,14 @@ generates the following output:
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:-----:|
| input-with-code-block | This is a complicated one. We need a newline.<br>And an example in a code block<code><pre>default = [<br> "machine rack01:neptune"<br>]<br></pre></code> | `list` | <code><pre>[<br> "name rack:location"<br>]<br></pre></code> | no |
| input-with-code-block | This is a complicated one. We need a newline.<br>And an example in a code block<pre>default = [<br> "machine rack01:neptune"<br>]</pre> | `list` | <pre>[<br> "name rack:location"<br>]</pre> | no |
| input-with-pipe | It includes v1 \| v2 \| v3 | `string` | `"v1"` | no |
| input\_with\_underscores | A variable with underscores. | `any` | n/a | yes |
| list-1 | It's list number one. | `list` | <code><pre>[<br> "a",<br> "b",<br> "c"<br>]<br></pre></code> | no |
| list-1 | It's list number one. | `list` | <pre>[<br> "a",<br> "b",<br> "c"<br>]</pre> | no |
| list-2 | It's list number two. | `list` | n/a | yes |
| list-3 | n/a | `list` | `[]` | no |
| long\_type | This description is itself markdown.<br><br>It spans over multiple lines. | <code><pre>object({<br> name = string,<br> foo = object({ foo = string, bar = string }),<br> bar = object({ foo = string, bar = string }),<br> fizz = list(string),<br> buzz = list(string)<br> })<br></pre></code> | <code><pre>{<br> "bar": {<br> "bar": "bar",<br> "foo": "bar"<br> },<br> "buzz": [<br> "fizz",<br> "buzz"<br> ],<br> "fizz": [],<br> "foo": {<br> "bar": "foo",<br> "foo": "foo"<br> },<br> "name": "hello"<br>}<br></pre></code> | no |
| map-1 | It's map number one. | `map` | <code><pre>{<br> "a": 1,<br> "b": 2,<br> "c": 3<br>}<br></pre></code> | no |
| long\_type | This description is itself markdown.<br><br>It spans over multiple lines. | <pre>object({<br> name = string,<br> foo = object({ foo = string, bar = string }),<br> bar = object({ foo = string, bar = string }),<br> fizz = list(string),<br> buzz = list(string)<br> })</pre> | <pre>{<br> "bar": {<br> "bar": "bar",<br> "foo": "bar"<br> },<br> "buzz": [<br> "fizz",<br> "buzz"<br> ],<br> "fizz": [],<br> "foo": {<br> "bar": "foo",<br> "foo": "foo"<br> },<br> "name": "hello"<br>}</pre> | no |
| map-1 | It's map number one. | `map` | <pre>{<br> "a": 1,<br> "b": 2,<br> "c": 3<br>}</pre> | no |
| map-2 | It's map number two. | `map` | n/a | yes |
| map-3 | n/a | `map` | `{}` | no |
| no-escape-default-value | The description contains `something_with_underscore`. Defaults to 'VALUE\_WITH\_UNDERSCORE'. | `string` | `"VALUE_WITH_UNDERSCORE"` | no |

3
docs/formats/pretty.md
View File

@@ -54,6 +54,9 @@ generates the following output:
}
```
Here is some trailing text after code block,
followed by another line of text.
provider.aws (>= 2.15.0)

3
examples/main.tf
View File

@@ -19,6 +19,9 @@
* }
* }
* ```
*
* Here is some trailing text after code block,
* followed by another line of text.
*/
resource "tls_private_key" "baz" {}

2
internal/pkg/print/json/testdata/json-EscapeCharacters.golden vendored
View File

@@ -1,5 +1,5 @@
{
"header": "Usage:\n\nExample of 'foo_bar' module in `foo_bar.tf`.\n\n```hcl\nmodule \"foo_bar\" {\n source = \"github.com/foo/bar\"\n\n id = \"1234567890\"\n name = \"baz\"\n\n zones = [\"us-east-1\", \"us-west-1\"]\n\n tags = {\n Name = \"baz\"\n Created-By = \"first.last@email.com\"\n Date-Created = \"20180101\"\n }\n}\n```",
"header": "Usage:\n\nExample of 'foo_bar' module in `foo_bar.tf`.\n\n```hcl\nmodule \"foo_bar\" {\n source = \"github.com/foo/bar\"\n\n id = \"1234567890\"\n name = \"baz\"\n\n zones = [\"us-east-1\", \"us-west-1\"]\n\n tags = {\n Name = \"baz\"\n Created-By = \"first.last@email.com\"\n Date-Created = \"20180101\"\n }\n}\n```\n\nHere is some trailing text after code block,\nfollowed by another line of text.",
"inputs": [
{
"name": "unquoted",

2
internal/pkg/print/json/testdata/json-NoInputs.golden vendored
View File

@@ -1,5 +1,5 @@
{
"header": "Usage:\n\nExample of 'foo_bar' module in `foo_bar.tf`.\n\n```hcl\nmodule \"foo_bar\" {\n source = \"github.com/foo/bar\"\n\n id = \"1234567890\"\n name = \"baz\"\n\n zones = [\"us-east-1\", \"us-west-1\"]\n\n tags = {\n Name = \"baz\"\n Created-By = \"first.last@email.com\"\n Date-Created = \"20180101\"\n }\n}\n```",
"header": "Usage:\n\nExample of 'foo_bar' module in `foo_bar.tf`.\n\n```hcl\nmodule \"foo_bar\" {\n source = \"github.com/foo/bar\"\n\n id = \"1234567890\"\n name = \"baz\"\n\n zones = [\"us-east-1\", \"us-west-1\"]\n\n tags = {\n Name = \"baz\"\n Created-By = \"first.last@email.com\"\n Date-Created = \"20180101\"\n }\n}\n```\n\nHere is some trailing text after code block,\nfollowed by another line of text.",
"inputs": [],
"outputs": [
{

2
internal/pkg/print/json/testdata/json-NoOutputs.golden vendored
View File

@@ -1,5 +1,5 @@
{
"header": "Usage:\n\nExample of 'foo_bar' module in `foo_bar.tf`.\n\n```hcl\nmodule \"foo_bar\" {\n source = \"github.com/foo/bar\"\n\n id = \"1234567890\"\n name = \"baz\"\n\n zones = [\"us-east-1\", \"us-west-1\"]\n\n tags = {\n Name = \"baz\"\n Created-By = \"first.last@email.com\"\n Date-Created = \"20180101\"\n }\n}\n```",
"header": "Usage:\n\nExample of 'foo_bar' module in `foo_bar.tf`.\n\n```hcl\nmodule \"foo_bar\" {\n source = \"github.com/foo/bar\"\n\n id = \"1234567890\"\n name = \"baz\"\n\n zones = [\"us-east-1\", \"us-west-1\"]\n\n tags = {\n Name = \"baz\"\n Created-By = \"first.last@email.com\"\n Date-Created = \"20180101\"\n }\n}\n```\n\nHere is some trailing text after code block,\nfollowed by another line of text.",
"inputs": [
{
"name": "unquoted",

2
internal/pkg/print/json/testdata/json-NoProviders.golden vendored
View File

@@ -1,5 +1,5 @@
{
"header": "Usage:\n\nExample of 'foo_bar' module in `foo_bar.tf`.\n\n```hcl\nmodule \"foo_bar\" {\n source = \"github.com/foo/bar\"\n\n id = \"1234567890\"\n name = \"baz\"\n\n zones = [\"us-east-1\", \"us-west-1\"]\n\n tags = {\n Name = \"baz\"\n Created-By = \"first.last@email.com\"\n Date-Created = \"20180101\"\n }\n}\n```",
"header": "Usage:\n\nExample of 'foo_bar' module in `foo_bar.tf`.\n\n```hcl\nmodule \"foo_bar\" {\n source = \"github.com/foo/bar\"\n\n id = \"1234567890\"\n name = \"baz\"\n\n zones = [\"us-east-1\", \"us-west-1\"]\n\n tags = {\n Name = \"baz\"\n Created-By = \"first.last@email.com\"\n Date-Created = \"20180101\"\n }\n}\n```\n\nHere is some trailing text after code block,\nfollowed by another line of text.",
"inputs": [
{
"name": "unquoted",

2
internal/pkg/print/json/testdata/json-OnlyHeader.golden vendored
View File

@@ -1,5 +1,5 @@
{
"header": "Usage:\n\nExample of 'foo_bar' module in `foo_bar.tf`.\n\n```hcl\nmodule \"foo_bar\" {\n source = \"github.com/foo/bar\"\n\n id = \"1234567890\"\n name = \"baz\"\n\n zones = [\"us-east-1\", \"us-west-1\"]\n\n tags = {\n Name = \"baz\"\n Created-By = \"first.last@email.com\"\n Date-Created = \"20180101\"\n }\n}\n```",
"header": "Usage:\n\nExample of 'foo_bar' module in `foo_bar.tf`.\n\n```hcl\nmodule \"foo_bar\" {\n source = \"github.com/foo/bar\"\n\n id = \"1234567890\"\n name = \"baz\"\n\n zones = [\"us-east-1\", \"us-west-1\"]\n\n tags = {\n Name = \"baz\"\n Created-By = \"first.last@email.com\"\n Date-Created = \"20180101\"\n }\n}\n```\n\nHere is some trailing text after code block,\nfollowed by another line of text.",
"inputs": [],
"outputs": [],
"providers": []

2
internal/pkg/print/json/testdata/json-SortByName.golden vendored
View File

@@ -1,5 +1,5 @@
{
"header": "Usage:\n\nExample of 'foo_bar' module in `foo_bar.tf`.\n\n```hcl\nmodule \"foo_bar\" {\n source = \"github.com/foo/bar\"\n\n id = \"1234567890\"\n name = \"baz\"\n\n zones = [\"us-east-1\", \"us-west-1\"]\n\n tags = {\n Name = \"baz\"\n Created-By = \"first.last@email.com\"\n Date-Created = \"20180101\"\n }\n}\n```",
"header": "Usage:\n\nExample of 'foo_bar' module in `foo_bar.tf`.\n\n```hcl\nmodule \"foo_bar\" {\n source = \"github.com/foo/bar\"\n\n id = \"1234567890\"\n name = \"baz\"\n\n zones = [\"us-east-1\", \"us-west-1\"]\n\n tags = {\n Name = \"baz\"\n Created-By = \"first.last@email.com\"\n Date-Created = \"20180101\"\n }\n}\n```\n\nHere is some trailing text after code block,\nfollowed by another line of text.",
"inputs": [
{
"name": "input-with-code-block",

2
internal/pkg/print/json/testdata/json-SortByRequired.golden vendored
View File

@@ -1,5 +1,5 @@
{
"header": "Usage:\n\nExample of 'foo_bar' module in `foo_bar.tf`.\n\n```hcl\nmodule \"foo_bar\" {\n source = \"github.com/foo/bar\"\n\n id = \"1234567890\"\n name = \"baz\"\n\n zones = [\"us-east-1\", \"us-west-1\"]\n\n tags = {\n Name = \"baz\"\n Created-By = \"first.last@email.com\"\n Date-Created = \"20180101\"\n }\n}\n```",
"header": "Usage:\n\nExample of 'foo_bar' module in `foo_bar.tf`.\n\n```hcl\nmodule \"foo_bar\" {\n source = \"github.com/foo/bar\"\n\n id = \"1234567890\"\n name = \"baz\"\n\n zones = [\"us-east-1\", \"us-west-1\"]\n\n tags = {\n Name = \"baz\"\n Created-By = \"first.last@email.com\"\n Date-Created = \"20180101\"\n }\n}\n```\n\nHere is some trailing text after code block,\nfollowed by another line of text.",
"inputs": [
{
"name": "input_with_underscores",

2
internal/pkg/print/json/testdata/json.golden vendored
View File

@@ -1,5 +1,5 @@
{
"header": "Usage:\n\nExample of 'foo_bar' module in `foo_bar.tf`.\n\n```hcl\nmodule \"foo_bar\" {\n source = \"github.com/foo/bar\"\n\n id = \"1234567890\"\n name = \"baz\"\n\n zones = [\"us-east-1\", \"us-west-1\"]\n\n tags = {\n Name = \"baz\"\n Created-By = \"first.last@email.com\"\n Date-Created = \"20180101\"\n }\n}\n```",
"header": "Usage:\n\nExample of 'foo_bar' module in `foo_bar.tf`.\n\n```hcl\nmodule \"foo_bar\" {\n source = \"github.com/foo/bar\"\n\n id = \"1234567890\"\n name = \"baz\"\n\n zones = [\"us-east-1\", \"us-west-1\"]\n\n tags = {\n Name = \"baz\"\n Created-By = \"first.last@email.com\"\n Date-Created = \"20180101\"\n }\n}\n```\n\nHere is some trailing text after code block,\nfollowed by another line of text.",
"inputs": [
{
"name": "unquoted",

4
internal/pkg/print/markdown/document/testdata/document-EscapeCharacters.golden vendored
View File

@@ -19,6 +19,9 @@ module "foo_bar" {
}
```
Here is some trailing text after code block,
followed by another line of text.
## Providers
The following providers are used by this module:
@@ -151,7 +154,6 @@ Default: `"v1"`
Description: This is a complicated one. We need a newline.
And an example in a code block
```
default = [
"machine rack01:neptune"

4
internal/pkg/print/markdown/document/testdata/document-IndentationAboveAllowed.golden vendored
View File

@@ -19,6 +19,9 @@ module "foo_bar" {
}
```
Here is some trailing text after code block,
followed by another line of text.
## Providers
The following providers are used by this module:
@@ -151,7 +154,6 @@ Default: `"v1"`
Description: This is a complicated one. We need a newline.
And an example in a code block
```
default = [
"machine rack01:neptune"

4
internal/pkg/print/markdown/document/testdata/document-IndentationBellowAllowed.golden vendored
View File

@@ -19,6 +19,9 @@ module "foo_bar" {
}
```
Here is some trailing text after code block,
followed by another line of text.
## Providers
The following providers are used by this module:
@@ -151,7 +154,6 @@ Default: `"v1"`
Description: This is a complicated one. We need a newline.
And an example in a code block
```
default = [
"machine rack01:neptune"

4
internal/pkg/print/markdown/document/testdata/document-IndentationOfFour.golden vendored
View File

@@ -19,6 +19,9 @@ module "foo_bar" {
}
```
Here is some trailing text after code block,
followed by another line of text.
#### Providers
The following providers are used by this module:
@@ -151,7 +154,6 @@ Default: `"v1"`
Description: This is a complicated one. We need a newline.
And an example in a code block
```
default = [
"machine rack01:neptune"

1
internal/pkg/print/markdown/document/testdata/document-NoHeader.golden vendored
View File

@@ -130,7 +130,6 @@ Default: `"v1"`
Description: This is a complicated one. We need a newline.
And an example in a code block
```
default = [
"machine rack01:neptune"

3
internal/pkg/print/markdown/document/testdata/document-NoInputs.golden vendored
View File

@@ -19,6 +19,9 @@ module "foo_bar" {
}
```
Here is some trailing text after code block,
followed by another line of text.
## Providers
The following providers are used by this module:

4
internal/pkg/print/markdown/document/testdata/document-NoOutputs.golden vendored
View File

@@ -19,6 +19,9 @@ module "foo_bar" {
}
```
Here is some trailing text after code block,
followed by another line of text.
## Providers
The following providers are used by this module:
@@ -151,7 +154,6 @@ Default: `"v1"`
Description: This is a complicated one. We need a newline.
And an example in a code block
```
default = [
"machine rack01:neptune"

4
internal/pkg/print/markdown/document/testdata/document-NoProviders.golden vendored
View File

@@ -19,6 +19,9 @@ module "foo_bar" {
}
```
Here is some trailing text after code block,
followed by another line of text.
## Inputs
The following input variables are supported:
@@ -139,7 +142,6 @@ Default: `"v1"`
Description: This is a complicated one. We need a newline.
And an example in a code block
```
default = [
"machine rack01:neptune"

3
internal/pkg/print/markdown/document/testdata/document-OnlyHeader.golden vendored
View File

@@ -18,3 +18,6 @@ module "foo_bar" {
}
}
```
Here is some trailing text after code block,
followed by another line of text.

1
internal/pkg/print/markdown/document/testdata/document-OnlyInputs.golden vendored
View File

@@ -118,7 +118,6 @@ Default: `"v1"`
Description: This is a complicated one. We need a newline.
And an example in a code block
```
default = [
"machine rack01:neptune"

4
internal/pkg/print/markdown/document/testdata/document-SortByName.golden vendored
View File

@@ -19,6 +19,9 @@ module "foo_bar" {
}
```
Here is some trailing text after code block,
followed by another line of text.
## Providers
The following providers are used by this module:
@@ -39,7 +42,6 @@ The following input variables are supported:
Description: This is a complicated one. We need a newline.
And an example in a code block
```
default = [
"machine rack01:neptune"

4
internal/pkg/print/markdown/document/testdata/document-SortByRequired.golden vendored
View File

@@ -19,6 +19,9 @@ module "foo_bar" {
}
```
Here is some trailing text after code block,
followed by another line of text.
## Providers
The following providers are used by this module:
@@ -79,7 +82,6 @@ Default: n/a
Description: This is a complicated one. We need a newline.
And an example in a code block
```
default = [
"machine rack01:neptune"

4
internal/pkg/print/markdown/document/testdata/document-WithRequired.golden vendored
View File

@@ -19,6 +19,9 @@ module "foo_bar" {
}
```
Here is some trailing text after code block,
followed by another line of text.
## Providers
The following providers are used by this module:
@@ -145,7 +148,6 @@ Default: `"v1"`
Description: This is a complicated one. We need a newline.
And an example in a code block
```
default = [
"machine rack01:neptune"

4
internal/pkg/print/markdown/document/testdata/document.golden vendored
View File

@@ -19,6 +19,9 @@ module "foo_bar" {
}
```
Here is some trailing text after code block,
followed by another line of text.
## Providers
The following providers are used by this module:
@@ -151,7 +154,6 @@ Default: `"v1"`
Description: This is a complicated one. We need a newline.
And an example in a code block
```
default = [
"machine rack01:neptune"

36
internal/pkg/print/markdown/markdown.go
View File

@@ -52,16 +52,19 @@ func SanitizeItemForDocument(s string, settings *print.Settings) string {
}
result := processSegments(
s,
"\n```",
"```",
func(segment string) string {
segment = ConvertMultiLineText(segment, false)
segment = EscapeIllegalCharacters(segment, settings)
segment = NormalizeURLs(segment, settings)
segment = fmt.Sprintf("%s\n", segment)
return segment
},
func(segment string) string {
segment = fmt.Sprintf("\n```%s\n```", segment)
lastbreak := ""
if !strings.HasSuffix(segment, "\n") {
lastbreak = "\n"
}
segment = fmt.Sprintf("```%s%s```", segment, lastbreak)
return segment
},
)
@@ -76,7 +79,7 @@ func SanitizeItemForTable(s string, settings *print.Settings) string {
}
result := processSegments(
s,
"```\n",
"```",
func(segment string) string {
segment = ConvertMultiLineText(segment, true)
segment = EscapeIllegalCharacters(segment, settings)
@@ -84,7 +87,10 @@ func SanitizeItemForTable(s string, settings *print.Settings) string {
return segment
},
func(segment string) string {
segment = fmt.Sprintf("<pre>%s</pre>", strings.Replace(strings.Replace(segment, "\n", "<br>", -1), "\r", "", -1))
segment = strings.TrimSpace(segment)
segment = strings.Replace(segment, "\n", "<br>", -1)
segment = strings.Replace(segment, "\r", "", -1)
segment = fmt.Sprintf("<pre>%s</pre>", segment)
return segment
},
)
@@ -92,21 +98,15 @@ func SanitizeItemForTable(s string, settings *print.Settings) string {
}
// ConvertMultiLineText converts a multi-line text into a suitable Markdown representation.
func ConvertMultiLineText(s string, convertDoubleSpaces bool) string {
func ConvertMultiLineText(s string, isTable bool) string {
if isTable {
s = strings.TrimSpace(s)
}
// Convert double newlines to <br><br>.
s = strings.Replace(
strings.TrimSpace(s),
"\n\n",
"<br><br>",
-1,
)
s = strings.Replace(s, "\n\n", "<br><br>", -1)
// Convert linebreak followed by another line into space-space-newline
// which is a know convention of Markdown for multiline paragprah.
s = strings.Replace(s, "\n", " \n", -1)
s = strings.Replace(s, " \n", " \n", -1)
if convertDoubleSpaces {
if isTable {
// Convert space-space-newline to <br>
s = strings.Replace(s, " \n", "<br>", -1)

11
internal/pkg/print/markdown/table/testdata/table-EscapeCharacters.golden vendored
View File

@@ -19,6 +19,9 @@ module "foo_bar" {
}
```
Here is some trailing text after code block,
followed by another line of text.
## Providers
| Name | Version |
@@ -38,14 +41,14 @@ module "foo_bar" {
| string-1 | It's string number one. | `string` | `"bar"` |
| map-3 | n/a | `map` | `{}` |
| map-2 | It's map number two. | `map` | n/a |
| map-1 | It's map number one. | `map` | <pre>{<br> "a": 1,<br> "b": 2,<br> "c": 3<br>}<br></pre> |
| map-1 | It's map number one. | `map` | <pre>{<br> "a": 1,<br> "b": 2,<br> "c": 3<br>}</pre> |
| list-3 | n/a | `list` | `[]` |
| list-2 | It's list number two. | `list` | n/a |
| list-1 | It's list number one. | `list` | <pre>[<br> "a",<br> "b",<br> "c"<br>]<br></pre> |
| list-1 | It's list number one. | `list` | <pre>[<br> "a",<br> "b",<br> "c"<br>]</pre> |
| input\_with\_underscores | A variable with underscores. | `any` | n/a |
| input-with-pipe | It includes v1 \| v2 \| v3 | `string` | `"v1"` |
| input-with-code-block | This is a complicated one. We need a newline.<br>And an example in a code block<pre>default = [<br> "machine rack01:neptune"<br>]<br></pre> | `list` | <pre>[<br> "name rack:location"<br>]<br></pre> |
| long\_type | This description is itself markdown.<br><br>It spans over multiple lines. | <pre>object({<br> name = string,<br> foo = object({ foo = string, bar = string }),<br> bar = object({ foo = string, bar = string }),<br> fizz = list(string),<br> buzz = list(string)<br> })<br></pre> | <pre>{<br> "bar": {<br> "bar": "bar",<br> "foo": "bar"<br> },<br> "buzz": [<br> "fizz",<br> "buzz"<br> ],<br> "fizz": [],<br> "foo": {<br> "bar": "foo",<br> "foo": "foo"<br> },<br> "name": "hello"<br>}<br></pre> |
| input-with-code-block | This is a complicated one. We need a newline.<br>And an example in a code block<pre>default = [<br> "machine rack01:neptune"<br>]</pre> | `list` | <pre>[<br> "name rack:location"<br>]</pre> |
| long\_type | This description is itself markdown.<br><br>It spans over multiple lines. | <pre>object({<br> name = string,<br> foo = object({ foo = string, bar = string }),<br> bar = object({ foo = string, bar = string }),<br> fizz = list(string),<br> buzz = list(string)<br> })</pre> | <pre>{<br> "bar": {<br> "bar": "bar",<br> "foo": "bar"<br> },<br> "buzz": [<br> "fizz",<br> "buzz"<br> ],<br> "fizz": [],<br> "foo": {<br> "bar": "foo",<br> "foo": "foo"<br> },<br> "name": "hello"<br>}</pre> |
| no-escape-default-value | The description contains `something_with_underscore`. Defaults to 'VALUE\_WITH\_UNDERSCORE'. | `string` | `"VALUE_WITH_UNDERSCORE"` |
| with-url | The description contains url. https://www.domain.com/foo/bar_baz.html | `string` | `""` |

11
internal/pkg/print/markdown/table/testdata/table-IndentationAboveAllowed.golden vendored
View File

@@ -19,6 +19,9 @@ module "foo_bar" {
}
```
Here is some trailing text after code block,
followed by another line of text.
## Providers
| Name | Version |
@@ -38,14 +41,14 @@ module "foo_bar" {
| string-1 | It's string number one. | `string` | `"bar"` |
| map-3 | n/a | `map` | `{}` |
| map-2 | It's map number two. | `map` | n/a |
| map-1 | It's map number one. | `map` | <pre>{<br> "a": 1,<br> "b": 2,<br> "c": 3<br>}<br></pre> |
| map-1 | It's map number one. | `map` | <pre>{<br> "a": 1,<br> "b": 2,<br> "c": 3<br>}</pre> |
| list-3 | n/a | `list` | `[]` |
| list-2 | It's list number two. | `list` | n/a |
| list-1 | It's list number one. | `list` | <pre>[<br> "a",<br> "b",<br> "c"<br>]<br></pre> |
| list-1 | It's list number one. | `list` | <pre>[<br> "a",<br> "b",<br> "c"<br>]</pre> |
| input_with_underscores | A variable with underscores. | `any` | n/a |
| input-with-pipe | It includes v1 \| v2 \| v3 | `string` | `"v1"` |
| input-with-code-block | This is a complicated one. We need a newline.<br>And an example in a code block<pre>default = [<br> "machine rack01:neptune"<br>]<br></pre> | `list` | <pre>[<br> "name rack:location"<br>]<br></pre> |
| long_type | This description is itself markdown.<br><br>It spans over multiple lines. | <pre>object({<br> name = string,<br> foo = object({ foo = string, bar = string }),<br> bar = object({ foo = string, bar = string }),<br> fizz = list(string),<br> buzz = list(string)<br> })<br></pre> | <pre>{<br> "bar": {<br> "bar": "bar",<br> "foo": "bar"<br> },<br> "buzz": [<br> "fizz",<br> "buzz"<br> ],<br> "fizz": [],<br> "foo": {<br> "bar": "foo",<br> "foo": "foo"<br> },<br> "name": "hello"<br>}<br></pre> |
| input-with-code-block | This is a complicated one. We need a newline.<br>And an example in a code block<pre>default = [<br> "machine rack01:neptune"<br>]</pre> | `list` | <pre>[<br> "name rack:location"<br>]</pre> |
| long_type | This description is itself markdown.<br><br>It spans over multiple lines. | <pre>object({<br> name = string,<br> foo = object({ foo = string, bar = string }),<br> bar = object({ foo = string, bar = string }),<br> fizz = list(string),<br> buzz = list(string)<br> })</pre> | <pre>{<br> "bar": {<br> "bar": "bar",<br> "foo": "bar"<br> },<br> "buzz": [<br> "fizz",<br> "buzz"<br> ],<br> "fizz": [],<br> "foo": {<br> "bar": "foo",<br> "foo": "foo"<br> },<br> "name": "hello"<br>}</pre> |
| no-escape-default-value | The description contains `something_with_underscore`. Defaults to 'VALUE_WITH_UNDERSCORE'. | `string` | `"VALUE_WITH_UNDERSCORE"` |
| with-url | The description contains url. https://www.domain.com/foo/bar_baz.html | `string` | `""` |

11
internal/pkg/print/markdown/table/testdata/table-IndentationBellowAllowed.golden vendored
View File

@@ -19,6 +19,9 @@ module "foo_bar" {
}
```
Here is some trailing text after code block,
followed by another line of text.
## Providers
| Name | Version |
@@ -38,14 +41,14 @@ module "foo_bar" {
| string-1 | It's string number one. | `string` | `"bar"` |
| map-3 | n/a | `map` | `{}` |
| map-2 | It's map number two. | `map` | n/a |
| map-1 | It's map number one. | `map` | <pre>{<br> "a": 1,<br> "b": 2,<br> "c": 3<br>}<br></pre> |
| map-1 | It's map number one. | `map` | <pre>{<br> "a": 1,<br> "b": 2,<br> "c": 3<br>}</pre> |
| list-3 | n/a | `list` | `[]` |
| list-2 | It's list number two. | `list` | n/a |
| list-1 | It's list number one. | `list` | <pre>[<br> "a",<br> "b",<br> "c"<br>]<br></pre> |
| list-1 | It's list number one. | `list` | <pre>[<br> "a",<br> "b",<br> "c"<br>]</pre> |
| input_with_underscores | A variable with underscores. | `any` | n/a |
| input-with-pipe | It includes v1 \| v2 \| v3 | `string` | `"v1"` |
| input-with-code-block | This is a complicated one. We need a newline.<br>And an example in a code block<pre>default = [<br> "machine rack01:neptune"<br>]<br></pre> | `list` | <pre>[<br> "name rack:location"<br>]<br></pre> |
| long_type | This description is itself markdown.<br><br>It spans over multiple lines. | <pre>object({<br> name = string,<br> foo = object({ foo = string, bar = string }),<br> bar = object({ foo = string, bar = string }),<br> fizz = list(string),<br> buzz = list(string)<br> })<br></pre> | <pre>{<br> "bar": {<br> "bar": "bar",<br> "foo": "bar"<br> },<br> "buzz": [<br> "fizz",<br> "buzz"<br> ],<br> "fizz": [],<br> "foo": {<br> "bar": "foo",<br> "foo": "foo"<br> },<br> "name": "hello"<br>}<br></pre> |
| input-with-code-block | This is a complicated one. We need a newline.<br>And an example in a code block<pre>default = [<br> "machine rack01:neptune"<br>]</pre> | `list` | <pre>[<br> "name rack:location"<br>]</pre> |
| long_type | This description is itself markdown.<br><br>It spans over multiple lines. | <pre>object({<br> name = string,<br> foo = object({ foo = string, bar = string }),<br> bar = object({ foo = string, bar = string }),<br> fizz = list(string),<br> buzz = list(string)<br> })</pre> | <pre>{<br> "bar": {<br> "bar": "bar",<br> "foo": "bar"<br> },<br> "buzz": [<br> "fizz",<br> "buzz"<br> ],<br> "fizz": [],<br> "foo": {<br> "bar": "foo",<br> "foo": "foo"<br> },<br> "name": "hello"<br>}</pre> |
| no-escape-default-value | The description contains `something_with_underscore`. Defaults to 'VALUE_WITH_UNDERSCORE'. | `string` | `"VALUE_WITH_UNDERSCORE"` |
| with-url | The description contains url. https://www.domain.com/foo/bar_baz.html | `string` | `""` |

11
internal/pkg/print/markdown/table/testdata/table-IndentationOfFour.golden vendored
View File

@@ -19,6 +19,9 @@ module "foo_bar" {
}
```
Here is some trailing text after code block,
followed by another line of text.
#### Providers
| Name | Version |
@@ -38,14 +41,14 @@ module "foo_bar" {
| string-1 | It's string number one. | `string` | `"bar"` |
| map-3 | n/a | `map` | `{}` |
| map-2 | It's map number two. | `map` | n/a |
| map-1 | It's map number one. | `map` | <pre>{<br> "a": 1,<br> "b": 2,<br> "c": 3<br>}<br></pre> |
| map-1 | It's map number one. | `map` | <pre>{<br> "a": 1,<br> "b": 2,<br> "c": 3<br>}</pre> |
| list-3 | n/a | `list` | `[]` |
| list-2 | It's list number two. | `list` | n/a |
| list-1 | It's list number one. | `list` | <pre>[<br> "a",<br> "b",<br> "c"<br>]<br></pre> |
| list-1 | It's list number one. | `list` | <pre>[<br> "a",<br> "b",<br> "c"<br>]</pre> |
| input_with_underscores | A variable with underscores. | `any` | n/a |
| input-with-pipe | It includes v1 \| v2 \| v3 | `string` | `"v1"` |
| input-with-code-block | This is a complicated one. We need a newline.<br>And an example in a code block<pre>default = [<br> "machine rack01:neptune"<br>]<br></pre> | `list` | <pre>[<br> "name rack:location"<br>]<br></pre> |
| long_type | This description is itself markdown.<br><br>It spans over multiple lines. | <pre>object({<br> name = string,<br> foo = object({ foo = string, bar = string }),<br> bar = object({ foo = string, bar = string }),<br> fizz = list(string),<br> buzz = list(string)<br> })<br></pre> | <pre>{<br> "bar": {<br> "bar": "bar",<br> "foo": "bar"<br> },<br> "buzz": [<br> "fizz",<br> "buzz"<br> ],<br> "fizz": [],<br> "foo": {<br> "bar": "foo",<br> "foo": "foo"<br> },<br> "name": "hello"<br>}<br></pre> |
| input-with-code-block | This is a complicated one. We need a newline.<br>And an example in a code block<pre>default = [<br> "machine rack01:neptune"<br>]</pre> | `list` | <pre>[<br> "name rack:location"<br>]</pre> |
| long_type | This description is itself markdown.<br><br>It spans over multiple lines. | <pre>object({<br> name = string,<br> foo = object({ foo = string, bar = string }),<br> bar = object({ foo = string, bar = string }),<br> fizz = list(string),<br> buzz = list(string)<br> })</pre> | <pre>{<br> "bar": {<br> "bar": "bar",<br> "foo": "bar"<br> },<br> "buzz": [<br> "fizz",<br> "buzz"<br> ],<br> "fizz": [],<br> "foo": {<br> "bar": "foo",<br> "foo": "foo"<br> },<br> "name": "hello"<br>}</pre> |
| no-escape-default-value | The description contains `something_with_underscore`. Defaults to 'VALUE_WITH_UNDERSCORE'. | `string` | `"VALUE_WITH_UNDERSCORE"` |
| with-url | The description contains url. https://www.domain.com/foo/bar_baz.html | `string` | `""` |

8
internal/pkg/print/markdown/table/testdata/table-NoHeader.golden vendored
View File

@@ -17,14 +17,14 @@
| string-1 | It's string number one. | `string` | `"bar"` |
| map-3 | n/a | `map` | `{}` |
| map-2 | It's map number two. | `map` | n/a |
| map-1 | It's map number one. | `map` | <pre>{<br> "a": 1,<br> "b": 2,<br> "c": 3<br>}<br></pre> |
| map-1 | It's map number one. | `map` | <pre>{<br> "a": 1,<br> "b": 2,<br> "c": 3<br>}</pre> |
| list-3 | n/a | `list` | `[]` |
| list-2 | It's list number two. | `list` | n/a |
| list-1 | It's list number one. | `list` | <pre>[<br> "a",<br> "b",<br> "c"<br>]<br></pre> |
| list-1 | It's list number one. | `list` | <pre>[<br> "a",<br> "b",<br> "c"<br>]</pre> |
| input_with_underscores | A variable with underscores. | `any` | n/a |
| input-with-pipe | It includes v1 \| v2 \| v3 | `string` | `"v1"` |
| input-with-code-block | This is a complicated one. We need a newline.<br>And an example in a code block<pre>default = [<br> "machine rack01:neptune"<br>]<br></pre> | `list` | <pre>[<br> "name rack:location"<br>]<br></pre> |
| long_type | This description is itself markdown.<br><br>It spans over multiple lines. | <pre>object({<br> name = string,<br> foo = object({ foo = string, bar = string }),<br> bar = object({ foo = string, bar = string }),<br> fizz = list(string),<br> buzz = list(string)<br> })<br></pre> | <pre>{<br> "bar": {<br> "bar": "bar",<br> "foo": "bar"<br> },<br> "buzz": [<br> "fizz",<br> "buzz"<br> ],<br> "fizz": [],<br> "foo": {<br> "bar": "foo",<br> "foo": "foo"<br> },<br> "name": "hello"<br>}<br></pre> |
| input-with-code-block | This is a complicated one. We need a newline.<br>And an example in a code block<pre>default = [<br> "machine rack01:neptune"<br>]</pre> | `list` | <pre>[<br> "name rack:location"<br>]</pre> |
| long_type | This description is itself markdown.<br><br>It spans over multiple lines. | <pre>object({<br> name = string,<br> foo = object({ foo = string, bar = string }),<br> bar = object({ foo = string, bar = string }),<br> fizz = list(string),<br> buzz = list(string)<br> })</pre> | <pre>{<br> "bar": {<br> "bar": "bar",<br> "foo": "bar"<br> },<br> "buzz": [<br> "fizz",<br> "buzz"<br> ],<br> "fizz": [],<br> "foo": {<br> "bar": "foo",<br> "foo": "foo"<br> },<br> "name": "hello"<br>}</pre> |
| no-escape-default-value | The description contains `something_with_underscore`. Defaults to 'VALUE_WITH_UNDERSCORE'. | `string` | `"VALUE_WITH_UNDERSCORE"` |
| with-url | The description contains url. https://www.domain.com/foo/bar_baz.html | `string` | `""` |

3
internal/pkg/print/markdown/table/testdata/table-NoInputs.golden vendored
View File

@@ -19,6 +19,9 @@ module "foo_bar" {
}
```
Here is some trailing text after code block,
followed by another line of text.
## Providers
| Name | Version |

11
internal/pkg/print/markdown/table/testdata/table-NoOutputs.golden vendored
View File

@@ -19,6 +19,9 @@ module "foo_bar" {
}
```
Here is some trailing text after code block,
followed by another line of text.
## Providers
| Name | Version |
@@ -38,13 +41,13 @@ module "foo_bar" {
| string-1 | It's string number one. | `string` | `"bar"` |
| map-3 | n/a | `map` | `{}` |
| map-2 | It's map number two. | `map` | n/a |
| map-1 | It's map number one. | `map` | <pre>{<br> "a": 1,<br> "b": 2,<br> "c": 3<br>}<br></pre> |
| map-1 | It's map number one. | `map` | <pre>{<br> "a": 1,<br> "b": 2,<br> "c": 3<br>}</pre> |
| list-3 | n/a | `list` | `[]` |
| list-2 | It's list number two. | `list` | n/a |
| list-1 | It's list number one. | `list` | <pre>[<br> "a",<br> "b",<br> "c"<br>]<br></pre> |
| list-1 | It's list number one. | `list` | <pre>[<br> "a",<br> "b",<br> "c"<br>]</pre> |
| input_with_underscores | A variable with underscores. | `any` | n/a |
| input-with-pipe | It includes v1 \| v2 \| v3 | `string` | `"v1"` |
| input-with-code-block | This is a complicated one. We need a newline.<br>And an example in a code block<pre>default = [<br> "machine rack01:neptune"<br>]<br></pre> | `list` | <pre>[<br> "name rack:location"<br>]<br></pre> |
| long_type | This description is itself markdown.<br><br>It spans over multiple lines. | <pre>object({<br> name = string,<br> foo = object({ foo = string, bar = string }),<br> bar = object({ foo = string, bar = string }),<br> fizz = list(string),<br> buzz = list(string)<br> })<br></pre> | <pre>{<br> "bar": {<br> "bar": "bar",<br> "foo": "bar"<br> },<br> "buzz": [<br> "fizz",<br> "buzz"<br> ],<br> "fizz": [],<br> "foo": {<br> "bar": "foo",<br> "foo": "foo"<br> },<br> "name": "hello"<br>}<br></pre> |
| input-with-code-block | This is a complicated one. We need a newline.<br>And an example in a code block<pre>default = [<br> "machine rack01:neptune"<br>]</pre> | `list` | <pre>[<br> "name rack:location"<br>]</pre> |
| long_type | This description is itself markdown.<br><br>It spans over multiple lines. | <pre>object({<br> name = string,<br> foo = object({ foo = string, bar = string }),<br> bar = object({ foo = string, bar = string }),<br> fizz = list(string),<br> buzz = list(string)<br> })</pre> | <pre>{<br> "bar": {<br> "bar": "bar",<br> "foo": "bar"<br> },<br> "buzz": [<br> "fizz",<br> "buzz"<br> ],<br> "fizz": [],<br> "foo": {<br> "bar": "foo",<br> "foo": "foo"<br> },<br> "name": "hello"<br>}</pre> |
| no-escape-default-value | The description contains `something_with_underscore`. Defaults to 'VALUE_WITH_UNDERSCORE'. | `string` | `"VALUE_WITH_UNDERSCORE"` |
| with-url | The description contains url. https://www.domain.com/foo/bar_baz.html | `string` | `""` |

11
internal/pkg/print/markdown/table/testdata/table-NoProviders.golden vendored
View File

@@ -19,6 +19,9 @@ module "foo_bar" {
}
```
Here is some trailing text after code block,
followed by another line of text.
## Inputs
| Name | Description | Type | Default |
@@ -29,14 +32,14 @@ module "foo_bar" {
| string-1 | It's string number one. | `string` | `"bar"` |
| map-3 | n/a | `map` | `{}` |
| map-2 | It's map number two. | `map` | n/a |
| map-1 | It's map number one. | `map` | <pre>{<br> "a": 1,<br> "b": 2,<br> "c": 3<br>}<br></pre> |
| map-1 | It's map number one. | `map` | <pre>{<br> "a": 1,<br> "b": 2,<br> "c": 3<br>}</pre> |
| list-3 | n/a | `list` | `[]` |
| list-2 | It's list number two. | `list` | n/a |
| list-1 | It's list number one. | `list` | <pre>[<br> "a",<br> "b",<br> "c"<br>]<br></pre> |
| list-1 | It's list number one. | `list` | <pre>[<br> "a",<br> "b",<br> "c"<br>]</pre> |
| input_with_underscores | A variable with underscores. | `any` | n/a |
| input-with-pipe | It includes v1 \| v2 \| v3 | `string` | `"v1"` |
| input-with-code-block | This is a complicated one. We need a newline.<br>And an example in a code block<pre>default = [<br> "machine rack01:neptune"<br>]<br></pre> | `list` | <pre>[<br> "name rack:location"<br>]<br></pre> |
| long_type | This description is itself markdown.<br><br>It spans over multiple lines. | <pre>object({<br> name = string,<br> foo = object({ foo = string, bar = string }),<br> bar = object({ foo = string, bar = string }),<br> fizz = list(string),<br> buzz = list(string)<br> })<br></pre> | <pre>{<br> "bar": {<br> "bar": "bar",<br> "foo": "bar"<br> },<br> "buzz": [<br> "fizz",<br> "buzz"<br> ],<br> "fizz": [],<br> "foo": {<br> "bar": "foo",<br> "foo": "foo"<br> },<br> "name": "hello"<br>}<br></pre> |
| input-with-code-block | This is a complicated one. We need a newline.<br>And an example in a code block<pre>default = [<br> "machine rack01:neptune"<br>]</pre> | `list` | <pre>[<br> "name rack:location"<br>]</pre> |
| long_type | This description is itself markdown.<br><br>It spans over multiple lines. | <pre>object({<br> name = string,<br> foo = object({ foo = string, bar = string }),<br> bar = object({ foo = string, bar = string }),<br> fizz = list(string),<br> buzz = list(string)<br> })</pre> | <pre>{<br> "bar": {<br> "bar": "bar",<br> "foo": "bar"<br> },<br> "buzz": [<br> "fizz",<br> "buzz"<br> ],<br> "fizz": [],<br> "foo": {<br> "bar": "foo",<br> "foo": "foo"<br> },<br> "name": "hello"<br>}</pre> |
| no-escape-default-value | The description contains `something_with_underscore`. Defaults to 'VALUE_WITH_UNDERSCORE'. | `string` | `"VALUE_WITH_UNDERSCORE"` |
| with-url | The description contains url. https://www.domain.com/foo/bar_baz.html | `string` | `""` |

3
internal/pkg/print/markdown/table/testdata/table-OnlyHeader.golden vendored
View File

@@ -18,3 +18,6 @@ module "foo_bar" {
}
}
```
Here is some trailing text after code block,
followed by another line of text.

8
internal/pkg/print/markdown/table/testdata/table-OnlyInputs.golden vendored
View File

@@ -8,13 +8,13 @@
| string-1 | It's string number one. | `string` | `"bar"` |
| map-3 | n/a | `map` | `{}` |
| map-2 | It's map number two. | `map` | n/a |
| map-1 | It's map number one. | `map` | <pre>{<br> "a": 1,<br> "b": 2,<br> "c": 3<br>}<br></pre> |
| map-1 | It's map number one. | `map` | <pre>{<br> "a": 1,<br> "b": 2,<br> "c": 3<br>}</pre> |
| list-3 | n/a | `list` | `[]` |
| list-2 | It's list number two. | `list` | n/a |
| list-1 | It's list number one. | `list` | <pre>[<br> "a",<br> "b",<br> "c"<br>]<br></pre> |
| list-1 | It's list number one. | `list` | <pre>[<br> "a",<br> "b",<br> "c"<br>]</pre> |
| input_with_underscores | A variable with underscores. | `any` | n/a |
| input-with-pipe | It includes v1 \| v2 \| v3 | `string` | `"v1"` |
| input-with-code-block | This is a complicated one. We need a newline.<br>And an example in a code block<pre>default = [<br> "machine rack01:neptune"<br>]<br></pre> | `list` | <pre>[<br> "name rack:location"<br>]<br></pre> |
| long_type | This description is itself markdown.<br><br>It spans over multiple lines. | <pre>object({<br> name = string,<br> foo = object({ foo = string, bar = string }),<br> bar = object({ foo = string, bar = string }),<br> fizz = list(string),<br> buzz = list(string)<br> })<br></pre> | <pre>{<br> "bar": {<br> "bar": "bar",<br> "foo": "bar"<br> },<br> "buzz": [<br> "fizz",<br> "buzz"<br> ],<br> "fizz": [],<br> "foo": {<br> "bar": "foo",<br> "foo": "foo"<br> },<br> "name": "hello"<br>}<br></pre> |
| input-with-code-block | This is a complicated one. We need a newline.<br>And an example in a code block<pre>default = [<br> "machine rack01:neptune"<br>]</pre> | `list` | <pre>[<br> "name rack:location"<br>]</pre> |
| long_type | This description is itself markdown.<br><br>It spans over multiple lines. | <pre>object({<br> name = string,<br> foo = object({ foo = string, bar = string }),<br> bar = object({ foo = string, bar = string }),<br> fizz = list(string),<br> buzz = list(string)<br> })</pre> | <pre>{<br> "bar": {<br> "bar": "bar",<br> "foo": "bar"<br> },<br> "buzz": [<br> "fizz",<br> "buzz"<br> ],<br> "fizz": [],<br> "foo": {<br> "bar": "foo",<br> "foo": "foo"<br> },<br> "name": "hello"<br>}</pre> |
| no-escape-default-value | The description contains `something_with_underscore`. Defaults to 'VALUE_WITH_UNDERSCORE'. | `string` | `"VALUE_WITH_UNDERSCORE"` |
| with-url | The description contains url. https://www.domain.com/foo/bar_baz.html | `string` | `""` |

11
internal/pkg/print/markdown/table/testdata/table-SortByName.golden vendored
View File

@@ -19,6 +19,9 @@ module "foo_bar" {
}
```
Here is some trailing text after code block,
followed by another line of text.
## Providers
| Name | Version |
@@ -32,14 +35,14 @@ module "foo_bar" {
| Name | Description | Type | Default |
|------|-------------|------|---------|
| input-with-code-block | This is a complicated one. We need a newline.<br>And an example in a code block<pre>default = [<br> "machine rack01:neptune"<br>]<br></pre> | `list` | <pre>[<br> "name rack:location"<br>]<br></pre> |
| input-with-code-block | This is a complicated one. We need a newline.<br>And an example in a code block<pre>default = [<br> "machine rack01:neptune"<br>]</pre> | `list` | <pre>[<br> "name rack:location"<br>]</pre> |
| input-with-pipe | It includes v1 \| v2 \| v3 | `string` | `"v1"` |
| input_with_underscores | A variable with underscores. | `any` | n/a |
| list-1 | It's list number one. | `list` | <pre>[<br> "a",<br> "b",<br> "c"<br>]<br></pre> |
| list-1 | It's list number one. | `list` | <pre>[<br> "a",<br> "b",<br> "c"<br>]</pre> |
| list-2 | It's list number two. | `list` | n/a |
| list-3 | n/a | `list` | `[]` |
| long_type | This description is itself markdown.<br><br>It spans over multiple lines. | <pre>object({<br> name = string,<br> foo = object({ foo = string, bar = string }),<br> bar = object({ foo = string, bar = string }),<br> fizz = list(string),<br> buzz = list(string)<br> })<br></pre> | <pre>{<br> "bar": {<br> "bar": "bar",<br> "foo": "bar"<br> },<br> "buzz": [<br> "fizz",<br> "buzz"<br> ],<br> "fizz": [],<br> "foo": {<br> "bar": "foo",<br> "foo": "foo"<br> },<br> "name": "hello"<br>}<br></pre> |
| map-1 | It's map number one. | `map` | <pre>{<br> "a": 1,<br> "b": 2,<br> "c": 3<br>}<br></pre> |
| long_type | This description is itself markdown.<br><br>It spans over multiple lines. | <pre>object({<br> name = string,<br> foo = object({ foo = string, bar = string }),<br> bar = object({ foo = string, bar = string }),<br> fizz = list(string),<br> buzz = list(string)<br> })</pre> | <pre>{<br> "bar": {<br> "bar": "bar",<br> "foo": "bar"<br> },<br> "buzz": [<br> "fizz",<br> "buzz"<br> ],<br> "fizz": [],<br> "foo": {<br> "bar": "foo",<br> "foo": "foo"<br> },<br> "name": "hello"<br>}</pre> |
| map-1 | It's map number one. | `map` | <pre>{<br> "a": 1,<br> "b": 2,<br> "c": 3<br>}</pre> |
| map-2 | It's map number two. | `map` | n/a |
| map-3 | n/a | `map` | `{}` |
| no-escape-default-value | The description contains `something_with_underscore`. Defaults to 'VALUE_WITH_UNDERSCORE'. | `string` | `"VALUE_WITH_UNDERSCORE"` |

11
internal/pkg/print/markdown/table/testdata/table-SortByRequired.golden vendored
View File

@@ -19,6 +19,9 @@ module "foo_bar" {
}
```
Here is some trailing text after code block,
followed by another line of text.
## Providers
| Name | Version |
@@ -37,12 +40,12 @@ module "foo_bar" {
| map-2 | It's map number two. | `map` | n/a |
| string-2 | It's string number two. | `string` | n/a |
| unquoted | n/a | `any` | n/a |
| input-with-code-block | This is a complicated one. We need a newline.<br>And an example in a code block<pre>default = [<br> "machine rack01:neptune"<br>]<br></pre> | `list` | <pre>[<br> "name rack:location"<br>]<br></pre> |
| input-with-code-block | This is a complicated one. We need a newline.<br>And an example in a code block<pre>default = [<br> "machine rack01:neptune"<br>]</pre> | `list` | <pre>[<br> "name rack:location"<br>]</pre> |
| input-with-pipe | It includes v1 \| v2 \| v3 | `string` | `"v1"` |
| list-1 | It's list number one. | `list` | <pre>[<br> "a",<br> "b",<br> "c"<br>]<br></pre> |
| list-1 | It's list number one. | `list` | <pre>[<br> "a",<br> "b",<br> "c"<br>]</pre> |
| list-3 | n/a | `list` | `[]` |
| long_type | This description is itself markdown.<br><br>It spans over multiple lines. | <pre>object({<br> name = string,<br> foo = object({ foo = string, bar = string }),<br> bar = object({ foo = string, bar = string }),<br> fizz = list(string),<br> buzz = list(string)<br> })<br></pre> | <pre>{<br> "bar": {<br> "bar": "bar",<br> "foo": "bar"<br> },<br> "buzz": [<br> "fizz",<br> "buzz"<br> ],<br> "fizz": [],<br> "foo": {<br> "bar": "foo",<br> "foo": "foo"<br> },<br> "name": "hello"<br>}<br></pre> |
| map-1 | It's map number one. | `map` | <pre>{<br> "a": 1,<br> "b": 2,<br> "c": 3<br>}<br></pre> |
| long_type | This description is itself markdown.<br><br>It spans over multiple lines. | <pre>object({<br> name = string,<br> foo = object({ foo = string, bar = string }),<br> bar = object({ foo = string, bar = string }),<br> fizz = list(string),<br> buzz = list(string)<br> })</pre> | <pre>{<br> "bar": {<br> "bar": "bar",<br> "foo": "bar"<br> },<br> "buzz": [<br> "fizz",<br> "buzz"<br> ],<br> "fizz": [],<br> "foo": {<br> "bar": "foo",<br> "foo": "foo"<br> },<br> "name": "hello"<br>}</pre> |
| map-1 | It's map number one. | `map` | <pre>{<br> "a": 1,<br> "b": 2,<br> "c": 3<br>}</pre> |
| map-3 | n/a | `map` | `{}` |
| no-escape-default-value | The description contains `something_with_underscore`. Defaults to 'VALUE_WITH_UNDERSCORE'. | `string` | `"VALUE_WITH_UNDERSCORE"` |
| string-1 | It's string number one. | `string` | `"bar"` |

11
internal/pkg/print/markdown/table/testdata/table-WithRequired.golden vendored
View File

@@ -19,6 +19,9 @@ module "foo_bar" {
}
```
Here is some trailing text after code block,
followed by another line of text.
## Providers
| Name | Version |
@@ -38,14 +41,14 @@ module "foo_bar" {
| string-1 | It's string number one. | `string` | `"bar"` | no |
| map-3 | n/a | `map` | `{}` | no |
| map-2 | It's map number two. | `map` | n/a | yes |
| map-1 | It's map number one. | `map` | <pre>{<br> "a": 1,<br> "b": 2,<br> "c": 3<br>}<br></pre> | no |
| map-1 | It's map number one. | `map` | <pre>{<br> "a": 1,<br> "b": 2,<br> "c": 3<br>}</pre> | no |
| list-3 | n/a | `list` | `[]` | no |
| list-2 | It's list number two. | `list` | n/a | yes |
| list-1 | It's list number one. | `list` | <pre>[<br> "a",<br> "b",<br> "c"<br>]<br></pre> | no |
| list-1 | It's list number one. | `list` | <pre>[<br> "a",<br> "b",<br> "c"<br>]</pre> | no |
| input_with_underscores | A variable with underscores. | `any` | n/a | yes |
| input-with-pipe | It includes v1 \| v2 \| v3 | `string` | `"v1"` | no |
| input-with-code-block | This is a complicated one. We need a newline.<br>And an example in a code block<pre>default = [<br> "machine rack01:neptune"<br>]<br></pre> | `list` | <pre>[<br> "name rack:location"<br>]<br></pre> | no |
| long_type | This description is itself markdown.<br><br>It spans over multiple lines. | <pre>object({<br> name = string,<br> foo = object({ foo = string, bar = string }),<br> bar = object({ foo = string, bar = string }),<br> fizz = list(string),<br> buzz = list(string)<br> })<br></pre> | <pre>{<br> "bar": {<br> "bar": "bar",<br> "foo": "bar"<br> },<br> "buzz": [<br> "fizz",<br> "buzz"<br> ],<br> "fizz": [],<br> "foo": {<br> "bar": "foo",<br> "foo": "foo"<br> },<br> "name": "hello"<br>}<br></pre> | no |
| input-with-code-block | This is a complicated one. We need a newline.<br>And an example in a code block<pre>default = [<br> "machine rack01:neptune"<br>]</pre> | `list` | <pre>[<br> "name rack:location"<br>]</pre> | no |
| long_type | This description is itself markdown.<br><br>It spans over multiple lines. | <pre>object({<br> name = string,<br> foo = object({ foo = string, bar = string }),<br> bar = object({ foo = string, bar = string }),<br> fizz = list(string),<br> buzz = list(string)<br> })</pre> | <pre>{<br> "bar": {<br> "bar": "bar",<br> "foo": "bar"<br> },<br> "buzz": [<br> "fizz",<br> "buzz"<br> ],<br> "fizz": [],<br> "foo": {<br> "bar": "foo",<br> "foo": "foo"<br> },<br> "name": "hello"<br>}</pre> | no |
| no-escape-default-value | The description contains `something_with_underscore`. Defaults to 'VALUE_WITH_UNDERSCORE'. | `string` | `"VALUE_WITH_UNDERSCORE"` | no |
| with-url | The description contains url. https://www.domain.com/foo/bar_baz.html | `string` | `""` | no |

11
internal/pkg/print/markdown/table/testdata/table.golden vendored
View File

@@ -19,6 +19,9 @@ module "foo_bar" {
}
```
Here is some trailing text after code block,
followed by another line of text.
## Providers
| Name | Version |
@@ -38,14 +41,14 @@ module "foo_bar" {
| string-1 | It's string number one. | `string` | `"bar"` |
| map-3 | n/a | `map` | `{}` |
| map-2 | It's map number two. | `map` | n/a |
| map-1 | It's map number one. | `map` | <pre>{<br> "a": 1,<br> "b": 2,<br> "c": 3<br>}<br></pre> |
| map-1 | It's map number one. | `map` | <pre>{<br> "a": 1,<br> "b": 2,<br> "c": 3<br>}</pre> |
| list-3 | n/a | `list` | `[]` |
| list-2 | It's list number two. | `list` | n/a |
| list-1 | It's list number one. | `list` | <pre>[<br> "a",<br> "b",<br> "c"<br>]<br></pre> |
| list-1 | It's list number one. | `list` | <pre>[<br> "a",<br> "b",<br> "c"<br>]</pre> |
| input_with_underscores | A variable with underscores. | `any` | n/a |
| input-with-pipe | It includes v1 \| v2 \| v3 | `string` | `"v1"` |
| input-with-code-block | This is a complicated one. We need a newline.<br>And an example in a code block<pre>default = [<br> "machine rack01:neptune"<br>]<br></pre> | `list` | <pre>[<br> "name rack:location"<br>]<br></pre> |
| long_type | This description is itself markdown.<br><br>It spans over multiple lines. | <pre>object({<br> name = string,<br> foo = object({ foo = string, bar = string }),<br> bar = object({ foo = string, bar = string }),<br> fizz = list(string),<br> buzz = list(string)<br> })<br></pre> | <pre>{<br> "bar": {<br> "bar": "bar",<br> "foo": "bar"<br> },<br> "buzz": [<br> "fizz",<br> "buzz"<br> ],<br> "fizz": [],<br> "foo": {<br> "bar": "foo",<br> "foo": "foo"<br> },<br> "name": "hello"<br>}<br></pre> |
| input-with-code-block | This is a complicated one. We need a newline.<br>And an example in a code block<pre>default = [<br> "machine rack01:neptune"<br>]</pre> | `list` | <pre>[<br> "name rack:location"<br>]</pre> |
| long_type | This description is itself markdown.<br><br>It spans over multiple lines. | <pre>object({<br> name = string,<br> foo = object({ foo = string, bar = string }),<br> bar = object({ foo = string, bar = string }),<br> fizz = list(string),<br> buzz = list(string)<br> })</pre> | <pre>{<br> "bar": {<br> "bar": "bar",<br> "foo": "bar"<br> },<br> "buzz": [<br> "fizz",<br> "buzz"<br> ],<br> "fizz": [],<br> "foo": {<br> "bar": "foo",<br> "foo": "foo"<br> },<br> "name": "hello"<br>}</pre> |
| no-escape-default-value | The description contains `something_with_underscore`. Defaults to 'VALUE_WITH_UNDERSCORE'. | `string` | `"VALUE_WITH_UNDERSCORE"` |
| with-url | The description contains url. https://www.domain.com/foo/bar_baz.html | `string` | `""` |

3
internal/pkg/print/pretty/testdata/pretty-NoColor.golden vendored
View File

@@ -21,6 +21,9 @@ module "foo_bar" {
}
```
Here is some trailing text after code block,
followed by another line of text.
provider.tls

3
internal/pkg/print/pretty/testdata/pretty-NoInputs.golden vendored
View File

@@ -20,6 +20,9 @@
 }
}
```

Here is some trailing text after code block,
followed by another line of text.

3
internal/pkg/print/pretty/testdata/pretty-NoOutputs.golden vendored
View File

@@ -20,6 +20,9 @@
 }
}
```

Here is some trailing text after code block,
followed by another line of text.

3
internal/pkg/print/pretty/testdata/pretty-NoProviders.golden vendored
View File

@@ -20,6 +20,9 @@
 }
}
```

Here is some trailing text after code block,
followed by another line of text.

3
internal/pkg/print/pretty/testdata/pretty-OnlyHeader.golden vendored
View File

@@ -20,4 +20,7 @@
 }
}
```

Here is some trailing text after code block,
followed by another line of text.

3
internal/pkg/print/pretty/testdata/pretty-SortByName.golden vendored
View File

@@ -20,6 +20,9 @@
 }
}
```

Here is some trailing text after code block,
followed by another line of text.

3
internal/pkg/print/pretty/testdata/pretty-SortByRequired.golden vendored
View File

@@ -20,6 +20,9 @@
 }
}
```

Here is some trailing text after code block,
followed by another line of text.

3
internal/pkg/print/pretty/testdata/pretty.golden vendored
View File

@@ -20,6 +20,9 @@
 }
}
```

Here is some trailing text after code block,
followed by another line of text.