← Back to rules

nextjs/no-document-import-in-page Correctness

它的作用

阻止在 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;

如何使用

To enable this rule using the config file or in the CLI, you can use:

Config (.oxlintrc.json)

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

Config (oxlint.config.ts)

import { defineConfig } from "oxlint";

export default defineConfig({
  plugins: ["nextjs"],
  rules: {
    "nextjs/no-document-import-in-page": "error",
  },
});

CLI

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

版本

此规则于 v0.2.1 中添加。

参考资料

• Rule Source
• Open rule in Oxc Playground