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.

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

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

merged 3 commits into from
Sep 16, 2018

Conversation

richdouglasevans
Copy link
Contributor

@richdouglasevans richdouglasevans commented Sep 15, 2018

Marked version:

0.5.0 (latest)

Markdown flavor: all

Description

Contributor

  • Test(s) exist to ensure functionality and minimize regression (if no tests added, list tests covering this PR); or,
  • no tests required for this PR.
  • If submitting new feature, it has been documented in the appropriate places.

Committer

In most cases, this should be a different person than the contributor.

  • Draft GitHub release notes have been updated.
  • CI is green (no forced merge required).
  • Merge PR

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

@richdouglasevans richdouglasevans Sep 15, 2018

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

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.

😍

lib/marked.js Outdated
} else if (this.inRawBlock
&& /^<\/pre>|^<\/code>|^<\/kbd>|^<\/script>/i.test(cap[0])) {
this.inRawBlock = false;
}
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

@richdouglasevans
Copy link
Contributor Author

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

Agreed, great suggestion 👍 I have done so.

lib/marked.js Outdated
@@ -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 👍

@styfle styfle changed the title [#1334] turn off typographic substitution in certain blocks Fix smartypants typographic substitution in certain blocks Sep 16, 2018
Copy link
Member

@styfle styfle left a comment

Choose a reason for hiding this comment

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

LGTM, thanks! 🎉

@styfle styfle changed the title Fix smartypants typographic substitution in certain blocks Fix smartypants typographic substitution in (pre|code|kbd|script) blocks Sep 16, 2018
@styfle styfle changed the title Fix smartypants typographic substitution in (pre|code|kbd|script) blocks Fix typographic substitution in (pre|code|kbd|script) blocks when smartypants=true Sep 16, 2018
@styfle
Copy link
Member

styfle commented Sep 16, 2018

Great job! 🎉

coach z

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants