Diff options
| author | Bryce Kwon <bryce@brycekwon.com> | |
|---|---|---|
| committer | Bryce Kwon <bryce@brycekwon.com> | |
| commit | ||
| parent | ||
| tree | ||
| download | ||
Honour backslash escapes in readmes
| -rw-r--r-- | custom/extensions/about-render.lua | 4 | |
| -rw-r--r-- | tests/extensions/test-about-render.lua | 9 |
2 files changed, 12 insertions, 1 deletion
diff --git a/custom/extensions/about-render.lua b/custom/extensions/about-render.lua index 1543795..3c92252 100644 --- a/custom/extensions/about-render.lua +++ b/custom/extensions/about-render.lua @@ -294,7 +294,8 @@ if has_lpeg then local whitespace = S(" \t\r\n\f\v") local eol = P(-1) - local marker = S("`![*_<") + local marker = S("`![*_<\\") + local punctuation = S("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~") local url_char = 1 - S(")") - whitespace -- Bound the link and image inner scans. Without a cap a readme of -- unclosed brackets ("[[[[...") makes every position scan to the @@ -347,6 +348,7 @@ if has_lpeg then -- a remote one would have every visitor's browser call a third party. local inline_grammar = Ct(( (P("`") * C((1 - P("`")) ^ 1) * P("`")) / node_code + + (P("\\") * C(punctuation)) / node_text + (P("<") * C(uri) * P(">")) / node_autolink + (P("<") * C(address) * P(">")) / node_mail + (P("[!") * label * target * P("]") * target) / node_image diff --git a/tests/extensions/test-about-render.lua b/tests/extensions/test-about-render.lua index 601d0dc..236c61a 100644 --- a/tests/extensions/test-about-render.lua +++ b/tests/extensions/test-about-render.lua @@ -108,6 +108,15 @@ out = render("README.md", "an __up__ and _down_ word") h.contains("double underscores embolden", out, "<strong>up</strong>") h.contains("single underscores lean", out, "<em>down</em>") +out = render("README.md", "\\*not leaning\\* and \\# and \\q") +h.contains("a backslash makes punctuation literal", out, "<p>*not leaning* and # and \\q</p>") + +out = render("README.md", "\\# not a heading") +h.contains("an escaped hash starts no heading", out, "<p># not a heading</p>") + +out = render("README.md", "`a\\*b`") +h.contains("code keeps its backslashes", out, "<code>a\\*b</code>") + out = render("README.md", "run `x < y` here") h.contains("inline code is escaped", out, "<code>x < y</code>") |