8000 migrate from `markdownlint` to `remark-lint` · Issue #3223 · typescript-eslint/typescript-eslint · GitHub
[go: up one dir, main page]
Skip to content

migrate from markdownlint to remark-lint #3223

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 Mar 24, 2021 · 9 comments
Open

migrate from markdownlint to remark-lint #3223

JounQin opened this issue Mar 24, 2021 · 9 comments
Labels
accepting prs Go ahead, send a pull request that resolves this issue repo maintenance things to do with maintenance of the repo, and not with code/docs

Comments

@JounQin
Copy link
Contributor
JounQin commented Mar 24, 2021
  1. remark-lint is much more pluggable than markdownlint.
  2. It can be integrated with eslint via esling-plugin-mdx (Don't worry, markdown is also supported).
  3. It will never conflict with prettier via remark-preset-prettier
@JounQin JounQin added package: eslint-plugin-tslint Issues related to @typescript-eslint/eslint-plugin-tslint triage Waiting for team members to take a look labels Mar 24, 2021
@armano2 armano2 added enhancement New feature or request repo maintenance things to do with maintenance of the repo, and not with code/docs and removed triage Waiting for team members to take a look package: eslint-plugin-tslint Issues related to @typescript-eslint/eslint-plugin-tslint labels Mar 24, 2021
@JounQin
Copy link
Contributor Author
JounQin commented Mar 24, 2021

If you agree to migrate, I'll raise a PR then.

@bradzacher
Copy link
Member
bradzacher commented Mar 29, 2021 •
edited
Loading

I'm not sure about remark-lint because the IDE plugin isn't maintained.
The last commit to the repo was 3 years ago.

@bradzacher bradzacher removed the enhancement New feature or request label Mar 29, 2021
@JounQin
Copy link
Contributor Author
JounQin commented Mar 30, 2021

Because of eslint-plugin-mdx, it's easy to be integrated with vscode-eslint.

@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Dec 30, 2021
Open
@JoshuaKGoldberg JoshuaKGoldberg added the accepting prs Go ahead, send a pull request that resolves this issue label Feb 25, 2022
@JoshuaKGoldberg
Copy link
Member

🤷 might as well try it out, I'm down

@JoshuaKGoldberg JoshuaKGoldberg added documentation Documentation ("docs") that needs adding/updating and removed documentation Documentation ("docs") that needs adding/updating labels Feb 25, 2022
@JoshuaKGoldberg
Copy link
Member
JoshuaKGoldberg commented Nov 20, 2022 •
edited
Loading

Well, I tried 🤷 #6052 -> remarkjs/remark#1071. Blocked on Docusaurus supporting MDX 2.

Edit: in other words, Docusaurus v3.

Edit edit: #7872

@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Nov 21, 2022
Closed
3 tasks
@JoshuaKGoldberg JoshuaKGoldberg added the blocked by external API Blocked by a tool we depend on exposing an API, such as TypeScript's Type Relationship API label Nov 21, 2022
@JoshuaKGoldberg JoshuaKGoldberg removed the accepting prs Go ahead, send a pull request that resolves this issue label Oct 20, 2023
@JoshuaKGoldberg JoshuaKGoldberg added accepting prs Go ahead, send a pull request that resolves this issue and removed blocked by external API Blocked by a tool we depend on exposing an API, such as TypeScript's Type Relationship API labels May 31, 2024
@JoshuaKGoldberg
Copy link
Member
JoshuaKGoldberg commented May 31, 2024 •
edited
Loading

Docusaurus v3 has been out for a while and we onboarded to it a couple months ago in #7872 -> #8209. Marking this issue as accepting PRs!

@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue May 12, 2025
Open
@JoshuaKGoldberg
Copy link
Member
JoshuaKGoldberg commented May 12, 2025 •
edited
Loading

ESLint has a first-party Markdown linting plugin now: @eslint/markdown <- https://eslint.org/blog/2024/10/eslint-json-markdown-support/. eslint/markdown#316 tracks it supporting MDX linting. I'd think it makes the most sense to use the first-party solution if possible, no?

Proposal: let's retarget this issue (or file a new one) for using @eslint/markdown instead?

@JounQin JounQin mentioned this issue May 14, 2025
Open
@JounQin
Copy link
Contributor Author
JounQin commented May 14, 2025 •
edited
Loading

Proposal: let's retarget this issue (or file a new one) for using @eslint/markdown instead?

@JoshuaKGoldberg I believe @eslint/markdown has few rules than remark-link, and mdx support is just on the roadmap, it's not that easy in my experience.

@JoshuaKGoldberg
Copy link
Member

👍 Makes sense, thanks. I'm on board for switching to remark-lint in the meantime. Moving to @eslint/markdown can just be blocked on mdx support.

@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
accepting prs Go ahead, send a pull request that resolves this issue repo maintenance things to do with maintenance of the repo, and not with code/docs
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@armano2 @JoshuaKGoldberg @bradzacher @JounQin
0