Skip to content
New issue

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

#

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

Already on GitHub? # to your account

fix: Percent-encode Markdown reserved symbols in URLs #26

Merged
merged 3 commits into from
Oct 24, 2021
Merged

fix: Percent-encode Markdown reserved symbols in URLs #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4346706
fix: Percent-encode Markdown reserved symbols in URLs
AndrejsK Oct 22, 2021
b80a920
refactor: Optimized URL encoding
AndrejsK Oct 24, 2021
7403a76
test: Added URL encoding validation
AndrejsK Oct 24, 2021
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
27 changes: 24 additions & 3 deletions src/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,19 +187,40 @@ export const defaultTranslators: TranslatorConfigObject = {
const href = node.getAttribute('href');
if (!href) return {};

// Encodes symbols that can cause problems in markdown
let encodedHref = '';
for (const chr of href) {
switch (chr) {
case '(':
encodedHref += '%28';
break;
case ')':
encodedHref += '%29';
break;
case '_':
encodedHref += '%5F';
break;
case '*':
encodedHref += '%2A';
break;
default:
encodedHref += chr;
}
}

const title = node.getAttribute('title');

// Inline link, when possible
// See: https://github.com/crosstype/node-html-markdown/issues/17
if (node.textContent === href) return { content: `<${href}>` };
if (node.textContent === href) return { content: `<${encodedHref}>` };

return {
postprocess: ({ content }) => content.replace(/(?:\r?\n)+/g, ' '),
childTranslators: visitor.instance.aTagTranslators,
prefix: '[',
postfix: ']' + (!options.useLinkReferenceDefinitions
? `(${href}${title ? ` "${title}"` : ''})`
: `[${visitor.addOrGetUrlDefinition(href)}]`)
? `(${encodedHref}${title ? ` "${title}"` : ''})`
: `[${visitor.addOrGetUrlDefinition(encodedHref)}]`)
}
},

Expand Down
5 changes: 4 additions & 1 deletion test/default-tags.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,14 +44,17 @@ describe(`Default Tags`, () => {

test(`Link (a)`, () => {
const url = 'http://github.com/crosstype';
const specialUrl = 'http://github.com/crosstype/**/_test(123)';
const encodedSpecialUrl = 'http://github.com/crosstype/%2A%2A/%5Ftest%28123%29';
const res = translate(`
<a href="${url}">a<br><br>b<strong>c</strong></a>
<a>a<strong>b</strong></a> <!-- This node is treated as text due to no href -->
<a href="${url}">${url}</a>
<!-- see: https://github.com/crosstype/node-html-markdown/issues/25 -->
<a href="${url}">a<a href="2">nested</a><img src="${url}">b</a>
<b><i><a href="${specialUrl}" title="a">b</a></i></b>
`);
expect(res).toBe(`[a b**c**](${url}) a**b** <${url}> [a](${url})[nested](2)![](${url})b `);
expect(res).toBe(`[a b**c**](${url}) a**b** <${url}> [a](${url})[nested](2)![](${url})b **_[b](${encodedSpecialUrl} "a")_** `);
});

test(`Image (img)`, () => {
Expand Down