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: Support escapes within emphasis #2627

Merged
merged 5 commits into from Nov 2, 2022
Merged

fix: Support escapes within emphasis #2627

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
41270b8
fix: Support escapes within emphasis
gibson042 Oct 27, 2022
2ee7bfd
chore: realign comments with regexp alternatives
gibson042 Oct 28, 2022
8e1aa37
test: Add HTML test for escapes within emphasis
gibson042 Oct 28, 2022
2fbf745
fix: Correct recognition and masking of escaped emphasis punctuation
gibson042 Oct 31, 2022
b365f2a
fix: Correct backslash fake-lookbehind
gibson042 Nov 1, 2022
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
3 changes: 2 additions & 1 deletion src/Lexer.js
View file
Open in desktop
Expand Up @@ -350,7 +350,8 @@ export class Lexer {

// Mask out escaped em & strong delimiters
while ((match = this.tokenizer.rules.inline.escapedEmSt.exec(maskedSrc)) != null) {
maskedSrc = maskedSrc.slice(0, match.index) + '++' + maskedSrc.slice(this.tokenizer.rules.inline.escapedEmSt.lastIndex);
maskedSrc = maskedSrc.slice(0, match.index + match[0].length - 2) + '++' + maskedSrc.slice(this.tokenizer.rules.inline.escapedEmSt.lastIndex);
this.tokenizer.rules.inline.escapedEmSt.lastIndex--;
Copy link
Contributor

Choose a reason for hiding this comment

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

@UziTech Similar to my comment on #2628, would this whole PR (and #2628) be cleaner if we just pre-masked out all escaped characters (not just * and _)? Rather than each tokenizer trying to handle escaped characters in its own way?

Copy link
Member

Choose a reason for hiding this comment

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

I think that would require a lot more work trying to make sure we mask out the right characters everywhere. #2628 and this PR are two separate PRs doing two different things. I think we should merge this PR pretty much how it is. If we want to consolidate how things are done after merging this we can.

}

while (src) {
Expand Down
10 changes: 6 additions & 4 deletions src/Tokenizer.js
View file
Open in desktop
Expand Up @@ -629,22 +629,24 @@ export class Tokenizer {
// Remove extra characters. *a*** -> *a*
rLength = Math.min(rLength, rLength + delimTotal + midDelimTotal);

const raw = src.slice(0, lLength + match.index + (match[0].length - rDelim.length) + rLength);

// Create `em` if smallest delimiter has odd char count. *a***
if (Math.min(lLength, rLength) % 2) {
const text = src.slice(1, lLength + match.index + rLength);
const text = raw.slice(1, -1);
return {
type: 'em',
raw: src.slice(0, lLength + match.index + rLength + 1),
raw,
text,
tokens: this.lexer.inlineTokens(text)
};
}

// Create 'strong' if smallest delimiter has even char count. **a***
const text = src.slice(2, lLength + match.index + rLength - 1);
const text = raw.slice(2, -2);
return {
type: 'strong',
raw: src.slice(0, lLength + match.index + rLength + 1),
raw,
text,
tokens: this.lexer.inlineTokens(text)
};
Expand Down
10 changes: 6 additions & 4 deletions src/rules.js
View file
Open in desktop
Expand Up @@ -168,9 +168,9 @@ export const inline = {
emStrong: {
lDelim: /^(?:\*+(?:([punct_])|[^\s*]))|^_+(?:([punct*])|([^\s_]))/,
// (1) and (2) can only be a Right Delimiter. (3) and (4) can only be Left. (5) and (6) can be either Left or Right.
// () Skip orphan inside strong () Consume to delim (1) #*** (2) a***#, a*** (3) #***a, ***a (4) ***# (5) #***# (6) a***a
rDelimAst: /^[^_*]*?\_\_[^_*]*?\*[^_*]*?(?=\_\_)|[^*]+(?=[^*])|[punct_](\*+)(?=[\s]|$)|[^punct*_\s](\*+)(?=[punct_\s]|$)|[punct_\s](\*+)(?=[^punct*_\s])|[\s](\*+)(?=[punct_])|[punct_](\*+)(?=[punct_])|[^punct*_\s](\*+)(?=[^punct*_\s])/,
rDelimUnd: /^[^_*]*?\*\*[^_*]*?\_[^_*]*?(?=\*\*)|[^_]+(?=[^_])|[punct*](\_+)(?=[\s]|$)|[^punct*_\s](\_+)(?=[punct*\s]|$)|[punct*\s](\_+)(?=[^punct*_\s])|[\s](\_+)(?=[punct*])|[punct*](\_+)(?=[punct*])/ // ^- Not allowed for _
// () Skip orphan inside strong () Consume to delim (1) #*** (2) a***#, a*** (3) #***a, ***a (4) ***# (5) #***# (6) a***a
rDelimAst: /^(?:[^_*\\]|\\.)*?\_\_(?:[^_*\\]|\\.)*?\*(?:[^_*\\]|\\.)*?(?=\_\_)|(?:[^*\\]|\\.)+(?=[^*])|[punct_](\*+)(?=[\s]|$)|(?:[^punct*_\s\\]|\\.)(\*+)(?=[punct_\s]|$)|[punct_\s](\*+)(?=[^punct*_\s])|[\s](\*+)(?=[punct_])|[punct_](\*+)(?=[punct_])|(?:[^punct*_\s\\]|\\.)(\*+)(?=[^punct*_\s])/,
rDelimUnd: /^(?:[^_*\\]|\\.)*?\*\*(?:[^_*\\]|\\.)*?\_(?:[^_*\\]|\\.)*?(?=\*\*)|(?:[^_\\]|\\.)+(?=[^_])|[punct*](\_+)(?=[\s]|$)|(?:[^punct*_\s\\]|\\.)(\_+)(?=[punct*\s]|$)|[punct*\s](\_+)(?=[^punct*_\s])|[\s](\_+)(?=[punct*])|[punct*](\_+)(?=[punct*])/ // ^- Not allowed for _
},
code: /^(`+)([^`]|[^`][\s\S]*?[^`])\1(?!`)/,
br: /^( {2,}|\\)\n(?!\s*$)/,
Expand All @@ -186,7 +186,9 @@ inline.punctuation = edit(inline.punctuation).replace(/punctuation/g, inline._pu

// sequences em should skip over [title](link), `code`, <html>
inline.blockSkip = /\[[^\]]*?\]\([^\)]*?\)|`[^`]*?`|<[^>]*?>/g;
inline.escapedEmSt = /\\\*|\\_/g;
// lookbehind is not available on Safari as of version 16
// inline.escapedEmSt = /(?<=(?:^|[^\\)(?:\\[^])*)\\[*_]/g;
inline.escapedEmSt = /(?:^|[^\\])(?:\\\\)*\\[*_]/g;

inline._comment = edit(block._comment).replace('(?:-->|$)', '-->').getRegex();

Expand Down
7 changes: 7 additions & 0 deletions test/specs/new/escape_within_emphasis.html
View file
Open in desktop
@@ -0,0 +1,7 @@
<p><strong>strong text[</strong>]</p>

<p><strong>strong text\[</strong>]</p>

<p><em>em[pha](sis)</em></p>

<p><em>\</em></p>
7 changes: 7 additions & 0 deletions test/specs/new/escape_within_emphasis.md
View file
Open in desktop
@@ -0,0 +1,7 @@
**strong text\[**\]

**strong text\\\[**\]

_em\[pha\]\(sis\)_
Copy link
Contributor

Choose a reason for hiding this comment

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

You have one and three backslashes; could you add an example with 2 backslashes just for completeness?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You have good intuition! Done, with a supporting bug fix.

Copy link
Contributor

Choose a reason for hiding this comment

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

What about **strong text\\[**\]

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That's one of the cases that is not yet handled correctly as of this PR.

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah, ok.


_\\_
35 changes: 35 additions & 0 deletions test/unit/Lexer-spec.js
View file
Open in desktop
Expand Up @@ -776,6 +776,41 @@ paragraph
});
});

it('escaped punctuation inside emphasis', () => {
calculuschild marked this conversation as resolved.
Show resolved Hide resolved
expectInlineTokens({
md: '**strong text\\[**\\]',
tokens: [
{
type: 'strong',
raw: '**strong text\\[**',
text: 'strong text\\[',
tokens: [
{ type: 'text', raw: 'strong text', text: 'strong text' },
{ type: 'escape', raw: '\\[', text: '[' }
]
},
{ type: 'escape', raw: '\\]', text: ']' }
]
});
expectInlineTokens({
md: '_em\\<pha\\>sis_',
tokens: [
{
type: 'em',
raw: '_em\\<pha\\>sis_',
text: 'em\\<pha\\>sis',
tokens: [
{ type: 'text', raw: 'em', text: 'em' },
{ type: 'escape', raw: '\\<', text: '&lt;' },
{ type: 'text', raw: 'pha', text: 'pha' },
{ type: 'escape', raw: '\\>', text: '&gt;' },
{ type: 'text', raw: 'sis', text: 'sis' }
]
}
]
});
});

it('html', () => {
expectInlineTokens({
md: '<div>html</div>',
Expand Down