-
Notifications
You must be signed in to change notification settings - Fork 79
docs: add migration docs #559
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
base: main
Are you sure you want to change the base?
Conversation
This change adds a new migration.md file where details about major migrations can be documented. The first section is details about migrating from the previous implementation `eslint-plugin-markdown`.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @michaelfaith, could you take a look at the CI failures?
The failure related to the Markdown document will be resolved once we add the following line:
<!-- eslint-disable-line -- This should be fixed in https://github.com/eslint/markdown/issues/294 -->
markdown/docs/rules/no-bare-urls.md
Lines 14 to 18 in 868153b
## Rule Details | |
> [!IMPORTANT] <!-- eslint-disable-line -- This should be fixed in https://github.com/eslint/markdown/issues/294 --> | |
> | |
> This rule requires `language: "markdown/gfm"`. |
The Bun CI failure should be resolved once #555 is merged.
(If this PR needs to be merged quickly, it can be resolved by adding @types/unist
, @types/mdast
, and semver
to the dev dependencies.)
Thanks! I made those updates |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for working on this issue! The migration guide looks good.
However, I noticed a few things missing, so I've left some comments throughout the documentation.
Thanks for the feedback. I believe I've addressed everything. Let me know if there are any other updates you'd recommend. |
docs/migration.md
Outdated
}, | ||
extends: ["js/recommended"], | ||
}, | ||
markdown.configs.recommended, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We're encouraging people to use extends
now:
markdown.configs.recommended, | |
{ | |
files: ["**/*.md"], | |
plugins: { | |
markdown | |
}, | |
extends: ["markdown/recommended"] | |
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sounds good. And that's the case even for configs that already declare files
and plugins
in the configs?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks!
Would like @nzakas and others to verify before merging.
Prerequisites checklist
What changes did you make? (Give an overview)
This change adds a new migration.md file where details about major migrations can be documented. The first section is details about migrating from the previous implementation
eslint-plugin-markdown
.fixes #517