Skip to content

Repo: enable eslint-plugin-mdx for linting .mdx files #11213

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.

Sign up for GitHub

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

Jump to bottom
Open
JounQin opened this issue May 14, 2025 · 5 comments
Open

Repo: enable eslint-plugin-mdx for linting .mdx files #11213

JounQin opened this issue May 14, 2025 · 5 comments
Labels
awaiting response Issues waiting for a reply from the OP or another party repo maintenance things to do with maintenance of the repo, and not with code/docs triage Waiting for team members to take a look

Comments

@JounQin
Copy link
Contributor

JounQin commented May 14, 2025

Suggestion

As title, it works perfectly with other plugins like eslint-plugin-react, and we could(not a requirement) also drop markdown-lint in this case, see also #3223.

Additional Info

No response
@JounQin JounQin added triage Waiting for team members to take a look repo maintenance things to do with maintenance of the repo, and not with code/docs labels May 14, 2025
@JoshuaKGoldberg
Copy link
Member

How does this interact with #3223?

@JoshuaKGoldberg JoshuaKGoldberg added awaiting response Issues waiting for a reply from the OP or another party and removed triage Waiting for team members to take a look labels May 14, 2025
@JounQin
Copy link
Contributor Author

JounQin commented May 14, 2025 •
edited
Loading

How does this interact with #3223?

It depends on your choice, I can split into two PRs, one for .mdx itself, one for markdown syntax via remark-lint. Or use remark-lint-cli just like markdown-lint. I'd vote for eslint-plugin-mdx + remark-lint integration for single cli tool: eslint.

@JoshuaKGoldberg
Copy link
Member

+1, I also vote for just the one tool. The fewer commands & tools we use, the better! ⚡

Also relevant: #11204

@JounQin
Copy link
Contributor Author

JounQin commented May 14, 2025

@JoshuaKGoldberg So what would be the next steps then? Should I split into two PRs, one for .mdx itself, one for markdown syntax via remark-lint but integrated with eslint-plugin-mdx?

@JoshuaKGoldberg JoshuaKGoldberg added the triage Waiting for team members to take a look label May 14, 2025
@JoshuaKGoldberg
Copy link
Member

Let's say wait a few business days to see if anybody else on @typescript-eslint/triage-team wants to give input, then if nothing changes, one PR?

We normally prefer granular PRs when multiple things are in play, but these are so interconnected that that would be harder than normal here. Plus I don't think we have a huge amount of Markdown linting configuration.

@JounQin JounQin mentioned this issue May 18, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
awaiting response Issues waiting for a reply from the OP or another party repo maintenance things to do with maintenance of the repo, and not with code/docs triage Waiting for team members to take a look
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@JoshuaKGoldberg @JounQin