docs: add eslint to install command - #685
Merged
Merged
Conversation
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Prerequisites checklist
AI acknowledgment
What is the purpose of this pull request?
The
@eslint/markdownpackage does not declareeslintas a peer dependency.As a result, users may assume that installing
@eslint/markdownwill also install ESLint, but ESLint must actually be installed separately in order to use the plugin.The existing installation instructions only include
@eslint/markdown, which may cause new users to miss a required dependency. To prevent this, the documentation now instructs users to installeslintbefore installing@eslint/markdown.What changes did you make? (Give an overview)
Updated the installation instructions for @eslint/markdown to clarify that eslint must be installed separately before installing the plugin, consistent with the change made in eslint/json#258.
Related Issues
Is there anything you'd like reviewers to focus on?