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.

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

fix: fix this type in extension methods #3339

Merged
merged 2 commits into from
Jun 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
46 changes: 24 additions & 22 deletions src/Instance.ts
Original file line number Diff line number Diff line change
Expand Up @@ -259,28 +259,30 @@ export class Marked {
#convertRendererFunction(func: GenericRendererFunction, prop: string, renderer: _Renderer) {
switch (prop) {
case 'heading':
return function(token: Tokens.Heading) {
return function(this: _Renderer, token: Tokens.Heading) {
if (!token.type || token.type !== prop) {
// @ts-ignore
// eslint-disable-next-line prefer-rest-params
return func.apply(this, arguments);
}

return func(
return func.call(
this,
renderer.parser.parseInline(token.tokens),
token.depth,
unescape(renderer.parser.parseInline(token.tokens, renderer.parser.textRenderer))
);
};
case 'code':
return function(token: Tokens.Code) {
return function(this: _Renderer, token: Tokens.Code) {
if (!token.type || token.type !== prop) {
// @ts-ignore
// eslint-disable-next-line prefer-rest-params
return func.apply(this, arguments);
}

return func(
return func.call(
this,
token.text,
token.lang,
!!token.escaped
Expand Down Expand Up @@ -328,7 +330,7 @@ export class Marked {
body += this.tablerow({ text: cell });
}

return func(header, body);
return func.call(this, header, body);
};
case 'blockquote':
return function(this: _Renderer, token: Tokens.Blockquote) {
Expand All @@ -339,7 +341,7 @@ export class Marked {
}

const body = this.parser.parse(token.tokens);
return func(body);
return func.call(this, body);
};
case 'list':
return function(this: _Renderer, token: Tokens.List) {
Expand Down Expand Up @@ -391,17 +393,17 @@ export class Marked {
});
}

return func(body, ordered, start);
return func.call(this, body, ordered, start);
};
case 'html':
return function(token: Tokens.HTML) {
return function(this: _Renderer, token: Tokens.HTML) {
if (!token.type || token.type !== prop) {
// @ts-ignore
// eslint-disable-next-line prefer-rest-params
return func.apply(this, arguments);
}

return func(token.text, token.block);
return func.call(this, token.text, token.block);
};
case 'paragraph':
return function(this: _Renderer, token: Tokens.Paragraph) {
Expand All @@ -411,17 +413,17 @@ export class Marked {
return func.apply(this, arguments);
}

return func(this.parser.parseInline(token.tokens));
return func.call(this, this.parser.parseInline(token.tokens));
};
case 'escape':
return function(token: Tokens.Escape) {
return function(this: _Renderer, token: Tokens.Escape) {
if (!token.type || token.type !== prop) {
// @ts-ignore
// eslint-disable-next-line prefer-rest-params
return func.apply(this, arguments);
}

return func(token.text);
return func.call(this, token.text);
};
case 'link':
return function(this: _Renderer, token: Tokens.Link) {
Expand All @@ -431,17 +433,17 @@ export class Marked {
return func.apply(this, arguments);
}

return func(token.href, token.title, this.parser.parseInline(token.tokens));
return func.call(this, token.href, token.title, this.parser.parseInline(token.tokens));
};
case 'image':
return function(token: Tokens.Image) {
return function(this: _Renderer, token: Tokens.Image) {
if (!token.type || token.type !== prop) {
// @ts-ignore
// eslint-disable-next-line prefer-rest-params
return func.apply(this, arguments);
}

return func(token.href, token.title, token.text);
return func.call(this, token.href, token.title, token.text);
};
case 'strong':
return function(this: _Renderer, token: Tokens.Strong) {
Expand All @@ -451,7 +453,7 @@ export class Marked {
return func.apply(this, arguments);
}

return func(this.parser.parseInline(token.tokens));
return func.call(this, this.parser.parseInline(token.tokens));
};
case 'em':
return function(this: _Renderer, token: Tokens.Em) {
Expand All @@ -461,17 +463,17 @@ export class Marked {
return func.apply(this, arguments);
}

return func(this.parser.parseInline(token.tokens));
return func.call(this, this.parser.parseInline(token.tokens));
};
case 'codespan':
return function(token: Tokens.Codespan) {
return function(this: _Renderer, token: Tokens.Codespan) {
if (!token.type || token.type !== prop) {
// @ts-ignore
// eslint-disable-next-line prefer-rest-params
return func.apply(this, arguments);
}

return func(token.text);
return func.call(this, token.text);
};
case 'del':
return function(this: _Renderer, token: Tokens.Del) {
Expand All @@ -481,17 +483,17 @@ export class Marked {
return func.apply(this, arguments);
}

return func(this.parser.parseInline(token.tokens));
return func.call(this, this.parser.parseInline(token.tokens));
};
case 'text':
return function(token: Tokens.Text) {
return function(this: _Renderer, token: Tokens.Text) {
if (!token.type || token.type !== prop) {
// @ts-ignore
// eslint-disable-next-line prefer-rest-params
return func.apply(this, arguments);
}

return func(token.text);
return func.call(this, token.text);
};
default:
// do nothing
Expand Down
6 changes: 3 additions & 3 deletions src/MarkedOptions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,17 +36,17 @@ export type TokenizerAndRendererExtension = TokenizerExtension | RendererExtensi

type HooksApi = Omit<_Hooks, 'constructor' | 'options'>;
type HooksObject = {
[K in keyof HooksApi]?: (...args: Parameters<HooksApi[K]>) => ReturnType<HooksApi[K]> | Promise<ReturnType<HooksApi[K]>>
[K in keyof HooksApi]?: (this: _Hooks, ...args: Parameters<HooksApi[K]>) => ReturnType<HooksApi[K]> | Promise<ReturnType<HooksApi[K]>>
};

type RendererApi = Omit<_Renderer, 'constructor' | 'options' | 'parser'>;
type RendererObject = {
[K in keyof RendererApi]?: (...args: Parameters<RendererApi[K]>) => ReturnType<RendererApi[K]> | false
[K in keyof RendererApi]?: (this: _Renderer, ...args: Parameters<RendererApi[K]>) => ReturnType<RendererApi[K]> | false
};

type TokenizerApi = Omit<_Tokenizer, 'constructor' | 'options' | 'rules' | 'lexer'>;
type TokenizerObject = {
[K in keyof TokenizerApi]?: (...args: Parameters<TokenizerApi[K]>) => ReturnType<TokenizerApi[K]> | false
[K in keyof TokenizerApi]?: (this: _Tokenizer, ...args: Parameters<TokenizerApi[K]>) => ReturnType<TokenizerApi[K]> | false
};

export interface MarkedExtension {
Expand Down
21 changes: 19 additions & 2 deletions test/types/marked.ts
Original file line number Diff line number Diff line change
Expand Up @@ -136,9 +136,9 @@ marked.use({ renderer }, { tokenizer });

marked.use({
renderer: {
heading({ text, depth }) {
heading({ tokens, depth }) {
if (depth > 3) {
return `<p>${text}</p>`;
return `<p>${this.parser.parseInline(tokens)}</p>`;
}

return false;
Expand All @@ -149,6 +149,20 @@ marked.use({
}
},
tokenizer: {
heading(src) {
const cap = this.rules.block.heading.exec(src);
if (cap) {
let text = cap[2].trim();

return {
type: 'heading',
raw: cap[0],
depth: cap[1].length,
text,
tokens: this.lexer.inline(text)
};
}
},
codespan(src) {
const match = src.match(/\$+([^\$\n]+?)\$+/);
if (match) {
Expand Down Expand Up @@ -317,6 +331,9 @@ marked.use({ tokenizer: new Tokenizer() });
marked.use({
hooks: {
preprocess(markdown) {
if (this.options.async) {
return Promise.resolve(markdown);
}
return markdown;
},
postprocess(html) {
Expand Down