Skip to content

Commit 61cc005

Browse files
khos2owkhos2ow
committed
Render resources without URL correctly in Markdown and Asciidoc
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
1 parent 8577ee6 commit 61cc005

File tree

74 files changed

+361
-21
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

74 files changed

+361
-21
lines changed

‎docs/reference/asciidoc-document.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,8 @@ generates the following output:
101101

102102
- [[requirement_aws]] <<requirement_aws,aws>> (>= 2.15.0)
103103

104+
- [[requirement_foo]] <<requirement_foo,foo>> (>= 1.0)
105+
104106
- [[requirement_random]] <<requirement_random,random>> (>= 2.2.0)
105107

106108
== Providers
@@ -111,6 +113,8 @@ generates the following output:
111113

112114
- [[provider_aws.ident]] <<provider_aws.ident,aws.ident>> (>= 2.15.0)
113115

116+
- [[provider_foo]] <<provider_foo,foo>> (>= 1.0)
117+
114118
- [[provider_null]] <<provider_null,null>>
115119

116120
- [[provider_tls]] <<provider_tls,tls>>
@@ -147,6 +151,7 @@ generates the following output:
147151

148152
The following resources are used by this module:
149153

154+
- foo_resource.baz (resource)
150155
- https://registry.terraform.io/providers/hashicorp/null/latest/docs/resources/resource[null_resource.foo] (resource)
151156
- https://registry.terraform.io/providers/hashicorp/tls/latest/docs/resources/private_key[tls_private_key.baz] (resource)
152157
- https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity[aws_caller_identity.current] (data source)

‎docs/reference/asciidoc-table.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,7 @@ generates the following output:
100100
|Name |Version
101101
|[[requirement_terraform]] <<requirement_terraform,terraform>> |>= 0.12
102102
|[[requirement_aws]] <<requirement_aws,aws>> |>= 2.15.0
103+
|[[requirement_foo]] <<requirement_foo,foo>> |>= 1.0
103104
|[[requirement_random]] <<requirement_random,random>> |>= 2.2.0
104105
|===
105106

@@ -110,6 +111,7 @@ generates the following output:
110111
|Name |Version
111112
|[[provider_aws]] <<provider_aws,aws>> |>= 2.15.0
112113
|[[provider_aws.ident]] <<provider_aws.ident,aws.ident>> |>= 2.15.0
114+
|[[provider_foo]] <<provider_foo,foo>> |>= 1.0
113115
|[[provider_null]] <<provider_null,null>> |n/a
114116
|[[provider_tls]] <<provider_tls,tls>> |n/a
115117
|===
@@ -130,6 +132,7 @@ generates the following output:
130132
[cols="a,a",options="header,autowidth"]
131133
|===
132134
|Name |Type
135+
|foo_resource.baz |resource
133136
|https://registry.terraform.io/providers/hashicorp/null/latest/docs/resources/resource[null_resource.foo] |resource
134137
|https://registry.terraform.io/providers/hashicorp/tls/latest/docs/resources/private_key[tls_private_key.baz] |resource
135138
|https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity[aws_caller_identity.current] |data source

‎docs/reference/json.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -348,6 +348,11 @@ generates the following output:
348348
"alias": "ident",
349349
"version": "\u003e= 2.15.0"
350350
},
351+
{
352+
"name": "foo",
353+
"alias": null,
354+
"version": "\u003e= 1.0"
355+
},
351356
{
352357
"name": "null",
353358
"alias": null,
@@ -368,12 +373,24 @@ generates the following output:
368373
"name": "aws",
369374
"version": "\u003e= 2.15.0"
370375
},
376+
{
377+
"name": "foo",
378+
"version": "\u003e= 1.0"
379+
},
371380
{
372381
"name": "random",
373382
"version": "\u003e= 2.2.0"
374383
}
375384
],
376385
"resources": [
386+
{
387+
"type": "resource",
388+
"name": "baz",
389+
"provider": "foo",
390+
"source": "https://registry.acme.com/foo",
391+
"mode": "managed",
392+
"version": "latest"
393+
},
377394
{
378395
"type": "resource",
379396
"name": "foo",

‎docs/reference/markdown-document.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,8 @@ generates the following output:
103103

104104
- <a name="requirement_aws"></a> [aws](#requirement\_aws) (>= 2.15.0)
105105

106+
- <a name="requirement_foo"></a> [foo](#requirement\_foo) (>= 1.0)
107+
106108
- <a name="requirement_random"></a> [random](#requirement\_random) (>= 2.2.0)
107109

108110
## Providers
@@ -113,6 +115,8 @@ generates the following output:
113115

114116
- <a name="provider_aws.ident"></a> [aws.ident](#provider\_aws.ident) (>= 2.15.0)
115117

118+
- <a name="provider_foo"></a> [foo](#provider\_foo) (>= 1.0)
119+
116120
- <a name="provider_null"></a> [null](#provider\_null)
117121

118122
- <a name="provider_tls"></a> [tls](#provider\_tls)
@@ -149,6 +153,7 @@ generates the following output:
149153

150154
The following resources are used by this module:
151155

156+
- foo_resource.baz (resource)
152157
- [null_resource.foo](https://registry.terraform.io/providers/hashicorp/null/latest/docs/resources/resource) (resource)
153158
- [tls_private_key.baz](https://registry.terraform.io/providers/hashicorp/tls/latest/docs/resources/private_key) (resource)
154159
- [aws_caller_identity.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) (data source)

‎docs/reference/markdown-table.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,7 @@ generates the following output:
101101
|------|---------|
102102
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.12 |
103103
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 2.15.0 |
104+
| <a name="requirement_foo"></a> [foo](#requirement\_foo) | >= 1.0 |
104105
| <a name="requirement_random"></a> [random](#requirement\_random) | >= 2.2.0 |
105106

106107
## Providers
@@ -109,6 +110,7 @@ generates the following output:
109110
|------|---------|
110111
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 2.15.0 |
111112
| <a name="provider_aws.ident"></a> [aws.ident](#provider\_aws.ident) | >= 2.15.0 |
113+
| <a name="provider_foo"></a> [foo](#provider\_foo) | >= 1.0 |
112114
| <a name="provider_null"></a> [null](#provider\_null) | n/a |
113115
| <a name="provider_tls"></a> [tls](#provider\_tls) | n/a |
114116

@@ -125,6 +127,7 @@ generates the following output:
125127

126128
| Name | Type |
127129
|------|------|
130+
| foo_resource.baz | resource |
128131
| [null_resource.foo](https://registry.terraform.io/providers/hashicorp/null/latest/docs/resources/resource) | resource |
129132
| [tls_private_key.baz](https://registry.terraform.io/providers/hashicorp/tls/latest/docs/resources/private_key) | resource |
130133
| [aws_caller_identity.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) | data source |

‎docs/reference/pretty.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,11 +91,13 @@ generates the following output:
9191

9292
requirement.terraform (>= 0.12)
9393
requirement.aws (>= 2.15.0)
94+
requirement.foo (>= 1.0)
9495
requirement.random (>= 2.2.0)
9596

9697

9798
provider.aws (>= 2.15.0)
9899
provider.aws.ident (>= 2.15.0)
100+
provider.foo (>= 1.0)
99101
provider.null
100102
provider.tls
101103

@@ -106,6 +108,7 @@ generates the following output:
106108
module.foobar (git@github.com:module/path,v7.8.9)
107109

108110

111+
resource.foo_resource.baz (resource)
109112
resource.null_resource.foo (resource) (https://registry.terraform.io/providers/hashicorp/null/latest/docs/resources/resource)
110113
resource.tls_private_key.baz (resource) (https://registry.terraform.io/providers/hashicorp/tls/latest/docs/resources/private_key)
111114
data.aws_caller_identity.current (data source) (https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity)

‎docs/reference/toml.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -327,6 +327,11 @@ generates the following output:
327327
alias = "ident"
328328
version = ">= 2.15.0"
329329

330+
[[providers]]
331+
name = "foo"
332+
alias = ""
333+
version = ">= 1.0"
334+
330335
[[providers]]
331336
name = "null"
332337
alias = ""
@@ -345,10 +350,22 @@ generates the following output:
345350
name = "aws"
346351
version = ">= 2.15.0"
347352

353+
[[requirements]]
354+
name = "foo"
355+
version = ">= 1.0"
356+
348357
[[requirements]]
349358
name = "random"
350359
version = ">= 2.2.0"
351360

361+
[[resources]]
362+
type = "resource"
363+
name = "baz"
364+
provider = "foo"
365+
source = "https://registry.acme.com/foo"
366+
mode = "managed"
367+
version = "latest"
368+
352369
[[resources]]
353370
type = "resource"
354371
name = "foo"

‎docs/reference/xml.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -347,6 +347,11 @@ generates the following output:
347347
<alias>ident</alias>
348348
<version>&gt;= 2.15.0</version>
349349
</provider>
350+
<provider>
351+
<name>foo</name>
352+
<alias xsi:nil="true"></alias>
353+
<version>&gt;= 1.0</version>
354+
</provider>
350355
<provider>
351356
<name>null</name>
352357
<alias xsi:nil="true"></alias>
@@ -367,12 +372,24 @@ generates the following output:
367372
<name>aws</name>
368373
<version>&gt;= 2.15.0</version>
369374
</requirement>
375+
<requirement>
376+
<name>foo</name>
377+
<version>&gt;= 1.0</version>
378+
</requirement>
370379
<requirement>
371380
<name>random</name>
372381
<version>&gt;= 2.2.0</version>
373382
</requirement>
374383
</requirements>
375384
<resources>
385+
<resource>
386+
<type>resource</type>
387+
<name>baz</name>
388+
<provider>foo</provider>
389+
<source>https://registry.acme.com/foo</source>
390+
<mode>managed</mode>
391+
<version>latest</version>
392+
</resource>
376393
<resource>
377394
<type>resource</type>
378395
<name>foo</name>

‎docs/reference/yaml.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -304,6 +304,9 @@ generates the following output:
304304
- name: aws
305305
alias: ident
306306
version: '>= 2.15.0'
307+
- name: foo
308+
alias: null
309+
version: '>= 1.0'
307310
- name: "null"
308311
alias: null
309312
version: null
@@ -315,9 +318,17 @@ generates the following output:
315318
version: '>= 0.12'
316319
- name: aws
317320
version: '>= 2.15.0'
321+
- name: foo
322+
version: '>= 1.0'
318323
- name: random
319324
version: '>= 2.2.0'
320325
resources:
326+
- type: resource
327+
name: baz
328+
provider: foo
329+
source: https://registry.acme.com/foo
330+
mode: managed
331+
version: latest
321332
- type: resource
322333
name: foo
323334
provider: "null"

‎examples/main.tf

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,15 @@ terraform {
4343
required_providers {
4444
random = ">= 2.2.0"
4545
aws = ">= 2.15.0"
46+
foo = {
47+
source = "https://registry.acme.com/foo"
48+
version = ">= 1.0"
49+
}
4650
}
4751
}
4852

4953
resource "tls_private_key" "baz" {}
54+
resource "foo_resource" "baz" {}
5055

5156
data "aws_caller_identity" "current" {
5257
provider = "aws"
@@ -74,5 +79,5 @@ module "baz" {
7479
}
7580

7681
module "foobar" {
77-
source = "git@github.com:module/path?ref=v7.8.9"
82+
source = "git@github.com:module/path?ref=v7.8.9"
7883
}

0 commit comments

Comments
 (0)