Skip to content

docs: add eslint to install command - #685

Merged
nzakas merged 1 commit into
eslint:mainfrom
KumJungMin:docs/install-guide
Jul 17, 2026
Merged

nzakas merged 1 commit into
eslint:mainfrom
KumJungMin:docs/install-guide

Conversation

@KumJungMin

@KumJungMin KumJungMin commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Prerequisites checklist

AI acknowledgment

  • I did not use AI to generate this PR.
  • (If the above is not checked) I have reviewed the AI-generated content before submitting.

What is the purpose of this pull request?

The @eslint/markdown package does not declare eslint as a peer dependency.
As a result, users may assume that installing @eslint/markdown will 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 install eslint before 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?

@linux-foundation-easycla

linux-foundation-easycla Bot commented Jul 17, 2026

Copy link
Copy Markdown

CLA Signed
The committers listed above are authorized under a signed CLA.

  • ✅ login: KumJungMin / name: KumJungMin (eefbfca)

@eslintbot eslintbot added this to Triage Jul 17, 2026
@github-project-automation github-project-automation Bot moved this to Needs Triage in Triage Jul 17, 2026

@nzakas nzakas left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM. Thanks.

@nzakas
nzakas merged commit 435f667 into eslint:main Jul 17, 2026
40 checks passed
@github-project-automation github-project-automation Bot moved this from Needs Triage to Complete in Triage Jul 17, 2026
@KumJungMin
KumJungMin deleted the docs/install-guide branch July 17, 2026 13:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Complete

Development

Successfully merging this pull request may close these issues.

3 participants