Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix typographic substitution in (pre|code|kbd|script) blocks when smartypants=true #1335

Merged
merged 3 commits into from
Sep 16, 2018
Merged

Fix typographic substitution in (pre|code|kbd|script) blocks when smartypants=true #1335

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4ba30db
[#1334] turn off typographic substitution in certain blocks
richdouglasevans Sep 15, 2018
f09095e
Use neater alternation in regexes for improved readability
richdouglasevans Sep 16, 2018
d604680
Prevent matching other content that starts with these words
richdouglasevans Sep 16, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 13 additions & 1 deletion lib/marked.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -730,6 +730,14 @@ InlineLexer.prototype.output = function(src) {
} else if (this.inLink && /^<\/a>/i.test(cap[0])) {
this.inLink = false;
}
if (!this.inRawBlock
&& /^<(pre|code|kbd|script)/i.test(cap[0])) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There should be a (\s|>) at the end to prevent matching other tags that start with these words

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good one Tony; I've done so and expanded the tests to prove that.

Loving your attention to detail here, much appreciated 👍

this.inRawBlock = true;
} else if (this.inRawBlock
&& /^<\/(pre|code|kbd|script)>/i.test(cap[0])) {
this.inRawBlock = false;
}
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's some duplication here: it'd be nice to just have a simple list of tags in which no substitution is to be performed -- ['pre', 'code', 'kbd', 'script'] -- 'cos that'd make it easy to add/remove tags; I did try that route but the regexes looked less "on the nose" than this version.

I also experimented with alternate names for the inRawBlock field: they were all too darn long and made the code less readable: forex, isBlockInWhichNoSubstitutionIsToBePerformed.

Happy to take a steer here 😄

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you change them to /^<(pre|code|kbd|script)/i and /^<\/(pre|code|kbd|script)>/i

I think that makes it a little easier to see what the regex is looking for


src = src.substring(cap[0].length);
out += this.options.sanitize
? this.options.sanitizer
Expand Down Expand Up @@ -820,7 +828,11 @@ InlineLexer.prototype.output = function(src) {
// text
if (cap = this.rules.text.exec(src)) {
src = src.substring(cap[0].length);
out += this.renderer.text(escape(this.smartypants(cap[0])));
if (this.inRawBlock) {
out += this.renderer.text(cap[0]);
} else {
out += this.renderer.text(escape(this.smartypants(cap[0])));
}
continue;
}

Expand Down
4 changes: 4 additions & 0 deletions test/new/smartypants_code.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<pre>&amp;</pre>
<p><code>--foo</code>
<kbd>---foo</kbd></p>
<script>--foo</script>
9 changes: 9 additions & 0 deletions test/new/smartypants_code.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
smartypants: true
description: SmartyPants does not modify characters within <pre>, <code>, <kbd>, or <script> tag blocks.
spec: https://daringfireball.net/projects/smartypants/
---
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just trying to be helpful by linking to the "spec" that explains why.

<pre>&amp;</pre>
<code>--foo</code>
<kbd>---foo</kbd>
<script>--foo</script>
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was pleasantly surprised by the form the test suite takes: adding a specification was so easy, good work Team Marked.

😍