Improve formatting of newlines in markdown files

hermanschaaf · hermanschaaf · commit 10acaa034a6e · 2022-12-13T08:21:17.000Z
diff --git a/plugins/.snapshots/TestGenerateSourcePluginDocs-Markdown-README.md b/plugins/.snapshots/TestGenerateSourcePluginDocs-Markdown-README.md
@@ -1,5 +1,7 @@
 # Source Plugin: test
+
 ## Tables
+
 - [test_table](test_table.md)
   - [relation_table](relation_table.md)
     - [relation_relation_table](relation_relation_table.md)
diff --git a/plugins/.snapshots/TestGenerateSourcePluginDocs-Markdown-relation_relation_table.md b/plugins/.snapshots/TestGenerateSourcePluginDocs-Markdown-relation_relation_table.md
@@ -5,10 +5,11 @@ Description for relational table's relation
 The primary key for this table is **_cq_id**.
 
 ## Relations
-This table depends on [relation_table](relation_table.md).
 
+This table depends on [relation_table](relation_table.md).
 
 ## Columns
+
 | Name          | Type          |
 | ------------- | ------------- |
 |_cq_source_name|String|
diff --git a/plugins/.snapshots/TestGenerateSourcePluginDocs-Markdown-relation_table.md b/plugins/.snapshots/TestGenerateSourcePluginDocs-Markdown-relation_table.md
@@ -5,12 +5,14 @@ Description for relational table
 The primary key for this table is **_cq_id**.
 
 ## Relations
+
 This table depends on [test_table](test_table.md).
 
 The following tables depend on relation_table:
   - [relation_relation_table](relation_relation_table.md)
 
 ## Columns
+
 | Name          | Type          |
 | ------------- | ------------- |
 |_cq_source_name|String|
diff --git a/plugins/.snapshots/TestGenerateSourcePluginDocs-Markdown-test_table.md b/plugins/.snapshots/TestGenerateSourcePluginDocs-Markdown-test_table.md
@@ -11,6 +11,7 @@ The following tables depend on test_table:
   - [relation_table2](relation_table2.md)
 
 ## Columns
+
 | Name          | Type          |
 | ------------- | ------------- |
 |_cq_source_name|String|
diff --git a/plugins/source_docs.go b/plugins/source_docs.go
@@ -1,11 +1,13 @@
 package plugins
 
 import (
+	"bytes"
 	"embed"
 	"encoding/json"
 	"fmt"
 	"os"
 	"path/filepath"
+	"regexp"
 	"strings"
 	"text/template"
 
@@ -15,6 +17,9 @@ import (
 //go:embed templates/*.go.tpl
 var templatesFS embed.FS
 
+var reMatchNewlines = regexp.MustCompile(`\n{3,}`)
+var reMatchHeaders = regexp.MustCompile(`(#{1,6}.+)\n+`)
+
 // GenerateSourcePluginDocs creates table documentation for the source plugin based on its list of tables
 func (p *SourcePlugin) GenerateSourcePluginDocs(dir, format string) error {
 	if err := os.MkdirAll(dir, os.ModePerm); err != nil {
@@ -90,15 +95,17 @@ func (p *SourcePlugin) renderTablesAsMarkdown(dir string) error {
 		return fmt.Errorf("failed to parse template for README.md: %v", err)
 	}
 
+	var b bytes.Buffer
+	if err := t.Execute(&b, p); err != nil {
+		return fmt.Errorf("failed to execute template: %v", err)
+	}
+	content := formatMarkdown(b.String())
 	outputPath := filepath.Join(dir, "README.md")
 	f, err := os.Create(outputPath)
 	if err != nil {
 		return fmt.Errorf("failed to create file %v: %v", outputPath, err)
 	}
-	defer f.Close()
-	if err := t.Execute(f, p); err != nil {
-		return fmt.Errorf("failed to execute template: %v", err)
-	}
+	f.WriteString(content)
 	return nil
 }
 
@@ -124,15 +131,23 @@ func renderTable(table *schema.Table, dir string) error {
 	}
 
 	outputPath := filepath.Join(dir, fmt.Sprintf("%s.md", table.Name))
+
+	var b bytes.Buffer
+	if err := t.Execute(&b, table); err != nil {
+		return fmt.Errorf("failed to execute template: %v", err)
+	}
+	content := formatMarkdown(b.String())
 	f, err := os.Create(outputPath)
 	if err != nil {
 		return fmt.Errorf("failed to create file %v: %v", outputPath, err)
 	}
-	defer f.Close()
-	if err := t.Execute(f, table); err != nil {
-		return fmt.Errorf("failed to execute template: %v", err)
-	}
-	return nil
+	f.WriteString(content)
+	return f.Close()
+}
+
+func formatMarkdown(s string) string {
+	s = reMatchNewlines.ReplaceAllString(s, "\n\n")
+	return reMatchHeaders.ReplaceAllString(s, `$1`+"\n\n")
 }
 
 func formatType(v schema.ValueType) string {
