Unverified Commit 22206651 authored by Gal Schlezinger's avatar Gal Schlezinger Committed by GitHub

[eslint-plugin-next] remove `no-server-import-in-page` rule (#38028)

This rule was good and kinda made sense when we had nested Middleware.
Now that we have a single Middleware, one might extract logic into different places
and I don't think we should limit importing `NextResponse` or `NextRequest`.

## Related

- Closes #36239
- Closes #37309



## Bug

- [x] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Errors have helpful link attached, see `contributing.md`
parent d57342a9
......@@ -98,7 +98,6 @@ Next.js provides an ESLint plugin, [`eslint-plugin-next`](https://www.npmjs.com/
| ✔️ | [@next/next/no-img-element](/docs/messages/no-img-element.md) | Prevent usage of `<img>` element to prevent layout shift. |
| ✔️ | [@next/next/no-page-custom-font](/docs/messages/no-page-custom-font.md) | Prevent page-only custom fonts. |
| ✔️ | [@next/next/no-script-component-in-head](/docs/messages/no-script-component-in-head.md) | Prevent usage of `next/script` in `next/head` component. |
| ✔️ | [@next/next/no-server-import-in-page](/docs/messages/no-server-import-in-page.md) | Prevent usage of `next/server` outside of `middleware.js`. |
| ✔️ | [@next/next/no-styled-jsx-in-document](/docs/messages/no-styled-jsx-in-document.md) | Prevent usage of `styled-jsx` in `pages/_document.js`. |
| ✔️ | [@next/next/no-sync-scripts](/docs/messages/no-sync-scripts.md) | Prevent synchronous scripts. |
| ✔️ | [@next/next/no-title-in-document-head](/docs/messages/no-title-in-document-head.md) | Prevent usage of `<title>` with `Head` component from `next/document`. |
......
......@@ -14,7 +14,6 @@ module.exports = {
'no-img-element': require('./rules/no-img-element'),
'no-page-custom-font': require('./rules/no-page-custom-font'),
'no-script-component-in-head': require('./rules/no-script-component-in-head'),
'no-server-import-in-page': require('./rules/no-server-import-in-page'),
'no-styled-jsx-in-document': require('./rules/no-styled-jsx-in-document'),
'no-sync-scripts': require('./rules/no-sync-scripts'),
'no-title-in-document-head': require('./rules/no-title-in-document-head'),
......@@ -45,7 +44,6 @@ module.exports = {
'@next/next/no-document-import-in-page': 'error',
'@next/next/no-duplicate-head': 'error',
'@next/next/no-head-import-in-document': 'error',
'@next/next/no-server-import-in-page': 'error',
'@next/next/no-script-component-in-head': 'error',
},
},
......
const path = require('path')
const url = 'https://nextjs.org/docs/messages/no-server-import-in-page'
const middlewareRegExp = new RegExp(`^middleware\\.(?:t|j)s$`)
module.exports = {
meta: {
docs: {
description: 'Prevent usage of `next/server` outside of `middleware.js`.',
recommended: true,
url,
},
},
create: function (context) {
return {
ImportDeclaration(node) {
if (node.source.value !== 'next/server') {
return
}
const filename = context.getFilename()
if (middlewareRegExp.test(path.basename(filename))) {
return
}
context.report({
node,
message: `\`next/server\` should not be used outside of \`middleware.js\`. See: ${url}`,
})
},
}
},
}
import { RuleTester } from 'eslint'
import path from 'path'
import rule from '@next/eslint-plugin-next/lib/rules/no-server-import-in-page'
;(RuleTester as any).setDefaultConfig({
parserOptions: {
ecmaVersion: 2018,
sourceType: 'module',
ecmaFeatures: {
modules: true,
jsx: true,
},
},
})
const ruleTester = new RuleTester()
const errors = [
{
message:
'`next/server` should not be used outside of `middleware.js`. See: https://nextjs.org/docs/messages/no-server-import-in-page',
type: 'ImportDeclaration',
},
]
ruleTester.run('no-server-import-in-page', rule, {
valid: [
{
code: `import { NextFetchEvent, NextRequest } from "next/server"
export function middleware(req, ev) {
return new Response('Hello, world!')
}
`,
filename: 'middleware.js',
},
{
code: `import { NextFetchEvent, NextRequest } from "next/server"
export function middleware(req, ev) {
return new Response('Hello, world!')
}
`,
filename: `${path.sep}middleware.js`,
},
{
code: `import { NextFetchEvent, NextRequest } from "next/server"
export function middleware(req, ev) {
return new Response('Hello, world!')
}
`,
filename: `middleware.ts`,
},
{
code: `import NextDocument from "next/document"
export function middleware(req, ev) {
return new Response('Hello, world!')
}
`,
filename: `${path.posix.sep}middleware.tsx`,
},
{
code: `import { NextFetchEvent, NextRequest } from "next/server"
export function middleware(req, ev) {
return new Response('Hello, world!')
}
`,
filename: path.join('ws', 'vercel-front/front/middleware.ts'),
},
],
invalid: [
{
code: `import { NextFetchEvent, NextRequest } from "next/server"
export const Test = () => <p>Test</p>
`,
filename: 'components/test.js',
errors,
},
{
code: `import { NextFetchEvent, NextRequest } from "next/server"
export const Test = () => <p>Test</p>
`,
filename: 'pages/test.js',
errors,
},
{
code: `import { NextFetchEvent, NextRequest } from "next/server"
export const Test = () => <p>Test</p>
`,
filename: `pages${path.sep}test.js`,
errors,
},
{
code: `import { NextFetchEvent, NextRequest } from "next/server"
export function middleware(req, ev) {
return new Response('Hello, world!')
}
`,
filename: 'middleware.page.tsx',
errors,
},
],
})
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment