Request : Add file path and line number to make MarkedPlugin error messages more friendly.

[MasatoMakino]

Search Terms

error message, getHighlighted, markedOptions, highlight

Problem

Currently, the error messages of the getHighlighted function of MarkedPlugin.ts do not show the file path and line number of the file where the error occurred. So users need a lot of time to identify the cause of the error message.

Suggested Solution

Currently, getHighlighted generates the following error messages

typedoc/src/lib/output/plugins/MarkedPlugin.ts

Lines 109 to 121 in 315bd25

	public getHighlighted(text: string, lang?: string): string {
	lang = lang || "typescript";
	lang = lang.toLowerCase();
	if (!isSupportedLanguage(lang)) {
	// Extra newline because of the progress bar
	this.application.logger.warn(
	`\nUnsupported highlight language "${lang}" will not be highlighted. Run typedoc --help for a list of supported languages.`
	);
	return text;
	}
	return highlight(text, lang, this.theme);
	}

Unsupported highlight language "{language type}" will not be highlighted. Run typedoc --help for a list of supported languages.

The following information will be added to this message.

This code block is in line n of "path/to/file".

[Gerrit0]

This is a good idea 👍

[Gerrit0]

Resolved by #1561