github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2025-03-21 09:21:03 +00:00
Code Issues Projects Releases Packages Wiki Activity

Allow for any (short) line begining or ending with html comment

Browse source 
Fixes #1428
This commit is contained in:
Sven Dowideit 2015-09-23 14:43:17 +10:00 committed by Bjørn Erik Pedersen
parent a43b037651
commit a1e32439fb
2 changed files with 89 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
hugolib/page_test.go
View file

@ -22,6 +22,10 @@ const (
SIMPLE_PAGE = "---\ntitle: Simple\n---\nSimple Page\n" SIMPLE_PAGE = "---\ntitle: Simple\n---\nSimple Page\n"
INVALID_FRONT_MATTER_MISSING = "This is a test" INVALID_FRONT_MATTER_MISSING = "This is a test"
RENDER_NO_FRONT_MATTER = "<!doctype><html><head></head><body>This is a test</body></html>" RENDER_NO_FRONT_MATTER = "<!doctype><html><head></head><body>This is a test</body></html>"
CONTENT_WITH_COMMENTED_FM = "<!--\n+++\ntitle = \"Network configuration\"\ndescription = \"Docker networking\"\nkeywords = [\"network\"]\n[menu.main]\nparent= \"smn_administrate\"\n+++\n-->\n\n# Network configuration\n\n##\nSummary"
CONTENT_WITH_COMMENTED_TEXT_FM = "<!--[metaData]>\n+++\ntitle = \"Network configuration\"\ndescription = \"Docker networking\"\nkeywords = [\"network\"]\n[menu.main]\nparent= \"smn_administrate\"\n+++\n<![end-metadata]-->\n\n# Network configuration\n\n##\nSummary"
CONTENT_WITH_COMMENTED_LONG_FM = "<!--[metaData123456789012345678901234567890]>\n+++\ntitle = \"Network configuration\"\ndescription = \"Docker networking\"\nkeywords = [\"network\"]\n[menu.main]\nparent= \"smn_administrate\"\n+++\n<![end-metadata]-->\n\n# Network configuration\n\n##\nSummary"
CONTENT_WITH_COMMENTED_LONG2_FM = "<!--[metaData]>\n+++\ntitle = \"Network configuration\"\ndescription = \"Docker networking\"\nkeywords = [\"network\"]\n[menu.main]\nparent= \"smn_administrate\"\n+++\n<![end-metadata123456789012345678901234567890]-->\n\n# Network configuration\n\n##\nSummary"
INVALID_FRONT_MATTER_SHORT_DELIM = ` INVALID_FRONT_MATTER_SHORT_DELIM = `
-- --
title: Short delim start title: Short delim start
@ -661,6 +665,10 @@ func TestShouldRenderContent(t *testing.T) {
// TODO how to deal with malformed frontmatter. In this case it'll be rendered as markdown. // TODO how to deal with malformed frontmatter. In this case it'll be rendered as markdown.
{INVALID_FRONT_MATTER_SHORT_DELIM, true}, {INVALID_FRONT_MATTER_SHORT_DELIM, true},
{RENDER_NO_FRONT_MATTER, false}, {RENDER_NO_FRONT_MATTER, false},
{CONTENT_WITH_COMMENTED_FM, true},
{CONTENT_WITH_COMMENTED_TEXT_FM, true},
{CONTENT_WITH_COMMENTED_LONG_FM, false},
{CONTENT_WITH_COMMENTED_LONG2_FM, true},
} }
for _, test := range tests { for _, test := range tests {

95
parser/page.go
View file

@ -6,20 +6,23 @@ import (
"fmt" "fmt"
"io" "io"
"regexp" "regexp"
"strings"
"unicode" "unicode"
) )
const ( const (
HTML_LEAD = "<" HTML_LEAD = "<"
YAML_LEAD = "-" YAML_LEAD = "-"
YAML_DELIM_UNIX = "---\n" YAML_DELIM_UNIX = "---\n"
YAML_DELIM_DOS = "---\r\n" YAML_DELIM_DOS = "---\r\n"
YAML_DELIM = "---" YAML_DELIM = "---"
TOML_LEAD = "+" TOML_LEAD = "+"
TOML_DELIM_UNIX = "+++\n" TOML_DELIM_UNIX = "+++\n"
TOML_DELIM_DOS = "+++\r\n" TOML_DELIM_DOS = "+++\r\n"
TOML_DELIM = "+++" TOML_DELIM = "+++"
JSON_LEAD = "{" JSON_LEAD = "{"
HTML_COMMENT_START = "<!--"
HTML_COMMENT_END = "-->"
) )
var ( var (
@ -79,6 +82,9 @@ func ReadFrom(r io.Reader) (p Page, err error) {
if err = chompWhitespace(reader); err != nil && err != io.EOF { if err = chompWhitespace(reader); err != nil && err != io.EOF {
return return
} }
if err = chompFrontmatterStartComment(reader); err != nil && err != io.EOF {
return
}
firstLine, err := peekLine(reader) firstLine, err := peekLine(reader)
if err != nil && err != io.EOF { if err != nil && err != io.EOF {
@ -120,6 +126,65 @@ func chompWhitespace(r io.RuneScanner) (err error) {
} }
} }
func chompFrontmatterStartComment(r *bufio.Reader) (err error) {
candidate, err := r.Peek(32)
if err != nil {
return err
}
str := string(candidate)
if strings.HasPrefix(str, HTML_COMMENT_START) {
lineEnd := strings.IndexAny(str, "\n")
if lineEnd == -1 {
//TODO: if we can't find it, Peek more?
return nil
}
testStr := strings.TrimSuffix(str[0:lineEnd], "\r")
if strings.Index(testStr, HTML_COMMENT_END) != -1 {
return nil
}
buf := make([]byte, lineEnd)
if _, err = r.Read(buf); err != nil {
return
}
if err = chompWhitespace(r); err != nil {
return err
}
}
return nil
}
func chompFrontmatterEndComment(r *bufio.Reader) (err error) {
candidate, err := r.Peek(32)
if err != nil {
return err
}
str := string(candidate)
lineEnd := strings.IndexAny(str, "\n")
if lineEnd == -1 {
return nil
}
testStr := strings.TrimSuffix(str[0:lineEnd], "\r")
if strings.Index(testStr, HTML_COMMENT_START) != -1 {
return nil
}
//TODO: if we can't find it, Peek more?
if strings.HasSuffix(testStr, HTML_COMMENT_END) {
buf := make([]byte, lineEnd)
if _, err = r.Read(buf); err != nil {
return
}
if err = chompWhitespace(r); err != nil {
return err
}
}
return nil
}
func peekLine(r *bufio.Reader) (line []byte, err error) { func peekLine(r *bufio.Reader) (line []byte, err error) {
firstFive, err := r.Peek(5) firstFive, err := r.Peek(5)
if err != nil { if err != nil {
@ -254,11 +319,13 @@ func extractFrontMatterDelims(r *bufio.Reader, left, right []byte) (fm FrontMatt
if level == 0 { if level == 0 {
// Consumes white spaces immediately behind frontmatter // Consumes white spaces immediately behind frontmatter
if err = chompWhitespace(r); err != nil { if err = chompWhitespace(r); err != nil && err != io.EOF {
if err != io.EOF { return nil, err
return nil, err
}
} }
if err = chompFrontmatterEndComment(r); err != nil && err != io.EOF {
return nil, err
}
return buf.Bytes(), nil return buf.Bytes(), nil
} }
} }