Skip to content

fix: support GFM protocol autolinks #4067

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

Open
evgenyponomarev wants to merge 1 commit into
base: master
Choose a base branch
from
+64 −8
Open

fix: support GFM protocol autolinks #4067

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions src/rules.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -464,6 +464,10 @@ const reflinkSearch = edit('reflink|nolink(?!\\()', 'g')
.getRegex();

const _caseInsensitiveProtocol = /[hH][tT][tT][pP][sS]?|[fF][tT][pP]/;
const _extendedEmail = /[A-Za-z0-9._+-]+@[a-zA-Z0-9-_]+(?:\.[a-zA-Z0-9-_]*[a-zA-Z0-9])+(?![\w-])/;
const _extendedEmailProtocol = edit(/(?:mailto:email|xmpp:email(?:\/[A-Za-z0-9@.]+)?)/)
.replace(/email/g, _extendedEmail)
.getRegex();

/**
* Normal Inline Grammar
Expand Down Expand Up @@ -522,14 +526,16 @@ const inlineGfm: Record<InlineKeys, RegExp> = {
emStrongLDelim: emStrongLDelimGfm,
delLDelim,
delRDelim,
url: edit(/^((?:protocol):\/\/|www\.)(?:[a-zA-Z0-9\-]+\.?)+[^\s<]*|^email/)
url: edit(/^emailProtocol|^((?:protocol):\/\/|www\.)(?:[a-zA-Z0-9\-]+\.?)+[^\s<]*|^email/)
.replace('emailProtocol', _extendedEmailProtocol)
.replace('protocol', _caseInsensitiveProtocol)
.replace('email', /[A-Za-z0-9._+-]+(@)[a-zA-Z0-9-_]+(?:\.[a-zA-Z0-9-_]*[a-zA-Z0-9])+(?![-_])/)
.getRegex(),
_backpedal: /(?:[^?!.,:;*_'"~()&]+|\([^)]*\)|&(?![a-zA-Z0-9]+;$)|[?!.,:;*_'"~)]+(?!$))+/,
del: /^(~~?)(?=[^\s~])((?:\\[\s\S]|[^\\])*?(?:\\[\s\S]|[^\s~\\]))\1(?=[^~]|$)/,
text: edit(/^(`+|~+|[^`~])(?:(?=[`~])|(?= {2,}\n)|(?=[a-zA-Z0-9.!#$%&'*+\/=?_`{\|}~-]+@)|[\s\S]*?(?:(?=[\\<!\[`*~_]|\b_|protocol:\/\/|www\.|$)|[^ ](?= {2,}\n)|[^a-zA-Z0-9.!#$%&'*+\/=?_`{\|}~-](?=[a-zA-Z0-9.!#$%&'*+\/=?_`{\|}~-]+@)))/)
text: edit(/^(?:[^a-zA-Z0-9](?=emailProtocol)|(`+|~+|[^`~])(?:(?=[`~])|(?= {2,}\n)|(?=[a-zA-Z0-9.!#$%&'*+\/=?_`{\|}~-]+@)|[\s\S]*?(?:(?=[\\<!\[`*~_]|\b_|protocol:\/\/|www\.|$)|[^ ](?= {2,}\n)|[^a-zA-Z0-9](?=emailProtocol)|[^a-zA-Z0-9.!#$%&'*+\/=?_`{\|}~-](?=[a-zA-Z0-9.!#$%&'*+\/=?_`{\|}~-]+@))))/)
.replace('protocol', _caseInsensitiveProtocol)
.replace(/emailProtocol/g, /(?:mailto|xmpp):/)
.getRegex(),
};

Expand Down
9 changes: 3 additions & 6 deletions test/specs/gfm/gfm.0.29.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,22 +147,19 @@
"section": "[extension] Autolinks",
"html": "<p><a href=\"mailto:foo@bar.baz\">mailto:foo@bar.baz</a></p>\n<p><a href=\"mailto:a.b-c_d@a.b\">mailto:a.b-c_d@a.b</a></p>\n<p><a href=\"mailto:a.b-c_d@a.b\">mailto:a.b-c_d@a.b</a>.</p>\n<p><a href=\"mailto:a.b-c_d@a.b\">mailto:a.b-c_d@a.b</a>/</p>\n<p>mailto:a.b-c_d@a.b-</p>\n<p>mailto:a.b-c_d@a.b_</p>\n<p><a href=\"xmpp:foo@bar.baz\">xmpp:foo@bar.baz</a></p>\n<p><a href=\"xmpp:foo@bar.baz\">xmpp:foo@bar.baz</a>.</p>",
"markdown": "mailto:foo@bar.baz\n\nmailto:a.b-c_d@a.b\n\nmailto:a.b-c_d@a.b.\n\nmailto:a.b-c_d@a.b/\n\nmailto:a.b-c_d@a.b-\n\nmailto:a.b-c_d@a.b_\n\nxmpp:foo@bar.baz\n\nxmpp:foo@bar.baz.",
"example": 633,
"shouldFail": true
"example": 633
},
{
"section": "[extension] Autolinks",
"html": "<p><a href=\"xmpp:foo@bar.baz/txt\">xmpp:foo@bar.baz/txt</a></p>\n<p><a href=\"xmpp:foo@bar.baz/txt@bin\">xmpp:foo@bar.baz/txt@bin</a></p>\n<p><a href=\"xmpp:foo@bar.baz/txt@bin.com\">xmpp:foo@bar.baz/txt@bin.com</a></p>",
"markdown": "xmpp:foo@bar.baz/txt\n\nxmpp:foo@bar.baz/txt@bin\n\nxmpp:foo@bar.baz/txt@bin.com",
"example": 634,
"shouldFail": true
"example": 634
},
{
"section": "[extension] Autolinks",
"html": "<p><a href=\"xmpp:foo@bar.baz/txt\">xmpp:foo@bar.baz/txt</a>/bin</p>",
"markdown": "xmpp:foo@bar.baz/txt/bin",
"example": 635,
"shouldFail": true
"example": 635
},
{
"section": "[extension] Disallowed Raw HTML",
Expand Down
53 changes: 53 additions & 0 deletions test/unit/Lexer.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2118,6 +2118,59 @@ paragraph
],
});
});

it('url email protocols', () => {
expectInlineTokens({
md: 'Contact mailto:foo@bar.baz and (xmpp:bar@baz.qux/resource).',
options: { gfm: true },
tokens: [
{
type: 'text',
raw: 'Contact ',
text: 'Contact ',
escaped: false,
},
{
type: 'link',
raw: 'mailto:foo@bar.baz',
text: 'mailto:foo@bar.baz',
href: 'mailto:foo@bar.baz',
tokens: [
{
type: 'text',
raw: 'mailto:foo@bar.baz',
text: 'mailto:foo@bar.baz',
},
],
},
{
type: 'text',
raw: ' and (',
text: ' and (',
escaped: false,
},
{
type: 'link',
raw: 'xmpp:bar@baz.qux/resource',
text: 'xmpp:bar@baz.qux/resource',
href: 'xmpp:bar@baz.qux/resource',
tokens: [
{
type: 'text',
raw: 'xmpp:bar@baz.qux/resource',
text: 'xmpp:bar@baz.qux/resource',
},
],
},
{
type: 'text',
raw: ').',
text: ').',
escaped: false,
},
],
});
});
});

it('text', () => {
Expand Down