73b473991c
Follow-up on https://github.com/vercel/next.js/pull/38534#pullrequestreview-1035020450 This lets us use modern JS/TS syntax in ESLint rules and avoid issues like #38530 and #36693 ## Bug - [ ] Related issues linked using `fixes #number` - [ ] Integration tests added - [ ] Errors have helpful link attached, see `contributing.md` ## Feature - [ ] Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR. - [ ] Related issues linked using `fixes #number` - [ ] Integration tests added - [ ] Documentation added - [ ] Telemetry added. In case of a feature if it's used or not. - [ ] Errors have helpful link attached, see `contributing.md` ## Documentation / Examples - [ ] Make sure the linting passes by running `pnpm lint` - [ ] The examples guidelines are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing.md#adding-examples) Co-authored-by: JJ Kasper <22380829+ijjk@users.noreply.github.com>
162 lines
3.5 KiB
TypeScript
162 lines
3.5 KiB
TypeScript
import path from 'path'
|
|
|
|
import rule from '@next/eslint-plugin-next/dist/rules/no-document-import-in-page'
|
|
import { RuleTester } from 'eslint'
|
|
;(RuleTester as any).setDefaultConfig({
|
|
parserOptions: {
|
|
ecmaVersion: 2018,
|
|
sourceType: 'module',
|
|
ecmaFeatures: {
|
|
modules: true,
|
|
jsx: true,
|
|
},
|
|
},
|
|
})
|
|
const ruleTester = new RuleTester()
|
|
|
|
ruleTester.run('no-document-import-in-page', rule, {
|
|
valid: [
|
|
{
|
|
code: `import Document from "next/document"
|
|
|
|
export default class MyDocument extends Document {
|
|
render() {
|
|
return (
|
|
<Html>
|
|
</Html>
|
|
);
|
|
}
|
|
}
|
|
`,
|
|
filename: 'pages/_document.js',
|
|
},
|
|
{
|
|
code: `import Document from "next/document"
|
|
|
|
export default class MyDocument extends Document {
|
|
render() {
|
|
return (
|
|
<Html>
|
|
</Html>
|
|
);
|
|
}
|
|
}
|
|
`,
|
|
filename: `pages${path.sep}_document.js`,
|
|
},
|
|
{
|
|
code: `import NextDocument from "next/document"
|
|
|
|
export default class MyDocument extends NextDocument {
|
|
render() {
|
|
return (
|
|
<Html>
|
|
</Html>
|
|
);
|
|
}
|
|
}
|
|
`,
|
|
filename: `pages${path.posix.sep}_document.tsx`,
|
|
},
|
|
{
|
|
code: `import Document from "next/document"
|
|
|
|
export default class MyDocument extends Document {
|
|
render() {
|
|
return (
|
|
<Html>
|
|
</Html>
|
|
);
|
|
}
|
|
}
|
|
`,
|
|
filename: 'pages/_document.page.tsx',
|
|
},
|
|
{
|
|
code: `import NDocument from "next/document"
|
|
|
|
export default class Document extends NDocument {
|
|
render() {
|
|
return (
|
|
<Html>
|
|
</Html>
|
|
);
|
|
}
|
|
}
|
|
`,
|
|
filename: 'pages/_document/index.js',
|
|
},
|
|
{
|
|
code: `import NDocument from "next/document"
|
|
|
|
export default class Document extends NDocument {
|
|
render() {
|
|
return (
|
|
<Html>
|
|
</Html>
|
|
);
|
|
}
|
|
}
|
|
`,
|
|
filename: 'pages/_document/index.tsx',
|
|
},
|
|
{
|
|
code: `import Document from "next/document"
|
|
|
|
export default class MyDocument extends Document {
|
|
render() {
|
|
return (
|
|
<Html>
|
|
</Html>
|
|
);
|
|
}
|
|
}
|
|
`,
|
|
filename: 'pagesapp/src/pages/_document.js',
|
|
},
|
|
],
|
|
invalid: [
|
|
{
|
|
code: `import Document from "next/document"
|
|
|
|
export const Test = () => <p>Test</p>
|
|
`,
|
|
filename: 'components/test.js',
|
|
errors: [
|
|
{
|
|
message:
|
|
'`<Document />` from `next/document` should not be imported outside of `pages/_document.js`. See: https://nextjs.org/docs/messages/no-document-import-in-page',
|
|
type: 'ImportDeclaration',
|
|
},
|
|
],
|
|
},
|
|
{
|
|
code: `import Document from "next/document"
|
|
|
|
export const Test = () => <p>Test</p>
|
|
`,
|
|
filename: 'pages/test.js',
|
|
errors: [
|
|
{
|
|
message:
|
|
'`<Document />` from `next/document` should not be imported outside of `pages/_document.js`. See: https://nextjs.org/docs/messages/no-document-import-in-page',
|
|
type: 'ImportDeclaration',
|
|
},
|
|
],
|
|
},
|
|
{
|
|
code: `import Document from "next/document"
|
|
|
|
export const Test = () => <p>Test</p>
|
|
`,
|
|
filename: `pages${path.sep}test.js`,
|
|
errors: [
|
|
{
|
|
message:
|
|
'`<Document />` from `next/document` should not be imported outside of `pages/_document.js`. See: https://nextjs.org/docs/messages/no-document-import-in-page',
|
|
type: 'ImportDeclaration',
|
|
},
|
|
],
|
|
},
|
|
],
|
|
})
|