← Back to rules

nextjs/no-document-import-in-page 正确性

它的作用

禁止在 pages/_document.js 之外导入 next/document。

为什么这是不好的？

在 pages/_document.js 之外导入 next/document 可能会导致你的 Next.js 应用出现意外问题。

示例

此规则的 错误 代码示例：

// `components/MyDocument.jsx`
import Document from "next/document";

class MyDocument extends Document {
  //...
}

export default MyDocument;

此规则的 正确 代码示例：

// `pages/_document.jsx`
import Document from "next/document";

class MyDocument extends Document {
  //...
}

export default MyDocument;

如何使用

要通过配置文件或 CLI 启用 此规则，可以使用：

配置文件 (.oxlintrc.json)

{
  "plugins": ["nextjs"],
  "rules": {
    "nextjs/no-document-import-in-page": "error"
  }
}

CLI

oxlint --deny nextjs/no-document-import-in-page --nextjs-plugin

参考资料

• 规则源码