eslint-plugin-nextjs-rules

Some nifty Next.js ESLint rules

Installation

You'll first need to install ESLint:

``sh
npm i eslint --save-dev
`

Next, install eslint-plugin-nextjs-rules:

`sh
npm install eslint-plugin-nextjs-rules --save-dev
`

Usage

Add eslint-plugin-nextjs-rules to the plugins section of your .eslintrc configuration file.

`json
{
"plugins": ["eslint-plugin-nextjs-rules"]
}
`

Then configure the rules you want to use under the rules table further down in this ReadMe

`javascript
// .eslintrc
module.exports = {
plugins: [..., "nextjs-rules", ...],
rules: {
...
"nextjs-rules/no-get-server-side-props": [
"error",
{
files: [
// pages where you don't want getServerSideProps() used at all
${__dirname}/src/pages/index.tsx,
${__dirname}/src/pages/something-went-wrong.tsx,
${__dirname}/src/pages/our-products/[product].tsx,
${__dirname}/src/pages/faq/index.tsx
]
}
]
...
}
}
`

Rules

This table is generated by eslint-doc-generator

| Name                     | Description |
| :----------------------------------------------------------------- | :------------------------------------------------------------------------------------------------- |
| no-get-server-side-props | Disallow usage of getServerSideProps` method in a given list of files to enforce static rendering |