CLI deprecation warning

[tborychowski]

Marked version

5.0.1

Describe the bug

Since the last upgrade (from v4.x to 5.0.1) I'm seeing the following warnings:

marked(): mangle parameter is deprecated since version 5.0.0, should not be used and will be removed in the future. Instead use https://www.npmjs.com/package/marked-mangle.
marked(): headerIds and headerPrefix parameters are deprecated since version 5.0.0, should not be used and will be removed in the future. Instead use https://www.npmjs.com/package/marked-gfm-heading-id.

I don't use the js API, just run the CLI via npm scripts.

To Reproduce

This is the command I use: marked --gfm -i CHANGELOG.md -o changelog.html

Expected behavior

No warnings :-)

[UziTech]

In the release notes for v5.0.1 it explains why and what you can do about it.

[calculuschild]

@UziTech Perhaps the warning messages could be more clear on this:

marked(): mangle parameter is deprecated since version 5.0.0, should not be used and will be removed in the future. Note the "mangle" parameter is historically enabled by default, but can be manually disabled, or instead use https://www.npmjs.com/package/marked-mangle.

[UziTech]

Ya we tried to keep the warnings short.

[calculuschild]

Do you mind if I make a PR to add those extra words? I think it might be worth the added length if it gives our users a more clear indication of what's going on.

[UziTech]

Sounds good to me. 👍

[tborychowski]

Thanks @UziTech,

I modified the command, and these 2 did the trick:

marked --no-mangle --no-header-ids ...

[danielkrajnik]

How do you configure it so --no-mangle option is used by default? I've tried setting this option to false in src/default.js, but it didn't seem to pick it up on subsequent invocations.

[tborychowski]

@danielkrajnik
I use marked as CLI in scripts of my package.json, so I have sth like this:

"scripts": {
    "changelog": "marked --no-mangle --no-header-ids --gfm -i CHANGELOG.md -o docs/changelog.html"
}

[danielkrajnik]

thanks, sorry, I may be asking wrong question, but I'm trying to install marked.js globally and configure it's default behaviour - I was hoping that it reads configuration files from some standard directory like ~/.config/markedjs or /etc/markedjs .

As a temporary workaround I've edited marked.js directly, (marked.use({mangle:false}) , but it may get reverted on the next update.

Not sure if configuring globally installed npm modules is even possible?

[tborychowski]

can you not just add an alias in your shell? e.g.

alias md='marked --no-mangle --no-header-ids --gfm -i '

then you'd just use this like this:

md page.md -o page.html

[danielkrajnik]

You are right that this would work, putting it in .profile or /etc/profile would ensure that other programs would pick it up as well, but I hoped that npm had a dedicated place for these changes. It would make it easier to maintain it later on, because normally you expect all program-specific configuration to live inside .config, /etc or other standard locations. .bashrc/.zshrc is normally used only for "personal customisations" and this seems to be part of "application logic".

[UziTech]

@danielkrajnik PRs are always welcome 😁👍