feat: add two regex for markdown linting

norwoodj · May 15, 2020 · 8fb6f38 · 8fb6f38
1 parent 1ee9a7e
commit 8fb6f38
Show file tree

Hide file tree

Showing 11 changed files with 36 additions and 29 deletions.
diff --git a/example-charts/custom-template/README.md b/example-charts/custom-template/README.md
@@ -5,6 +5,7 @@ Basically the same as the nginx-ingress chart, but using a custom template to in
 Current chart version is `0.2.0`
 
 ## Additional Information
+
 Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore
 et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut
 aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse

diff --git a/example-charts/custom-template/README.md.gotmpl b/example-charts/custom-template/README.md.gotmpl
@@ -4,6 +4,7 @@
 {{ template "chart.versionLine" . }}
 
 ## Additional Information
+
 Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore
 et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut
 aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse

diff --git a/example-charts/full-template/README.md b/example-charts/full-template/README.md
@@ -76,7 +76,6 @@ https://github.com/norwoodj/helm-docs/tree/master/example-charts/full-template
 
 ## `chart.sourcesList`
 
-
 * <https://github.com/norwoodj/helm-docs/tree/master/example-charts/full-template>
 
 ## `chart.sourcesSection`

diff --git a/example-charts/full-template/README.md.gotmpl b/example-charts/full-template/README.md.gotmpl
@@ -1,6 +1,13 @@
 {{ template "chart.header" . }}
 ## `chart.deprecationWarning`
 
+
+
+
+
+
+
+
 {{ template "chart.deprecationWarning" . }}
 
 ## `chart.description`

diff --git a/example-charts/helm-3/README.md b/example-charts/helm-3/README.md
@@ -1,8 +1,6 @@
 # nginx-ingress
 
-
-
-![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) 
+![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
 
 A simple wrapper around the stable/nginx-ingress chart that adds a few of our conventions
 

diff --git a/example-charts/most-empty/README.md b/example-charts/most-empty/README.md
@@ -1,12 +1,7 @@
 # most-empty
 
-
-
 Current chart version is `0.2.0`
 
 This is a good example of all the fields that don't appear when they aren't set in chart metadata. `description`,
 `requirements`, and `values` are all empty and don't appear here.
 
-
-
-
diff --git a/example-charts/nginx-ingress/README.md b/example-charts/nginx-ingress/README.md
@@ -1,8 +1,6 @@
 # nginx-ingress
 
-
-
-![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square)  
+![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square) 
 
 A simple wrapper around the stable/nginx-ingress chart that adds a few of our conventions
 

diff --git a/example-charts/no-requirements/README.md b/example-charts/no-requirements/README.md
@@ -1,8 +1,6 @@
 # no-requirements
 
-
-
-![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square)  
+![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square) 
 
 A simple chart that installs, let's say PrometheusRules, that needs no sub-charts
 
@@ -18,8 +16,6 @@ A simple chart that installs, let's say PrometheusRules, that needs no sub-chart
 
 * <https://github.com/norwoodj/helm-docs/tree/master/example-charts/no-requirements>
 
-
-
 ## Values
 
 | Key | Type | Default | Description |

diff --git a/example-charts/no-values/README.md b/example-charts/no-values/README.md
@@ -1,8 +1,6 @@
 # no-values
 
-
-
-![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square)  
+![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square) 
 
 A very simple chart that doesn't even need any values for customization
 
@@ -18,6 +16,3 @@ A very simple chart that doesn't even need any values for customization
 
 * <https://github.com/norwoodj/helm-docs/tree/master/example-charts/no-values>
 
-
-
-
diff --git a/example-charts/special-characters/README.md b/example-charts/special-characters/README.md
@@ -1,8 +1,6 @@
 # special-characters
 
-
-
-![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) 
+![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
 
 A chart demonstrating handling of special characters in values files
 
@@ -18,8 +16,6 @@ A chart demonstrating handling of special characters in values files
 
 * <https://github.com/norwoodj/helm-docs/tree/master/example-charts/special-characters>
 
-
-
 ## Values
 
 | Key | Type | Default | Description |

diff --git a/pkg/document/generate.go b/pkg/document/generate.go
@@ -1,9 +1,11 @@
 package document
 
 import (
+	"bytes"
 	"fmt"
 	"os"
 	"path/filepath"
+	"regexp"
 
 	"github.com/norwoodj/helm-docs/pkg/helm"
 	log "github.com/sirupsen/logrus"
@@ -50,8 +52,27 @@ func PrintDocumentation(chartDocumentationInfo helm.ChartDocumentationInfo, dryR
 		defer outputFile.Close()
 	}
 
-	err = chartDocumentationTemplate.Execute(outputFile, chartTemplateDataObject)
+	var output bytes.Buffer
+	err = chartDocumentationTemplate.Execute(&output, chartTemplateDataObject)
 	if err != nil {
 		log.Warnf("Error generating documentation for chart %s: %s", chartDocumentationInfo.ChartDirectory, err)
 	}
+	output = applyMarkDownFormat(output)
+	_, err = output.WriteTo(outputFile)
+	if err != nil {
+		log.Warnf("Error generating documentation file for chart %s: %s", chartDocumentationInfo.ChartDirectory, err)
+	}
+}
+
+func applyMarkDownFormat(output bytes.Buffer) bytes.Buffer {
+	outputString := output.String()
+	re := regexp.MustCompile(` \n`)
+	outputString = re.ReplaceAllString(outputString, "\n")
+
+	re = regexp.MustCompile(`\n{3,}`)
+	outputString = re.ReplaceAllString(outputString, "\n\n")
+
+	output.Reset()
+	output.WriteString(outputString)
+	return output
 }