markedjs / marked-mangle Goto Github PK

What pain point are you perceiving?.
Even when including @types/marked, including marked-mangle doesn't support TypeScript.

Describe the solution you'd like
As Marked migrates to TypeScript, so should these new Marked support libraries. As they are small projects and the main project will remove the @types/marked dependency, I would request the migration route to reduce the need to add two packages per package.

Using marked-mangle exactly as in the instructions causes "JS heap out of memory" error.
I'm running this code in a unit test with Vitest.

New:

import { marked } from "marked";
import { mangle } from "marked-mangle";

...

marked.use(mangle());
const inlineHtml = marked.parse(latestComment);

As a first-time user of this library coming from a warning displayed by marked, I want to know what the purpose of this package is.

The readme states:

Mangle mailto links with HTML character references.

However, I don't have any understanding of why one would want to do this. What purpose does this serve? Why would anyone choose to opt into using this?

I would suggest adding a sentence to the README like:

Mangling mailto links is useful when ...