docs: typo in flat config setup instructions #184
+1
−2
Conversation
This file contains 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
yannbf
reviewed
Jan 2, 2025
README.md
Outdated
Comment on lines
65
to
68
| export default [ | ||
| // ... | ||
| { | ||
| // Inside your .eslintignore file | ||
| // Inside your flat config file |
There was a problem hiding this comment.
The original comment is actually correct, it's meant to match the content specified in the .eslintignore file, as stated in a few sentences above
There was a problem hiding this comment.
Oh, I see. Personally, I found that a little bit confusing as the comment refers to the .eslintignore file which is no longer supported in ESLint 9. I've just pushed one more commit with changes that may make it more clear that if one uses a flat configuration file, it's enough to only put it there. Feel free to close the PR if you disagree though
btw, thanks for maintaining this package!
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.
What Changed
Updated flat config setup instructions. The instruction itself seems to work fine but that comment might be misleading - it references
.eslintignorewhile one's editing a flat config file.Checklist
Check the ones applicable to your change:
pnpm run update-allChange Type
Indicate the type of change your pull request is:
maintenancedocumentationpatchminormajor