docs: fix malformed eslint
config comments in rule examples
#18078
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
What is the purpose of this pull request? (put an "X" next to an item)
[x] Documentation update
[x] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:
Tell us about your environment (
npx eslint --env-info
):Node version: v21.6.0
npm version: v10.2.4
Local ESLint version: v9.0.0-alpha.2 (Currently used)
Global ESLint version: Not found
Operating System: darwin 23.3.0
What parser are you using (place an "X" next to just one item)?
[X]
Default (Espree)
[ ]
@typescript-eslint/parser
[ ]
@babel/eslint-parser
[ ]
vue-eslint-parser
[ ]
@angular-eslint/template-parser
[ ]
Other
Please show your full configuration:
Configuration
What did you do? Please include the actual source code causing the issue.
/* eslint mentioned in this comment */
What did you expect to happen?
Block comments starting with
eslint
are treated as configuration comments for rules. When ESLint cannot parse them as such, it reports a fatal error (repro).This fatal error should not be allowed to occur in rule examples because it makes the example code unparsable even if the syntax is correct. It should be caught by the tool that validates rule examples (tools/check-rule-examples.js).
What actually happened? Please include the actual, raw output from ESLint.
A rule example with a malformed
eslint
config comment can pass validation. We have two such examples inlines-around-comment
, both fixed in this PR.What changes did you make? (Give an overview)
lines-around-comment
by replacingeslint
withjshint
- another special word that doesn't trigger the rule.eslint
config comments when validating code.Is there anything you'd like reviewers to focus on?