Skip to content

Conversation

michaelfaith
Copy link

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

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`.
@eslintbot eslintbot added this to Triage Oct 12, 2025
@github-project-automation github-project-automation bot moved this to Needs Triage in Triage Oct 12, 2025
@michaelfaith michaelfaith marked this pull request as ready for review October 12, 2025 19:59
@aladdin-add aladdin-add moved this from Needs Triage to Implementing in Triage Oct 14, 2025
Copy link
Member

@lumirlumir lumirlumir left a 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 -->

## 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.)

@michaelfaith
Copy link
Author

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 -->

## 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

Copy link
Member

@lumirlumir lumirlumir left a 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.

@michaelfaith
Copy link
Author

Thanks for the feedback. I believe I've addressed everything. Let me know if there are any other updates you'd recommend.

},
extends: ["js/recommended"],
},
markdown.configs.recommended,
Copy link
Member

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:

Suggested change
markdown.configs.recommended,
{
files: ["**/*.md"],
plugins: {
markdown
},
extends: ["markdown/recommended"]
}

Copy link
Author

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?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated

Copy link
Member

@lumirlumir lumirlumir left a 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.

@lumirlumir lumirlumir moved this from Implementing to Second Review Needed in Triage Oct 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Second Review Needed

Development

Successfully merging this pull request may close these issues.

Docs: When updating from eslint-plugin-markdown other plugins start throwing errors

4 participants