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

Jump to bottom

[ESLint] Adds section to docs for migrating existing ESLint configurations #26101

Merged
merged 2 commits into from
Jun 14, 2021
Merged

[ESLint] Adds section to docs for migrating existing ESLint configurations #26101

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1d74ccd
adds section to docs for migrating existing eslint configurations
housseindjirdeh Jun 14, 2021
1b90f24
Merge branch 'canary' into eslint-update-4
kodiakhq[bot] Jun 14, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
15 changes: 15 additions & 0 deletions docs/basic-features/eslint.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,3 +148,18 @@ A stricter `next/core-web-vitals` rule set can also be added in `.eslintrc`:
`next/core-web-vitals` updates `eslint-plugin-next` to error on a number of rules that are warnings by default if they affect [Core Web Vitals](https://web.dev/vitals/).

> Both `next` and `next/core-web-vitals` entry points are automatically included for new applications built with [Create Next App](/docs/api-reference/create-next-app.md).

## Migrating Existing Config

If you already have ESLint configured in your application, we recommend extending directly from the Next.js ESLint plugin instead of the shareable configuration.

```js
module.exports = {
extends: [
//...
'plugin:@next/next/recommended',
],
}
```

This eliminates any risk of collisions that can occur due to importing the same plugin or parser across multiple configurations.