Back to Biomejs

noDocumentImportInPage

src/content/docs/linter/rules/no-document-import-in-page.mdx

latest1.8 KB
Original Source

import { Tabs, TabItem } from '@astrojs/starlight/components';

<Tabs> <TabItem label="JSX and TSX" icon="seti:javascript"> ## Summary - Rule available since: `v1.9.4` - Diagnostic Category: [`lint/suspicious/noDocumentImportInPage`](/reference/diagnostics#diagnostic-category) - This rule is **recommended**, meaning it is enabled by default. - This rule doesn't have a fix. - The default severity of this rule is [**warning**](/reference/diagnostics#warning). - This rule belongs to the following domains: - [`next`](/linter/domains#next) - Sources: - Same as [`@next/next/no-document-import-in-page`](https://nextjs.org/docs/messages/no-document-import-in-page)

How to configure

json
{
	"linter": {
		"rules": {
			"suspicious": {
				"noDocumentImportInPage": "error"
			}
		}
	}
}

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

jsx
import { Document, Html } from 'next/document'

export default class MyDocument extends Document {
  render() {
    return (
      <Html lang="en">
      </Html>
    )
  }
}
</TabItem> </Tabs>