examples munger allows any file extension.

nikhiljindal · Dec 7, 2015 · 21f8193 · 21f8193
1 parent ec1ba74
commit 21f8193
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 2 deletions.
diff --git a/cmd/mungedocs/example_syncer.go b/cmd/mungedocs/example_syncer.go
@@ -27,7 +27,7 @@ const exampleToken = "EXAMPLE"
 
 const exampleLineStart = "<!-- BEGIN MUNGE: EXAMPLE"
 
-var exampleMungeTagRE = regexp.MustCompile(beginMungeTag(fmt.Sprintf("%s %s", exampleToken, `(([^ ])*.(yaml|json))`)))
+var exampleMungeTagRE = regexp.MustCompile(beginMungeTag(fmt.Sprintf("%s %s", exampleToken, `(([^ ])*[.]([^.]*))`)))
 
 // syncExamples updates all examples in markdown file.
 //
@@ -77,7 +77,14 @@ func syncExamples(filePath string, mlines mungeLines) (mungeLines, error) {
 	}
 	// update all example Tags
 	for _, tag := range exampleTags {
-		example, err := exampleContent(filePath, tag.linkText, tag.fileType)
+		ft := ""
+		if tag.fileType == "json" {
+			ft = "json"
+		}
+		if tag.fileType == "yaml" {
+			ft = "yaml"
+		}
+		example, err := exampleContent(filePath, tag.linkText, ft)
 		if err != nil {
 			return mlines, err
 		}

diff --git a/cmd/mungedocs/example_syncer_test.go b/cmd/mungedocs/example_syncer_test.go
@@ -33,6 +33,8 @@ spec:
     image: nginx
     ports:
     - containerPort: 80
+`
+	var textExample = `some text
 `
 	var cases = []struct {
 		in       string
@@ -47,6 +49,10 @@ spec:
 			"<!-- BEGIN MUNGE: EXAMPLE ../mungedocs/testdata/pod.yaml -->\n<!-- END MUNGE: EXAMPLE ../mungedocs/testdata/pod.yaml -->\n",
 			"<!-- BEGIN MUNGE: EXAMPLE ../mungedocs/testdata/pod.yaml -->\n\n```yaml\n" + podExample + "```\n\n[Download example](../mungedocs/testdata/pod.yaml?raw=true)\n<!-- END MUNGE: EXAMPLE ../mungedocs/testdata/pod.yaml -->\n",
 		},
+		{
+			"<!-- BEGIN MUNGE: EXAMPLE testdata/example.txt -->\n<!-- END MUNGE: EXAMPLE testdata/example.txt -->\n",
+			"<!-- BEGIN MUNGE: EXAMPLE testdata/example.txt -->\n\n```\n" + textExample + "```\n\n[Download example](testdata/example.txt?raw=true)\n<!-- END MUNGE: EXAMPLE testdata/example.txt -->\n",
+		},
 	}
 	repoRoot = ""
 	for _, c := range cases {

diff --git a/cmd/mungedocs/testdata/example.txt b/cmd/mungedocs/testdata/example.txt
@@ -0,0 +1 @@
+some text