'terraform-docs#643 - change asciidoc, markdown and pretty template f…

…ormats to show the source of the requirements' Signed-off-by: Edgar R. Sandi <[email protected]>
edgarsandi · Jul 20, 2023 · a63b7b7 · a63b7b7
1 parent 90b9bb9
commit a63b7b7
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 9 deletions.
diff --git a/format/templates/asciidoc_document_requirements.tmpl b/format/templates/asciidoc_document_requirements.tmpl
@@ -10,8 +10,9 @@
 
  The following requirements are needed by this module:
  {{- range .Module.Requirements }}
+ {{ $source := ternary (tostring .Source) (printf " - %s" .Source) "" }}
  {{ $version := ternary (tostring .Version) (printf " (%s)" .Version) "" }}
- - {{ anchorNameAsciidoc "requirement" .Name }}{{ $version }}
+ - {{ anchorNameAsciidoc "requirement" .Name }}{{ $source }}{{ $version }}
  {{- end }}
  {{ end }}
 {{ end -}}
diff --git a/format/templates/asciidoc_table_requirements.tmpl b/format/templates/asciidoc_table_requirements.tmpl
@@ -8,11 +8,11 @@
  {{ else }}
  {{- indent 0 "=" }} Requirements
 
- [cols="a,a",options="header,autowidth"]
+ [cols="a,a,a",options="header,autowidth"]
  |===
- |Name |Version
+ |Name |Source |Version
  {{- range .Module.Requirements }}
- |{{ anchorNameAsciidoc "requirement" .Name }} |{{ tostring .Version | default "n/a" }}
+ |{{ anchorNameAsciidoc "requirement" .Name }} |{{ tostring .Source | default "" }} |{{ tostring .Version | default "n/a" }}
  {{- end }}
  |===
  {{ end }}

diff --git a/format/templates/markdown_document_requirements.tmpl b/format/templates/markdown_document_requirements.tmpl
@@ -10,8 +10,9 @@
 
  The following requirements are needed by this module:
  {{- range .Module.Requirements }}
+ {{ $source := ternary (tostring .Source) (printf " - %s" .Source) "" }}
  {{ $version := ternary (tostring .Version) (printf " (%s)" .Version) "" }}
- - {{ anchorNameMarkdown "requirement" .Name }}{{ $version }}
+ - {{ anchorNameMarkdown "requirement" .Name }}{{ $source }}{{ $version }}
  {{- end }}
  {{ end }}
 {{ end -}}
diff --git a/format/templates/markdown_table_requirements.tmpl b/format/templates/markdown_table_requirements.tmpl
@@ -8,10 +8,10 @@
  {{ else }}
  {{- indent 0 "#" }} Requirements
 
- | Name | Version |
- |------|---------|
+ | Name | Source | Version |
+ |------|--------|---------|
  {{- range .Module.Requirements }}
- | {{ anchorNameMarkdown "requirement" .Name }} | {{ tostring .Version | default "n/a" }} |
+ | {{ anchorNameMarkdown "requirement" .Name }} | {{ tostring .Source | default "" }} | {{ tostring .Version | default "n/a" }} |
  {{- end }}
  {{ end }}
 {{ end -}}
diff --git a/format/templates/pretty.tmpl b/format/templates/pretty.tmpl
@@ -8,8 +8,9 @@
 {{- if .Config.Sections.Requirements -}}
  {{- with .Module.Requirements }}
  {{- range . }}
+ {{- $source := ternary (tostring .Source) (printf " - %s" .Source) "" }}
  {{- $version := ternary (tostring .Version) (printf " (%s)" .Version) "" }}
- {{- printf "requirement.%s" .Name | colorize "\033[36m" }}{{ $version }}
+ {{- printf "requirement.%s" .Name | colorize "\033[36m" }}{{ $source }}{{ $version }}
  {{ end -}}
  {{ end -}}
  {{- printf "\n\n" -}}