docs: don't pass filename when linting rule examples#19571
Merged
Conversation
✅ Deploy Preview for docs-eslint canceled.
|
Contributor
There are some settings with behavior/defaults based on how TypeScript interprets the file extension: i.e. https://typescript-eslint.io/packages/parser/#ecmafeatures. We'd have to dig more internally to get a specific answer but it's not uncommon for edge cases in syntax like |
JoshuaKGoldberg
approved these changes
Mar 24, 2025
Contributor
|
The CI / Types (eslint-webpack-plugin) check is failing. |
Member
Author
Yeah, it's failing on |
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
3 participants
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
[ ] 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:
While reviewing #19493, I noticed that the docs site code that lints rule examples for the purpose of underlining errors gets a parsing error when checking TypeScript examples of correct code added in that PR. On the other hand,
tools/check-rule-examples.jsparses the same code successfully. The difference turned out to be that the former passesfilename: "code.js"tolinter.verify()whereas the latter doesn't.What changes did you make? (Give an overview)
Removed
filename: "code.js"from thelinter.verify()call used for underlining errors.Is there anything you'd like reviewers to focus on?
This fixes the problem, though I don't understand why it makes a difference for the typescript-eslint parser.