Skip to content

Commit c38704c

Browse files
authored
fix: await promise arrays from walkTokens extensions (#4153)
* fix: await promise arrays from walkTokens extensions * fix: declare promise arrays for walkTokens extensions
1 parent 1f1b480 commit c38704c

4 files changed

Lines changed: 69 additions & 3 deletions

File tree

‎src/Instance.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -280,7 +280,7 @@ export class Marked<ParserOutput = string, RendererOutput = string> {
280280
const packWalktokens = pack.walkTokens;
281281
opts.walkTokens = function(token) {
282282
const values: MaybePromise[] = [];
283-
values.push(packWalktokens.call(this, token));
283+
pushValues(values, packWalktokens.call(this, token));
284284
if (walkTokens) {
285285
pushValues(values, walkTokens.call(this, token));
286286
}

‎src/MarkedOptions.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,9 +109,9 @@ export interface MarkedExtension<ParserOutput = string, RendererOutput = string>
109109
* The walkTokens function gets called with every token.
110110
* Child tokens are called before moving on to sibling tokens.
111111
* Each token is passed by reference so updates are persisted when passed to the parser.
112-
* The return value of the function is ignored.
112+
* When async is true, returned promises, including arrays of promises, are awaited before parsing.
113113
*/
114-
walkTokens?: ((token: Token) => void | Promise<void>) | null;
114+
walkTokens?: ((token: Token) => void | Promise<void> | (void | Promise<void>)[]) | null;
115115
}
116116

117117
export interface MarkedOptions<ParserOutput = string, RendererOutput = string> extends Omit<MarkedExtension<ParserOutput, RendererOutput>, 'hooks' | 'renderer' | 'tokenizer' | 'extensions' | 'walkTokens'> {

‎test/types/walk-tokens.ts‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
import { marked, Marked } from 'marked';
2+
import type { MarkedExtension } from 'marked';
3+
4+
// Compile against the public declarations, including contextual token typing.
5+
const extension: MarkedExtension = {
6+
async: true,
7+
walkTokens(token) {
8+
return [
9+
Promise.resolve().then(() => {
10+
if (token.type === 'text') {
11+
token.text = token.text.toUpperCase();
12+
}
13+
}),
14+
undefined,
15+
];
16+
},
17+
};
18+
19+
marked.use(extension);
20+
const parser = new Marked(extension);
21+
parser.use({
22+
async: true,
23+
walkTokens(token) {
24+
return [Promise.resolve().then(() => {
25+
token.raw = token.raw.trim();
26+
})];
27+
},
28+
});
29+
30+
marked.use({ walkTokens: () => [] });
31+
marked.use({ walkTokens: () => undefined });
32+
marked.use({ walkTokens: () => Promise.resolve() });
33+
34+
const block: Promise<string> = marked.parse('text', { async: true });
35+
const inline: Promise<string> = parser.parseInline('text', { async: true });
36+
await Promise.all([block, inline]);

‎test/unit/marked.test.js‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1184,6 +1184,36 @@ br
11841184
assert.strictEqual(html, new Marked().parse('| A | B |\n|---|---|\n| C | D |\n\n- E\n - *F*\n\n> G\n'));
11851185
});
11861186

1187+
it('should flatten arrays returned by composed walkTokens extensions', () => {
1188+
const first = Promise.resolve();
1189+
const second = Promise.resolve();
1190+
marked.use(
1191+
{ walkTokens: () => [first] },
1192+
{ walkTokens: () => [second] },
1193+
);
1194+
1195+
assert.deepEqual(
1196+
marked.walkTokens([{ type: 'text', raw: 'text', text: 'text' }], marked.defaults.walkTokens),
1197+
[second, first],
1198+
);
1199+
});
1200+
1201+
it('should await promise arrays returned by walkTokens extensions', async() => {
1202+
marked.use({
1203+
async: true,
1204+
walkTokens(token) {
1205+
if (token.type === 'text') {
1206+
return [timeout().then(() => {
1207+
token.text = token.text.toUpperCase();
1208+
})];
1209+
}
1210+
},
1211+
});
1212+
1213+
assert.strictEqual(await marked.parse('before'), '<p>BEFORE</p>\n');
1214+
assert.strictEqual(await marked.parseInline('before'), 'BEFORE');
1215+
});
1216+
11871217
it('should copy returned arrays by index like concat', async() => {
11881218
const tokens = marked.lexer('before');
11891219
const pending = timeout().then(() => {

0 commit comments

Comments
 (0)