[feat] support linting markdown syntaxes like eslint-plugin-mdx via remark-lint

[JounQin]

context: mdx-js/eslint-mdx#283 (comment)

related codes:

https://github.com/mdx-js/eslint-mdx/blob/master/packages/eslint-plugin-mdx/src/rules/remark.ts
https://github.com/mdx-js/eslint-mdx/blob/master/packages/eslint-plugin-mdx/src/processors/remark.ts

[btmills]

Can you describe the problem that you're trying to solve in detail?

[JounQin]

eslint-plugin-markdown now only lints code blocks, markdown content can be linted too by integrating with remark-lint in a single tool ESLint.

[btmills]

So right now you have two tools, ESLint that lints JS and ```js code blocks inside Markdown files and remark-lint that lints all the Markdown content around the code blocks. You want to have a single tool so that running eslint . would report results from both ESLint and remark-lint rules. Is that correct? If so, doesn't eslint-plugin-mdx's remark rule already do that?

[JounQin]

If so, doesn't eslint-plugin-mdx's remark rule already do that?

Yes, it does. But as @wooorm suggested at mdx-js/eslint-mdx#283 (comment), he thinks linting markdown content should belong eslint-plugin-markdown, which sounds reasonable to me. If you add remark-lint support here, I can remove it from eslint-plugin-mdx then.

[JounQin]

Here is a related plugin wants this function too.
https://github.com/leo-buneev/eslint-plugin-md

[JounQin]

@btmills Any idea?

[Airkro]

Just in my own preference is, keep the status quo.

Use eslint-plugin-markdown for js code block in markdown.

I prefer using remark-lint directly. Or Create a new plugin like eslint-plugin-remark.

[JounQin]

@Airkro

ESLint is much beyond for js syntaxes, it'll be the universal linter for all languages.

eslint/rfcs#56

And this feature can be optional.

eslint-plugin-markdown is all for markdown, it should include markdown syntaxes linting IMO.

[JounQin]

I was thinking about eslint-plugin-remark too, but eslint-plugin-mdx has already supported it actually, and integration here is preferred.

I just want to migrate it from mdx to markdown instead.

[Airkro]

It's an "easy way or right way" problem.

What if some people don't want to use remark-lint in eslint?
What if someone prefers markdownlint to remark-lint?

[JounQin]

@Airkro

And this feature can be optional.

And this package is using remark inside already.

[Airkro]

@JounQin

It's not about package size, some people just don't like remark rules, or maybe they have some special rule/plugin that requires a different remark version.

[Airkro]

My selfish opinion is "one plugin do one thing" might solve these problem. for reference only.

[Airkro]

Because remark is really powerful, many people have special rules/plugins.

A standalone eslint-plugin-remark might be better.

[JounQin]

It's not about package size, some people just don't like remark rules

I'm not talking about it too. And I've said several times that And this feature can be optional.

Just a new option/setting or just a new rule is needed to specific whether to enable remark-lint in eslint-plugin-markdown. And it can be disabled by default.

My selfish opinion is "one plugin do one thing" might solve these problem. for reference only.

That's OK, but IMO markdown syntaxes is the thing for eslint-plugin-markdown considering the generic ASTs in ESLint's future.

[btmills]

Thanks for the discussion above. This plugin has always focused on linting code in fenced code blocks. The back story is that I built it to exercise ESLint's processor API. Going beyond that to lint portions other than fenced code blocks would be a significant expansion of scope. That's a wonderful opportunity for other plugins to offer users the choice of exactly how they want to lint their Markdown files. This plugin doesn't need to be a single all-encompassing solution for Markdown linting.

[JounQin]

That's OK.

[GitMurf]

Is it now 2 years later and is there still not a great option for eslint markdown plugin other than the mdx plugin (which has some issues)? It is a bummer that the plugin named eslint-plugin-markdown (which I thought was exactly what I wanted haha) doesn't actually lint markdown syntax and just lints JS codeblocks within a markdown file (if I am understanding it correctly)? We all know naming things is the hardest part of coding ;-) but I agree with @JounQin that it would be very nice if this plugin linted markdown as well. And if not, I wonder if the plugin could change names to something like eslint-plugin-md-code or something like that? I was very confused for a while when trying to get eslint-plugin-markdown to work when I finally realized it only lints fenced code blocks. If anyone has any good advice or recommendations for a good eslint markdown setup (integrated with Prettier so rules don't overlap), would be greatly appreciated.

[JounQin]

is there still not a great option for eslint markdown plugin other than the mdx plugin (which has some issues)?

@GitMurf If you have any issue, you should post a new issue with reproduction instead of talking about it outside so that as the plugin author, me, doesn't know it at all?