Skip to content

docs: typo in flat config setup instructions #184

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

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 all commits
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
3 changes: 1 addition & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,13 +59,12 @@ This allows for this plugin to also lint your configuration files inside the .st

> For more info on why this line is required in the .eslintignore file, check this [ESLint documentation](https://eslint.org/docs/latest/use/configure/ignore-deprecated#:~:text=In%20addition%20to,contents%20are%20ignored).
Copy link
Member

Choose a reason for hiding this comment

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

nit: to make sure that the legacy/flat config snippets stay side by side,

  • I would move this callout and the paragraph before, to place them after the flat config example
  • I would rework the wording to say "For more info on why this line is required in the .eslintignore file or the ignores object, ..."


If you are using [flat config style](https://eslint.org/docs/latest/use/configure/configuration-files-new), add this to your configuration file:
If you are using [flat config style](https://eslint.org/docs/latest/use/configure/configuration-files-new), add this to your configuration file instead:

```js
export default [
// ...
{
// Inside your .eslintignore file
ignores: ['!.storybook'],
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
ignores: ['!.storybook'],
// Replaces your .eslintignore file
ignores: ['!.storybook'],

Copy link
Member

Choose a reason for hiding this comment

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

It may be worth reminding people that ignores comes instead of eslintignore.

},
]
Expand Down