feat: check for line templates, update README.md

Author: Artus-LHIND

README.md

@@ -85,16 +85,30 @@ The templates generated by the tool are shown below, and can be included in your
 | Name | Description |
 |------|-------------|
 | chart.header              | The main heading of the generated markdown file |
+| chart.deprecationWarning  | A deprecation warning which is displayed when the _deprecated_ field from the chart's `Chart.yaml` file is `true` |
 | chart.description         | A description line containing the _description_ field from the chart's `Chart.yaml` file, or "" if that field is not set |
 | chart.version             | The _version_ field from the chart's `Chart.yaml` file |
 | chart.versionLine         | A text line stating the current version of the chart |
+| chart.versionBadge        | A badge stating the current version of the chart |
 | chart.type                | The _type_ field from the chart's `Chart.yaml` file |
 | chart.typeLine            | A text line stating the current type of the chart |
-| chart.sourceLink          | The _home_ link from the chart's `Chart.yaml` file, or "" if that field is not set |
-| chart.sourceLinkLine      | A text line with the _home_ link from the chart's `Chart.yaml` file, or "" if that field is not set |
+| chart.typeBadge           | A badge stating the current type of the chart |
+| chart.appVersion          | The _appVersion_ field from the chart's `Chart.yaml` file |
+| chart.appVersionLine      | A text line stating the current appVersion of the chart |
+| chart.appVersionBadge     | A badge stating the current appVersion of the chart |
+| chart.homepage            | The _home_ link from the chart's `Chart.yaml` file, or "" if that field is not set |
+| chart.homepageLine        | A text line stating the current homepage of the chart |
+| chart.maintainersHeader   | The heading for the chart maintainers section |
+| chart.maintainersTable    | A table of the chart's maintainers |
+| chart.maintainersSection  | A section headed by the maintainersHeader from above containing the maintainersTable from above or "" if there are no maintainers |
+| chart.sourcesHeader       | The heading for the chart sources section |
+| chart.sourcesList         | A list of the chart's sources |
+| chart.sourcesSection      | A section headed by the sourcesHeader from above containing the sourcesList from above or "" if there are no sources |
+| chart.kubeVersion         | The _kubeVersion_ field from the chart's `Chart.yaml` file |
+| chart.kubeVersionLine     | A text line stating the required Kubernetes version for the chart |~~~~
 | chart.requirementsHeader  | The heading for the chart requirements section |
 | chart.requirementsTable   | A table of the chart's required sub-charts |
-| chart.requirementsSection | A section headed by the requirementsHeader from above containing the requirementsTable from above or "" if there are no requirements |
+| chart.requirementsSection | A section headed by the requirementsHeader from above containing the kubeVersionLine and/or the requirementsTable from above or "" if there are no requirements |
 | chart.valuesHeader        | The heading for the chart values section |
 | chart.valuesTable         | A table of the chart's values parsed from the `values.yaml` file (see below) |
 | chart.valuesSection       | A section headed by the valuesHeader from above containing the valuesTable from above or "" if there are no values |

pkg/document/template.go

@@ -22,7 +22,7 @@ const defaultDocumentationTemplate = `{{ template "chart.header" . }}
 
 {{ template "chart.description" . }}
 
-{{ template "chart.homepage" . }}
+{{ template "chart.homepageLine" . }}
 
 {{ template "chart.maintainersSection" . }}
 
@@ -55,7 +55,7 @@ func getVersionTemplates() string {
 	versionBuilder := strings.Builder{}
 	versionBuilder.WriteString(`{{ define "chart.version" }}{{ .Version }}{{ end }}\n`)
 	versionBuilder.WriteString(`{{ define "chart.versionLine" }}`)
-	versionBuilder.WriteString("Current chart version is `{{ .Version }}`")
+	versionBuilder.WriteString("{{ if .Version }}Current chart version is `{{ .Version }}`{{ end }}")
 	versionBuilder.WriteString("{{ end }}")
 	versionBuilder.WriteString(`{{ define "chart.versionBadge" }}`)
 	versionBuilder.WriteString("![Version: {{ .Version }}](https://img.shields.io/badge/Version-{{ .Version }}-informational?style=flat-square)")
@@ -68,7 +68,7 @@ func getTypeTemplate() string {
 	typeBuilder := strings.Builder{}
 	typeBuilder.WriteString(`{{ define "chart.type" }}{{ .Type }}{{ end }}\n`)
 	typeBuilder.WriteString(`{{ define "chart.typeLine" }}`)
-	typeBuilder.WriteString("Current chart type is `{{ .Type }}`")
+	typeBuilder.WriteString("{{ if .Type }}Current chart type is `{{ .Type }}`{{ end }}")
 	typeBuilder.WriteString("{{ end }}")
 	typeBuilder.WriteString(`{{ define "chart.typeBadge" }}`)
 	typeBuilder.WriteString("{{ if .Type }}![Type: {{ .Type }}](https://img.shields.io/badge/Type-{{ .Type }}-informational?style=flat-square){{ end }}")
@@ -79,6 +79,10 @@ func getTypeTemplate() string {
 
 func getAppVersionTemplate() string {
 	appVersionBuilder := strings.Builder{}
+	appVersionBuilder.WriteString(`{{ define "chart.appVersion" }}{{ .AppVersion }}{{ end }}\n`)
+	appVersionBuilder.WriteString(`{{ define "chart.appVersionLine" }}`)
+	appVersionBuilder.WriteString("{{ if .AppVersion }}Current chart appVersion is `{{ .AppVersion }}`{{ end }}")
+	appVersionBuilder.WriteString("{{ end }}")
 	appVersionBuilder.WriteString(`{{ define "chart.appVersionBadge" }}`)
 	appVersionBuilder.WriteString("{{ if .AppVersion }}![AppVersion: {{ .AppVersion }}](https://img.shields.io/badge/AppVersion-{{ .AppVersion }}-informational?style=flat-square){{ end }}")
 	appVersionBuilder.WriteString("{{ end }}")
@@ -97,7 +101,8 @@ func getDescriptionTemplate() string {
 
 func getHomepageTemplate() string {
 	homepageBuilder := strings.Builder{}
-	homepageBuilder.WriteString(`{{ define "chart.homepage" }}`)
+	homepageBuilder.WriteString(`{{ define "chart.homepage" }}{{ .Home }}{{ end }}\n`)
+	homepageBuilder.WriteString(`{{ define "chart.homepageLine" }}`)
 	homepageBuilder.WriteString("{{ if .Home }}**Homepage:** <{{ .Home }}>{{ end }}")
 	homepageBuilder.WriteString("{{ end }}")
 
@@ -129,17 +134,9 @@ func getMaintainersTemplate() string {
 
 func getSourceLinkTemplates() string {
 	sourceLinkBuilder := strings.Builder{}
-	sourceLinkBuilder.WriteString(`{{ define "chart.sourceLink" }}`)
-	sourceLinkBuilder.WriteString("{{ .Home }}")
-	sourceLinkBuilder.WriteString("{{ end }}\n")
-
-	sourceLinkBuilder.WriteString(`{{ define "chart.sourceLinkLine" }}`)
-	sourceLinkBuilder.WriteString("{{ if .Home }}Source code can be found [here]({{ .Home }}){{ end }}")
-	sourceLinkBuilder.WriteString("{{ end }}")
-
 	sourceLinkBuilder.WriteString(`{{ define "chart.sourcesHeader" }}## Source Code{{ end}}`)
 
-	sourceLinkBuilder.WriteString(`{{ define "chart.sources" }}`)
+	sourceLinkBuilder.WriteString(`{{ define "chart.sourcesList" }}`)
 	sourceLinkBuilder.WriteString("{{- range .Sources }}")
 	sourceLinkBuilder.WriteString("\n* <{{ . }}>")
 	sourceLinkBuilder.WriteString("{{- end }}")
@@ -149,7 +146,7 @@ func getSourceLinkTemplates() string {
 	sourceLinkBuilder.WriteString("{{ if .Sources }}")
 	sourceLinkBuilder.WriteString(`{{ template "chart.sourcesHeader" . }}`)
 	sourceLinkBuilder.WriteString("\n")
-	sourceLinkBuilder.WriteString(`{{ template "chart.sources" . }}`)
+	sourceLinkBuilder.WriteString(`{{ template "chart.sourcesList" . }}`)
 	sourceLinkBuilder.WriteString("{{ end }}")
 	sourceLinkBuilder.WriteString("{{ end }}")
 
@@ -160,7 +157,8 @@ func getRequirementsTableTemplates() string {
 	requirementsSectionBuilder := strings.Builder{}
 	requirementsSectionBuilder.WriteString(`{{ define "chart.requirementsHeader" }}## Requirements{{ end }}`)
 
-	requirementsSectionBuilder.WriteString(`{{ define "chart.kubeVersion" }}`)
+	requirementsSectionBuilder.WriteString(`{{ define "chart.kubeVersion" }}{{ .KubeVersion }}{{ end }}\n`)
+	requirementsSectionBuilder.WriteString(`{{ define "chart.kubeVersionLine" }}`)
 	requirementsSectionBuilder.WriteString("{{ if .KubeVersion }}Kubernetes: `{{ .KubeVersion }}`{{ end }}")
 	requirementsSectionBuilder.WriteString("{{ end }}")
 
@@ -177,7 +175,7 @@ func getRequirementsTableTemplates() string {
 	requirementsSectionBuilder.WriteString(`{{ template "chart.requirementsHeader" . }}`)
 	requirementsSectionBuilder.WriteString("\n\n")
 	requirementsSectionBuilder.WriteString("{{ if .KubeVersion }}")
-	requirementsSectionBuilder.WriteString(`{{ template "chart.kubeVersion" . }}`)
+	requirementsSectionBuilder.WriteString(`{{ template "chart.kubeVersionLine" . }}`)
 	requirementsSectionBuilder.WriteString("\n\n")
 	requirementsSectionBuilder.WriteString("{{ end }}")
 	requirementsSectionBuilder.WriteString("{{ if .Dependencies }}")