Skip to content

[ESLint Plugin] Handles edge case for no-import-document-in-page rule #28261

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

Merged
merged 5 commits into from
Aug 25, 2021
Merged

[ESLint Plugin] Handles edge case for no-import-document-in-page rule #28261

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
44e098a
handle edge case for no-import-document rule
housseindjirdeh Aug 18, 2021
237ef66
Merge branch 'canary' into bug/#28200
ijjk Aug 19, 2021
a5bdcf4
Merge branch 'canary' into bug/#28200
kodiakhq[bot] Aug 19, 2021
adb3329
Merge remote-tracking branch 'upstream/canary' into bug/#28200
ijjk Aug 25, 2021
319fa27
Merge branch 'canary' into bug/#28200
ijjk Aug 25, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 4 additions & 11 deletions packages/eslint-plugin-next/lib/rules/no-document-import-in-page.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
const path = require('path')

module.exports = {
meta: {
docs: {
Expand All @@ -15,15 +13,10 @@ module.exports = {
return
}

const page = context.getFilename().split('pages')[1]
if (!page) {
return
}
const { name, dir } = path.parse(page)
if (
name.startsWith('_document') ||
(dir === '/_document' && name === 'index')
) {
const paths = context.getFilename().split('pages')
const page = paths[paths.length - 1]

if (!page || page.startsWith('/_document')) {
return
}

Expand Down
29 changes: 24 additions & 5 deletions test/unit/eslint-plugin-next/no-document-import-in-page.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,21 +84,40 @@ ruleTester.run('no-document-import-in-page', rule, {
`,
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:
'next/document should not be imported outside of pages/_document.js. See https://nextjs.org/docs/messages/no-document-import-in-page.',
type: 'ImportDeclaration',
},
],
},
],
invalid: [
{
code: `import Document from "next/document"

export const Test = () => (
<p>Test</p>
)
export const Test = () => <p>Test</p>
`,
filename: 'pages/test.js',
errors: [
Expand Down