Skip to content

Commit 2c0e47a

Browse files
UziTechUziTech
authored
fix: fix image alt text rendered to match common mark (#3668)
1 parent d5bc76e commit 2c0e47a

File tree

9 files changed

+45
-45
lines changed

9 files changed

+45
-45
lines changed

‎src/Renderer.ts‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,10 @@ export class _Renderer {
193193
return out;
194194
}
195195

196-
image({ href, title, text }: Tokens.Image): string {
196+
image({ href, title, text, tokens }: Tokens.Image): string {
197+
if (tokens) {
198+
text = this.parser.parseInline(tokens, this.parser.textRenderer);
199+
}
197200
const cleanHref = cleanUrl(href);
198201
if (cleanHref === null) {
199202
return escape(text);

‎src/Tokenizer.ts‎

Lines changed: 6 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -14,26 +14,17 @@ function outputLink(cap: string[], link: Pick<Tokens.Link, 'href' | 'title'>, ra
1414
const title = link.title || null;
1515
const text = cap[1].replace(rules.other.outputLinkReplace, '$1');
1616

17-
if (cap[0].charAt(0) !== '!') {
18-
lexer.state.inLink = true;
19-
const token: Tokens.Link = {
20-
type: 'link',
21-
raw,
22-
href,
23-
title,
24-
text,
25-
tokens: lexer.inlineTokens(text),
26-
};
27-
lexer.state.inLink = false;
28-
return token;
29-
}
30-
return {
31-
type: 'image',
17+
lexer.state.inLink = true;
18+
const token: Tokens.Link | Tokens.Image = {
19+
type: cap[0].charAt(0) === '!' ? 'image' : 'link',
3220
raw,
3321
href,
3422
title,
3523
text,
24+
tokens: lexer.inlineTokens(text),
3625
};
26+
lexer.state.inLink = false;
27+
return token;
3728
}
3829

3930
function indentCodeCompensation(raw: string, text: string, rules: Rules) {

‎src/Tokens.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,7 @@ export namespace Tokens {
123123
href: string;
124124
title: string | null;
125125
text: string;
126+
tokens: Token[];
126127
}
127128

128129
export interface Link {

‎test/specs/commonmark/commonmark.0.31.2.json‎

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4596,44 +4596,39 @@
45964596
"example": 573,
45974597
"start_line": 8548,
45984598
"end_line": 8554,
4599-
"section": "Images",
4600-
"shouldFail": true
4599+
"section": "Images"
46014600
},
46024601
{
46034602
"markdown": "![foo ![bar](/url)](/url2)\n",
46044603
"html": "<p><img src=\"/url2\" alt=\"foo bar\" /></p>\n",
46054604
"example": 574,
46064605
"start_line": 8557,
46074606
"end_line": 8561,
4608-
"section": "Images",
4609-
"shouldFail": true
4607+
"section": "Images"
46104608
},
46114609
{
46124610
"markdown": "![foo [bar](/url)](/url2)\n",
46134611
"html": "<p><img src=\"/url2\" alt=\"foo bar\" /></p>\n",
46144612
"example": 575,
46154613
"start_line": 8564,
46164614
"end_line": 8568,
4617-
"section": "Images",
4618-
"shouldFail": true
4615+
"section": "Images"
46194616
},
46204617
{
46214618
"markdown": "![foo *bar*][]\n\n[foo *bar*]: train.jpg \"train & tracks\"\n",
46224619
"html": "<p><img src=\"train.jpg\" alt=\"foo bar\" title=\"train &amp; tracks\" /></p>\n",
46234620
"example": 576,
46244621
"start_line": 8578,
46254622
"end_line": 8584,
4626-
"section": "Images",
4627-
"shouldFail": true
4623+
"section": "Images"
46284624
},
46294625
{
46304626
"markdown": "![foo *bar*][foobar]\n\n[FOOBAR]: train.jpg \"train & tracks\"\n",
46314627
"html": "<p><img src=\"train.jpg\" alt=\"foo bar\" title=\"train &amp; tracks\" /></p>\n",
46324628
"example": 577,
46334629
"start_line": 8587,
46344630
"end_line": 8593,
4635-
"section": "Images",
4636-
"shouldFail": true
4631+
"section": "Images"
46374632
},
46384633
{
46394634
"markdown": "![foo](train.jpg)\n",
@@ -4697,8 +4692,7 @@
46974692
"example": 585,
46984693
"start_line": 8655,
46994694
"end_line": 8661,
4700-
"section": "Images",
4701-
"shouldFail": true
4695+
"section": "Images"
47024696
},
47034697
{
47044698
"markdown": "![Foo][]\n\n[foo]: /url \"title\"\n",
@@ -4730,8 +4724,7 @@
47304724
"example": 589,
47314725
"start_line": 8700,
47324726
"end_line": 8706,
4733-
"section": "Images",
4734-
"shouldFail": true
4727+
"section": "Images"
47354728
},
47364729
{
47374730
"markdown": "![[foo]]\n\n[[foo]]: /url \"title\"\n",

‎test/specs/gfm/commonmark.0.31.2.json‎

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4596,44 +4596,39 @@
45964596
"example": 573,
45974597
"start_line": 8548,
45984598
"end_line": 8554,
4599-
"section": "Images",
4600-
"shouldFail": true
4599+
"section": "Images"
46014600
},
46024601
{
46034602
"markdown": "![foo ![bar](/url)](/url2)\n",
46044603
"html": "<p><img src=\"/url2\" alt=\"foo bar\" /></p>\n",
46054604
"example": 574,
46064605
"start_line": 8557,
46074606
"end_line": 8561,
4608-
"section": "Images",
4609-
"shouldFail": true
4607+
"section": "Images"
46104608
},
46114609
{
46124610
"markdown": "![foo [bar](/url)](/url2)\n",
46134611
"html": "<p><img src=\"/url2\" alt=\"foo bar\" /></p>\n",
46144612
"example": 575,
46154613
"start_line": 8564,
46164614
"end_line": 8568,
4617-
"section": "Images",
4618-
"shouldFail": true
4615+
"section": "Images"
46194616
},
46204617
{
46214618
"markdown": "![foo *bar*][]\n\n[foo *bar*]: train.jpg \"train & tracks\"\n",
46224619
"html": "<p><img src=\"train.jpg\" alt=\"foo bar\" title=\"train &amp; tracks\" /></p>\n",
46234620
"example": 576,
46244621
"start_line": 8578,
46254622
"end_line": 8584,
4626-
"section": "Images",
4627-
"shouldFail": true
4623+
"section": "Images"
46284624
},
46294625
{
46304626
"markdown": "![foo *bar*][foobar]\n\n[FOOBAR]: train.jpg \"train & tracks\"\n",
46314627
"html": "<p><img src=\"train.jpg\" alt=\"foo bar\" title=\"train &amp; tracks\" /></p>\n",
46324628
"example": 577,
46334629
"start_line": 8587,
46344630
"end_line": 8593,
4635-
"section": "Images",
4636-
"shouldFail": true
4631+
"section": "Images"
46374632
},
46384633
{
46394634
"markdown": "![foo](train.jpg)\n",
@@ -4697,8 +4692,7 @@
46974692
"example": 585,
46984693
"start_line": 8655,
46994694
"end_line": 8661,
4700-
"section": "Images",
4701-
"shouldFail": true
4695+
"section": "Images"
47024696
},
47034697
{
47044698
"markdown": "![Foo][]\n\n[foo]: /url \"title\"\n",
@@ -4730,8 +4724,7 @@
47304724
"example": 589,
47314725
"start_line": 8700,
47324726
"end_line": 8706,
4733-
"section": "Images",
4734-
"shouldFail": true
4727+
"section": "Images"
47354728
},
47364729
{
47374730
"markdown": "![[foo]]\n\n[[foo]]: /url \"title\"\n",

‎test/types/marked.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ class ExtendedRenderer extends marked.Renderer {
104104
br = ({ type, raw }: Tokens.Br): string => super.br({ type, raw });
105105
del = ({ type, raw, text, tokens }: Tokens.Del): string => super.del({ type, raw, text, tokens });
106106
link = ({ type, raw, href, title, text, tokens }: Tokens.Link): string => super.link({ type, raw, href, title, text, tokens });
107-
image = ({ type, raw, href, title, text }: Tokens.Image): string => super.image({ type, raw, href, title, text });
107+
image = ({ type, raw, href, title, text }: Tokens.Image): string => super.image({ type, raw, href, title, text, tokens });
108108
}
109109

110110
const rendererOptions: MarkedOptions = renderer.options;

‎test/unit/Lexer.test.js‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1340,6 +1340,12 @@ paragraph
13401340
text: 'image',
13411341
href: 'https://example.com/image.png',
13421342
title: null,
1343+
tokens: [{
1344+
type: 'text',
1345+
raw: 'image',
1346+
text: 'image',
1347+
escaped: false,
1348+
}],
13431349
},
13441350
],
13451351
});
@@ -1355,6 +1361,12 @@ paragraph
13551361
text: 'image',
13561362
href: 'https://example.com/image.png',
13571363
title: 'title',
1364+
tokens: [{
1365+
type: 'text',
1366+
raw: 'image',
1367+
text: 'image',
1368+
escaped: false,
1369+
}],
13581370
},
13591371
],
13601372
});

‎test/unit/Parser.test.js‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -396,6 +396,12 @@ describe('Parser', () => {
396396
text: 'image',
397397
href: 'image.png',
398398
title: 'title',
399+
tokens: [{
400+
type: 'text',
401+
raw: 'image',
402+
text: 'image',
403+
escaped: false,
404+
}],
399405
},
400406
],
401407
html: '<img src="image.png" alt="image" title="title">',

‎test/unit/marked.test.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -959,6 +959,7 @@ br
959959
['space', ''],
960960
['paragraph', '![image](https://example.com/image.jpg)'],
961961
['image', '![image](https://example.com/image.jpg)'],
962+
['text', 'image'],
962963
['space', ''],
963964
['paragraph', '**strong**'],
964965
['strong', '**strong**'],

0 commit comments

Comments
 (0)