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

Accept Micromark config in lint options #1455

Open
farnabaz opened this issue Dec 20, 2024 · 1 comment
Open

Accept Micromark config in lint options #1455

farnabaz opened this issue Dec 20, 2024 · 1 comment
Labels

Comments

@farnabaz
Copy link

Currently, we can extend MarkdownIt using options.markdownItPlugins, but it is not possible to pass extensions to micromark.

It would be great to provide an option to pass Micromark extensions and configs to extend it

@DavidAnson
Copy link
Owner

I was wondering when this might come up. :)

I’d prefer not to support custom micromark plugins if I don’t have to because that adds complexity and maintenance overhead and is tied to a specific parser. I don’t see significant use of markdownItPlugins across all of GitHub (see query below), and have been taking the approach of incorporating common micromark extensions by default.

What is your scenario? What micromark extension are you looking to add?

--

Here’s a quick GitHub query I did to filters out clones and forks of my code:

https://github.com/search?q=markdownlint+AND+markdownItPlugins+NOT+path%3A.md+NOT+path%3A.d.ts+NOT+path%3A.d.mts+NOT+path%3A.html+NOT+path%3Atest+NOT+path%3Amarkdownlint-browser+NOT+path%3Aconfig-schema+NOT+path%3Amarkdownlint.js+NOT+path%3Amarkdownlint.mjs+NOT+path%3Amarkdownlint-cli2.js+NOT+path%3Amarkdownit.cjs+NOT+path%3Atype-check.ts+NOT+path%3Aextension.js+NOT+markdownlint-rule-sample&type=code&p=1

As far as I can tell, there’s just one repo that MIGHT be using this feature (and I don’t see evidence it actually is):

https://github.com/diplodoc-platform/transform/blob/5bf44fd28a48f00f4cdcfa9fc75d3180bf11d157/src/transform/yfmlint/index.ts

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants