markedjs / marked

A markdown parser and compiler. Built for speed.
https://marked.js.org
Other
33.23k stars 3.39k forks source link

[Suggestion] Provide Escaping Options in Lexer #3491

Closed Bistard closed 1 week ago

Bistard commented 1 month ago

Describe the feature Is it possible to provide an option in the lexer, like enableEscaping: boolean; that controls the lexer should turn any characters (e.g. &, <, > etc) into escaping characters (e.g. &amp;, &lt;, &gt; etc).

const tokens = marked.lexer(text, {
    enableEscaping: false,
});

Why is this feature necessary?

  1. For example, when I get a token like {type: 'codespan', raw: '<h1>', text: '&lt;h1&gt;'}. I wish to display the text normally. I have to use extra calculations like regular expressions to turn &lt;h1&gt; back to <h1>.
  2. But this is essentially just undoing the process during the first time (default tokenizer in marked) which caused meaningless extra calculations.
  3. So my suggestion is to provide an option that prevents the escaping process in the first place inside the default lexer.

Describe alternatives you've considered I saw the issue answered in 2022 said I have to override the tokenizer to achieve this.

UziTech commented 1 month ago

I noticed this a little bit ago. I am working on moving the escaping to the renderers instead of the tokenizers.

The Tokenizers should just pull the information out of the markdown and create tokens without changing it, then the renderers should handle any changes like HTML escaping.

Bistard commented 1 month ago

Your proposal seems better and more logical.

Even though I’m only using the tokenizer and not the renderer in my case, do you still plan to make HTML escaping optional inside the renderer?

UziTech commented 1 month ago

No. The default renderers will always escape since that follows the CommonMark spec but they can be overridden

Bistard commented 1 month ago

Got it.