Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: typo in flat config setup instructions #184

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: typo in flat config setup instructions #184

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5ce06ff
docs: flat config setup typo in README.md
patrykszwed Nov 27, 2024
06ca9dc
docs: update README.md
patrykszwed Jan 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ If you are using [flat config style](https://eslint.org/docs/latest/use/configur
export default [
// ...
{
// Inside your .eslintignore file
// Inside your flat config file
Copy link
Member

@yannbf yannbf Jan 2, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

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

Copy link
Author

Choose a reason for hiding this comment

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

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!

ignores: ['!.storybook'],
},
]
Expand Down