projects / brevno-suite / hugo / commitdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: 62efcdf)
parser: Accept JSON frontmatter without leading "{\n"
authorcrasm <crasm@git.1.email.vczf.io>
Tue, 20 Dec 2016 13:54:52 +0000 (08:54 -0500)
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Mon, 13 Mar 2017 16:19:03 +0000 (17:19 +0100)
Accept JSON frontmatter without leading "{\n" so that one line
frontmatters such as `{"param":"paramvalue"}` no longer silently render
empty html.

docs/content/content/front-matter.md patch | blob | history
parser/page.go patch | blob | history
parser/parse_frontmatter_test.go patch | blob | history

diff --git a/docs/content/content/front-matter.md b/docs/content/content/front-matter.md
index 017fa98c7be176d0cc93b34c32eeee3a24f8b36a..e61a48f55bc94a49ec347ae9932a59184262f6f9 100644 (file)
--- a/docs/content/content/front-matter.md
+++ b/docs/content/content/front-matter.md
@@ -21,7 +21,7 @@ Supported formats:
 
   * **[TOML][]**, identified by '`+++`'.
   * **[YAML][]**, identified by '`---`'.
-  * **[JSON][]**, a single JSON object which is surrounded by '`{`' and '`}`', each on their own line.
+  * **[JSON][]**, a single JSON object which is surrounded by '`{`' and '`}`', followed by a newline.
 
 [TOML]: https://github.com/toml-lang/toml "Tom's Obvious, Minimal Language"
 [YAML]: http://www.yaml.org/ "YAML Ain't Markup Language"
diff --git a/parser/page.go b/parser/page.go
index a0679289cd926f5082a660a7dc84e10bf1d26305..9639dd7a4b417eae29534bdeba596181f9b205cd 100644 (file)
--- a/parser/page.go
+++ b/parser/page.go
@@ -283,19 +283,12 @@ func isFrontMatterDelim(data []byte) bool {
 }
 
 func determineDelims(firstLine []byte) (left, right []byte) {
-       switch len(firstLine) {
-       case 5:
-               fallthrough
-       case 4:
-               if firstLine[0] == YAMLLead[0] {
-                       return []byte(YAMLDelim), []byte(YAMLDelim)
-               }
+       switch firstLine[0] {
+       case YAMLLead[0]:
+               return []byte(YAMLDelim), []byte(YAMLDelim)
+       case TOMLLead[0]:
                return []byte(TOMLDelim), []byte(TOMLDelim)
-       case 3:
-               fallthrough
-       case 2:
-               fallthrough
-       case 1:
+       case JSONLead[0]:
                return []byte(JSONLead), []byte("}")
        default:
                panic(fmt.Sprintf("Unable to determine delims from %q", firstLine))
diff --git a/parser/parse_frontmatter_test.go b/parser/parse_frontmatter_test.go
index bb30eb1c4a77efb0ef6b182ebfec08150b0cc14d..5de663b263641a0a724e355d94f38e46971003fb 100644 (file)
--- a/parser/parse_frontmatter_test.go
+++ b/parser/parse_frontmatter_test.go
@@ -26,20 +26,22 @@ import (
 )
 
 const (
-       contentNoFrontmatter                 = "a page with no front matter"
-       contentWithFrontmatter               = "---\ntitle: front matter\n---\nContent with front matter"
-       contentHTMLNoDoctype                 = "<html>\n\t<body>\n\t</body>\n</html>"
-       contentHTMLWithDoctype               = "<!doctype html><html><body></body></html>"
-       contentHTMLWithFrontmatter           = "---\ntitle: front matter\n---\n<!doctype><html><body></body></html>"
-       contentHTML                          = "    <html><body></body></html>"
-       contentLinefeedAndHTML               = "\n<html><body></body></html>"
-       contentIncompleteEndFrontmatterDelim = "---\ntitle: incomplete end fm delim\n--\nincomplete frontmatter delim"
-       contentMissingEndFrontmatterDelim    = "---\ntitle: incomplete end fm delim\nincomplete frontmatter delim"
-       contentSlugWorking                   = "---\ntitle: slug doc 2\nslug: slug-doc-2\n\n---\nslug doc 2 content"
-       contentSlugWorkingVariation          = "---\ntitle: slug doc 3\nslug: slug-doc 3\n---\nslug doc 3 content"
-       contentSlugBug                       = "---\ntitle: slug doc 2\nslug: slug-doc-2\n---\nslug doc 2 content"
-       contentSlugWithJSONFrontMatter       = "{\n  \"categories\": \"d\",\n  \"tags\": [\n    \"a\", \n    \"b\", \n    \"c\"\n  ]\n}\nJSON Front Matter with tags and categories"
-       contentWithJSONLooseFrontmatter      = "{\n  \"categories\": \"d\"\n  \"tags\": [\n    \"a\" \n    \"b\" \n    \"c\"\n  ]\n}\nJSON Front Matter with tags and categories"
+       contentNoFrontmatter                        = "a page with no front matter"
+       contentWithFrontmatter                      = "---\ntitle: front matter\n---\nContent with front matter"
+       contentHTMLNoDoctype                        = "<html>\n\t<body>\n\t</body>\n</html>"
+       contentHTMLWithDoctype                      = "<!doctype html><html><body></body></html>"
+       contentHTMLWithFrontmatter                  = "---\ntitle: front matter\n---\n<!doctype><html><body></body></html>"
+       contentHTML                                 = "    <html><body></body></html>"
+       contentLinefeedAndHTML                      = "\n<html><body></body></html>"
+       contentIncompleteEndFrontmatterDelim        = "---\ntitle: incomplete end fm delim\n--\nincomplete frontmatter delim"
+       contentMissingEndFrontmatterDelim           = "---\ntitle: incomplete end fm delim\nincomplete frontmatter delim"
+       contentSlugWorking                          = "---\ntitle: slug doc 2\nslug: slug-doc-2\n\n---\nslug doc 2 content"
+       contentSlugWorkingVariation                 = "---\ntitle: slug doc 3\nslug: slug-doc 3\n---\nslug doc 3 content"
+       contentSlugBug                              = "---\ntitle: slug doc 2\nslug: slug-doc-2\n---\nslug doc 2 content"
+       contentSlugWithJSONFrontMatter              = "{\n  \"categories\": \"d\",\n  \"tags\": [\n    \"a\", \n    \"b\", \n    \"c\"\n  ]\n}\nJSON Front Matter with tags and categories"
+       contentWithJSONLooseFrontmatter             = "{\n  \"categories\": \"d\"\n  \"tags\": [\n    \"a\" \n    \"b\" \n    \"c\"\n  ]\n}\nJSON Front Matter with tags and categories"
+       contentSlugWithJSONFrontMatterFirstLineOnly = "{\"categories\":\"d\",\"tags\":[\"a\",\"b\",\"c\"]}\nJSON Front Matter with tags and categories"
+       contentSlugWithJSONFrontMatterFirstLine     = "{\"categories\":\"d\",\n  \"tags\":[\"a\",\"b\",\"c\"]}\nJSON Front Matter with tags and categories"
 )
 
 var lineEndings = []string{"\n", "\r\n"}
@@ -117,6 +119,8 @@ func TestStandaloneCreatePageFrom(t *testing.T) {
                {contentLinefeedAndHTML, false, true, "", "<html><body></body></html>"},
                {contentSlugWithJSONFrontMatter, true, false, "{\n  \"categories\": \"d\",\n  \"tags\": [\n    \"a\", \n    \"b\", \n    \"c\"\n  ]\n}", "JSON Front Matter with tags and categories"},
                {contentWithJSONLooseFrontmatter, true, false, "{\n  \"categories\": \"d\"\n  \"tags\": [\n    \"a\" \n    \"b\" \n    \"c\"\n  ]\n}", "JSON Front Matter with tags and categories"},
+               {contentSlugWithJSONFrontMatterFirstLineOnly, true, false, "{\"categories\":\"d\",\"tags\":[\"a\",\"b\",\"c\"]}", "JSON Front Matter with tags and categories"},
+               {contentSlugWithJSONFrontMatterFirstLine, true, false, "{\"categories\":\"d\",\n  \"tags\":[\"a\",\"b\",\"c\"]}", "JSON Front Matter with tags and categories"},
                {contentSlugWorking, true, false, "---\ntitle: slug doc 2\nslug: slug-doc-2\n\n---\n", "slug doc 2 content"},
                {contentSlugWorkingVariation, true, false, "---\ntitle: slug doc 3\nslug: slug-doc 3\n---\n", "slug doc 3 content"},
                {contentSlugBug, true, false, "---\ntitle: slug doc 2\nslug: slug-doc-2\n---\n", "slug doc 2 content"},
Unnamed repository; edit this file 'description' to name the repository.