Separate the module version from module source when using ?ref=

edgarsandi · edgarsandi · commit 0284283bd199 · 2021-05-18T20:51:50.000-03:00
Signed-off-by: Edgar R. Sandi &lt;edgar.r.sandi@gmail.com&gt;
diff --git a/docs/reference/asciidoc-document.md b/docs/reference/asciidoc-document.md
@@ -137,6 +137,12 @@ generates the following output:
 
     Version: 1.2.3
 
+    === [[module_foobar]] <<module_foobar,foobar>>
+
+    Source: git@github.com:module/path
+
+    Version: v7.8.9
+
     == Resources
 
     The following resources are used by this module:
diff --git a/docs/reference/asciidoc-table.md b/docs/reference/asciidoc-table.md
@@ -122,6 +122,7 @@ generates the following output:
     |[[module_bar]] <<module_bar,bar>>|baz|4.5.6
     |[[module_baz]] <<module_baz,baz>>|baz|4.5.6
     |[[module_foo]] <<module_foo,foo>>|bar|1.2.3
+    |[[module_foobar]] <<module_foobar,foobar>>|git@github.com:module/path|v7.8.9
     |===
 
     == Resources
diff --git a/docs/reference/json.md b/docs/reference/json.md
@@ -312,6 +312,11 @@ generates the following output:
           "name": "foo",
           "source": "bar",
           "version": "1.2.3"
+        },
+        {
+          "name": "foobar",
+          "source": "git@github.com:module/path",
+          "version": "v7.8.9"
         }
       ],
       "outputs": [
diff --git a/docs/reference/markdown-document.md b/docs/reference/markdown-document.md
@@ -138,6 +138,12 @@ generates the following output:
 
     Version: 1.2.3
 
+    ### <a name="module_foobar"></a> [foobar](#module\_foobar)
+
+    Source: git@github.com:module/path
+
+    Version: v7.8.9
+
     ## Resources
 
     The following resources are used by this module:
diff --git a/docs/reference/markdown-table.md b/docs/reference/markdown-table.md
@@ -118,6 +118,7 @@ generates the following output:
     | <a name="module_bar"></a> [bar](#module\_bar) | baz | 4.5.6 |
     | <a name="module_baz"></a> [baz](#module\_baz) | baz | 4.5.6 |
     | <a name="module_foo"></a> [foo](#module\_foo) | bar | 1.2.3 |
+    | <a name="module_foobar"></a> [foobar](#module\_foobar) | git@github.com:module/path | v7.8.9 |
 
     ## Resources
 
diff --git a/docs/reference/pretty.md b/docs/reference/pretty.md
@@ -103,6 +103,7 @@ generates the following output:
     module.bar (baz,4.5.6)
     module.baz (baz,4.5.6)
     module.foo (bar,1.2.3)
+    module.foobar (git@github.com:module/path,v7.8.9)
 
 
     resource.null_resource.foo (resource) (https://registry.terraform.io/providers/hashicorp/null/latest/docs/resources/resource)
diff --git a/docs/reference/toml.md b/docs/reference/toml.md
@@ -296,6 +296,11 @@ generates the following output:
       source = "bar"
       version = "1.2.3"
 
+    [[modules]]
+      name = "foobar"
+      source = "git@github.com:module/path"
+      version = "v7.8.9"
+
     [[outputs]]
       name = "output-0.12"
       description = "terraform 0.12 only"
diff --git a/docs/reference/xml.md b/docs/reference/xml.md
@@ -312,6 +312,11 @@ generates the following output:
           <source>bar</source>
           <version>1.2.3</version>
         </module>
+        <module>
+          <name>foobar</name>
+          <source>git@github.com:module/path</source>
+          <version>v7.8.9</version>
+        </module>
       </modules>
       <outputs>
         <output>
diff --git a/docs/reference/yaml.md b/docs/reference/yaml.md
@@ -285,6 +285,9 @@ generates the following output:
       - name: foo
         source: bar
         version: 1.2.3
+      - name: foobar
+        source: git@github.com:module/path
+        version: v7.8.9
     outputs:
       - name: output-0.12
         description: terraform 0.12 only
diff --git a/examples/main.tf b/examples/main.tf
@@ -72,3 +72,7 @@ module "baz" {
   source  = "baz"
   version = "4.5.6"
 }
+
+module "foobar" {
+  source  = "git@github.com:module/path?ref=v7.8.9"
+}
diff --git a/internal/format/templates/markdown_table.tmpl b/internal/format/templates/markdown_table.tmpl
@@ -5,4 +5,4 @@
 {{- template "resources" . -}}
 {{- template "inputs" . -}}
 {{- template "outputs" . -}}
-{{- template "footer" . -}}
+{{- template "footer" . -}}
diff --git a/internal/format/templates/markdown_table_modules.tmpl b/internal/format/templates/markdown_table_modules.tmpl
@@ -6,7 +6,7 @@
         | Name | Source | Version |
         |------|--------|---------|
         {{- range .Module.ModuleCalls }}
-            | {{ anchorName "module" .Name }} | {{ .Source }} | {{ .Version }} |
+            | {{ anchorName "module" .Name }} | {{ .Source }} | {{ .Version | default "n/a" }} |
         {{- end }}
     {{ end }}
 {{ end -}}
diff --git a/internal/format/testdata/asciidoc/document-Base.golden b/internal/format/testdata/asciidoc/document-Base.golden
@@ -80,6 +80,12 @@ Source: baz
 
 Version: 4.5.6
 
+=== foobar
+
+Source: git@github.com:module/path
+
+Version: v7.8.9
+
 == Resources
 
 The following resources are used by this module:
diff --git a/internal/format/testdata/asciidoc/document-IndentationOfFour.golden b/internal/format/testdata/asciidoc/document-IndentationOfFour.golden
@@ -80,6 +80,12 @@ Source: baz
 
 Version: 4.5.6
 
+===== foobar
+
+Source: git@github.com:module/path
+
+Version: v7.8.9
+
 ==== Resources
 
 The following resources are used by this module:
diff --git a/internal/format/testdata/asciidoc/document-OnlyModulecalls.golden b/internal/format/testdata/asciidoc/document-OnlyModulecalls.golden
@@ -18,4 +18,10 @@ Version: 1.2.3
 
 Source: baz
 
-Version: 4.5.6
+Version: 4.5.6
+
+=== foobar
+
+Source: git@github.com:module/path
+
+Version: v7.8.9
diff --git a/internal/format/testdata/asciidoc/document-WithAnchor.golden b/internal/format/testdata/asciidoc/document-WithAnchor.golden
@@ -80,6 +80,12 @@ Source: baz
 
 Version: 4.5.6
 
+=== [[module_foobar]] <<module_foobar,foobar>>
+
+Source: git@github.com:module/path
+
+Version: v7.8.9
+
 == Resources
 
 The following resources are used by this module:
diff --git a/internal/format/testdata/asciidoc/document-WithRequired.golden b/internal/format/testdata/asciidoc/document-WithRequired.golden
@@ -80,6 +80,12 @@ Source: baz
 
 Version: 4.5.6
 
+=== foobar
+
+Source: git@github.com:module/path
+
+Version: v7.8.9
+
 == Resources
 
 The following resources are used by this module:
diff --git a/internal/format/testdata/asciidoc/table-Base.golden b/internal/format/testdata/asciidoc/table-Base.golden
@@ -65,6 +65,7 @@ followed by another line of text.
 |bar|baz|4.5.6
 |foo|bar|1.2.3
 |baz|baz|4.5.6
+|foobar|git@github.com:module/path|v7.8.9
 |===
 
 == Resources
diff --git a/internal/format/testdata/asciidoc/table-IndentationOfFour.golden b/internal/format/testdata/asciidoc/table-IndentationOfFour.golden
@@ -65,6 +65,7 @@ followed by another line of text.
 |bar|baz|4.5.6
 |foo|bar|1.2.3
 |baz|baz|4.5.6
+|foobar|git@github.com:module/path|v7.8.9
 |===
 
 ==== Resources
diff --git a/internal/format/testdata/asciidoc/table-OnlyModulecalls.golden b/internal/format/testdata/asciidoc/table-OnlyModulecalls.golden
@@ -6,4 +6,5 @@
 |bar|baz|4.5.6
 |foo|bar|1.2.3
 |baz|baz|4.5.6
+|foobar|git@github.com:module/path|v7.8.9
 |===
diff --git a/internal/format/testdata/asciidoc/table-WithAnchor.golden b/internal/format/testdata/asciidoc/table-WithAnchor.golden
@@ -65,6 +65,7 @@ followed by another line of text.
 |[[module_bar]] <<module_bar,bar>>|baz|4.5.6
 |[[module_foo]] <<module_foo,foo>>|bar|1.2.3
 |[[module_baz]] <<module_baz,baz>>|baz|4.5.6
+|[[module_foobar]] <<module_foobar,foobar>>|git@github.com:module/path|v7.8.9
 |===
 
 == Resources
diff --git a/internal/format/testdata/asciidoc/table-WithRequired.golden b/internal/format/testdata/asciidoc/table-WithRequired.golden
@@ -65,6 +65,7 @@ followed by another line of text.
 |bar|baz|4.5.6
 |foo|bar|1.2.3
 |baz|baz|4.5.6
+|foobar|git@github.com:module/path|v7.8.9
 |===
 
 == Resources
diff --git a/internal/format/testdata/common/sort-NoSort.golden b/internal/format/testdata/common/sort-NoSort.golden
@@ -35,7 +35,8 @@
   "modules": [
     "bar-baz",
     "foo-bar",
-    "baz-baz"
+    "baz-baz",
+    "foobar-git@github.com:module/path"
   ],
   "outputs": [
     "unquoted",
diff --git a/internal/format/testdata/common/sort-SortByName.golden b/internal/format/testdata/common/sort-SortByName.golden
@@ -35,7 +35,8 @@
   "modules": [
     "bar-baz",
     "baz-baz",
-    "foo-bar"
+    "foo-bar",
+    "foobar-git@github.com:module/path"
   ],
   "outputs": [
     "output-0.12",
diff --git a/internal/format/testdata/common/sort-SortByRequired.golden b/internal/format/testdata/common/sort-SortByRequired.golden
@@ -35,7 +35,8 @@
   "modules": [
     "bar-baz",
     "baz-baz",
-    "foo-bar"
+    "foo-bar",
+    "foobar-git@github.com:module/path"
   ],
   "outputs": [
     "output-0.12",
diff --git a/internal/format/testdata/common/sort-SortByType.golden b/internal/format/testdata/common/sort-SortByType.golden
@@ -35,7 +35,8 @@
   "modules": [
     "foo-bar",
     "bar-baz",
-    "baz-baz"
+    "baz-baz",
+    "foobar-git@github.com:module/path"
   ],
   "outputs": [
     "output-0.12",
diff --git a/internal/format/testdata/json/json-Base.golden b/internal/format/testdata/json/json-Base.golden
@@ -260,6 +260,11 @@
       "name": "baz",
       "source": "baz",
       "version": "4.5.6"
+    },
+    {
+      "name": "foobar",
+      "source": "git@github.com:module/path",
+      "version": "v7.8.9"
     }
   ],
   "outputs": [
diff --git a/internal/format/testdata/json/json-EscapeCharacters.golden b/internal/format/testdata/json/json-EscapeCharacters.golden
@@ -260,6 +260,11 @@
       "name": "baz",
       "source": "baz",
       "version": "4.5.6"
+    },
+    {
+      "name": "foobar",
+      "source": "git@github.com:module/path",
+      "version": "v7.8.9"
     }
   ],
   "outputs": [
diff --git a/internal/format/testdata/json/json-OnlyModulecalls.golden b/internal/format/testdata/json/json-OnlyModulecalls.golden
@@ -17,6 +17,11 @@
       "name": "baz",
       "source": "baz",
       "version": "4.5.6"
+    },
+    {
+      "name": "foobar",
+      "source": "git@github.com:module/path",
+      "version": "v7.8.9"
     }
   ],
   "outputs": [],
diff --git a/internal/format/testdata/markdown/document-Base.golden b/internal/format/testdata/markdown/document-Base.golden
@@ -80,6 +80,12 @@ Source: baz
 
 Version: 4.5.6
 
+### foobar
+
+Source: git@github.com:module/path
+
+Version: v7.8.9
+
 ## Resources
 
 The following resources are used by this module:
diff --git a/internal/format/testdata/markdown/document-EscapeCharacters.golden b/internal/format/testdata/markdown/document-EscapeCharacters.golden
@@ -80,6 +80,12 @@ Source: baz
 
 Version: 4.5.6
 
+### foobar
+
+Source: git@github.com:module/path
+
+Version: v7.8.9
+
 ## Resources
 
 The following resources are used by this module:
diff --git a/internal/format/testdata/markdown/document-IndentationOfFour.golden b/internal/format/testdata/markdown/document-IndentationOfFour.golden
@@ -80,6 +80,12 @@ Source: baz
 
 Version: 4.5.6
 
+##### foobar
+
+Source: git@github.com:module/path
+
+Version: v7.8.9
+
 #### Resources
 
 The following resources are used by this module:
diff --git a/internal/format/testdata/markdown/document-OnlyModulecalls.golden b/internal/format/testdata/markdown/document-OnlyModulecalls.golden
@@ -18,4 +18,10 @@ Version: 1.2.3
 
 Source: baz
 
-Version: 4.5.6
+Version: 4.5.6
+
+### foobar
+
+Source: git@github.com:module/path
+
+Version: v7.8.9
diff --git a/internal/format/testdata/markdown/document-WithAnchor.golden b/internal/format/testdata/markdown/document-WithAnchor.golden
@@ -80,6 +80,12 @@ Source: baz
 
 Version: 4.5.6
 
+### <a name="module_foobar"></a> [foobar](#module_foobar)
+
+Source: git@github.com:module/path
+
+Version: v7.8.9
+
 ## Resources
 
 The following resources are used by this module:
diff --git a/internal/format/testdata/markdown/document-WithRequired.golden b/internal/format/testdata/markdown/document-WithRequired.golden
@@ -80,6 +80,12 @@ Source: baz
 
 Version: 4.5.6
 
+### foobar
+
+Source: git@github.com:module/path
+
+Version: v7.8.9
+
 ## Resources
 
 The following resources are used by this module:
diff --git a/internal/format/testdata/markdown/table-Base.golden b/internal/format/testdata/markdown/table-Base.golden
@@ -60,6 +60,7 @@ followed by another line of text.
 | bar | baz | 4.5.6 |
 | foo | bar | 1.2.3 |
 | baz | baz | 4.5.6 |
+| foobar | git@github.com:module/path | v7.8.9 |
 
 ## Resources
 
diff --git a/internal/format/testdata/markdown/table-EscapeCharacters.golden b/internal/format/testdata/markdown/table-EscapeCharacters.golden
@@ -60,6 +60,7 @@ followed by another line of text.
 | bar | baz | 4.5.6 |
 | foo | bar | 1.2.3 |
 | baz | baz | 4.5.6 |
+| foobar | git@github.com:module/path | v7.8.9 |
 
 ## Resources
 
diff --git a/internal/format/testdata/markdown/table-IndentationOfFour.golden b/internal/format/testdata/markdown/table-IndentationOfFour.golden
diff --git a/internal/format/testdata/markdown/table-OnlyModulecalls.golden b/internal/format/testdata/markdown/table-OnlyModulecalls.golden
diff --git a/internal/format/testdata/markdown/table-WithAnchor.golden b/internal/format/testdata/markdown/table-WithAnchor.golden
diff --git a/internal/format/testdata/markdown/table-WithRequired.golden b/internal/format/testdata/markdown/table-WithRequired.golden
diff --git a/internal/format/testdata/pretty/pretty-Base.golden b/internal/format/testdata/pretty/pretty-Base.golden
diff --git a/internal/format/testdata/pretty/pretty-OnlyModulecalls.golden b/internal/format/testdata/pretty/pretty-OnlyModulecalls.golden
diff --git a/internal/format/testdata/pretty/pretty-WithColor.golden b/internal/format/testdata/pretty/pretty-WithColor.golden
diff --git a/internal/format/testdata/toml/toml-Base.golden b/internal/format/testdata/toml/toml-Base.golden
diff --git a/internal/format/testdata/toml/toml-OnlyModulecalls.golden b/internal/format/testdata/toml/toml-OnlyModulecalls.golden
diff --git a/internal/format/testdata/xml/xml-Base.golden b/internal/format/testdata/xml/xml-Base.golden
diff --git a/internal/format/testdata/xml/xml-OnlyModulecalls.golden b/internal/format/testdata/xml/xml-OnlyModulecalls.golden
diff --git a/internal/format/testdata/yaml/yaml-Base.golden b/internal/format/testdata/yaml/yaml-Base.golden
diff --git a/internal/format/testdata/yaml/yaml-OnlyModulecalls.golden b/internal/format/testdata/yaml/yaml-OnlyModulecalls.golden
diff --git a/internal/terraform/module.go b/internal/terraform/module.go
diff --git a/internal/terraform/module_test.go b/internal/terraform/module_test.go
diff --git a/internal/terraform/testdata/full-example/main.tf b/internal/terraform/testdata/full-example/main.tf

Original file line number	Diff line number	Diff line change
`@@ -72,3 +72,7 @@ module "baz" {`
`72`	`72`	`source = "baz"`
`73`	`73`	`version = "4.5.6"`
`74`	`74`	`}`
	`75`	`+`
	`76`	`+module "foobar" {`
	`77`	`+ source = "git@github.com:module/path?ref=v7.8.9"`
	`78`	`+}`