noDocumentImportInPage

JSX and TSX

Summary

Rule available since: v1.9.4
Diagnostic Category: lint/nursery/noDocumentImportInPage
This rule doesn’t have a fix.
The default severity of this rule is information.
This rule belongs to the following domains:
- next
Sources:
- Same as @next/no-document-import-in-page

Description

Prevents importing next/document outside of pages/_document.jsx in Next.js projects.

The next/document module is intended for customizing the document structure globally in Next.js. Importing it outside of pages/_document.js can cause unexpected behavior and break certain features of the framework.

Examples

Valid

1
import { Document, Html } from 'next/document'
2

3
export default class MyDocument extends Document {
4
  render() {
5
    return (
6
      <Html lang="en">
7
        {/* */}
8
      </Html>
9
    )
10
  }
11
}

How to configure

1
{
2
  "linter": {
3
    "rules": {
4
      "nursery": {
5
        "noDocumentImportInPage": "error"
6
      }
7
    }
8
  }
9
}