Skip to content

Commit 1aab6d5

Browse files
authored
Merge pull request #87 from deini/readme
chore(common): document usage with next
2 parents cdc47fd + 8334e8e commit 1aab6d5

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

packages/eslint-config/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,19 @@ running CI with:
3737
eslint --max-warnings 0
3838
```
3939

40+
## Usage with Next.js
41+
42+
Make sure to also extend from next's `core-web-vitals`.
43+
44+
```js
45+
// .eslintrc.js
46+
require('@bigcommerce/eslint-config/patch');
47+
48+
module.exports = {
49+
extends: ['@bigcommerce/eslint-config', 'next/core-web-vitals'],
50+
};
51+
```
52+
4053
## Release
4154

4255
Please refer to the documentation of [lerna](https://github.com/lerna/lerna) for release options.

0 commit comments

Comments
 (0)