Skip to content

perf(linter): nextjs/no-document-import-in-page check the filepath before running the rule #11962

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
graphite-app merged 1 commit into from
Jun 29, 2025
Merged

perf(linter): nextjs/no-document-import-in-page check the filepath before running the rule #11962

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 12 additions & 7 deletions crates/oxc_linter/src/rules/nextjs/no_document_import_in_page.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,12 @@ use oxc_diagnostics::OxcDiagnostic;
use oxc_macros::declare_oxc_lint;
use oxc_span::Span;

use crate::{AstNode, context::LintContext, rule::Rule, utils::is_document_page};
use crate::{
AstNode,
context::{ContextHost, LintContext},
rule::Rule,
utils::is_document_page,
};

fn no_document_import_in_page_diagnostic(span: Span) -> OxcDiagnostic {
OxcDiagnostic::warn("`<Document />` from `next/document` should not be imported outside of `pages/_document.js`. See: https://nextjs.org/docs/messages/no-document-import-in-page").with_help("Prevent importing `next/document` outside of `pages/_document.js`.").with_label(span)
Expand Down Expand Up @@ -46,15 +51,15 @@ impl Rule for NoDocumentImportInPage {
return;
}

ctx.diagnostic(no_document_import_in_page_diagnostic(import_decl.span));
}

fn should_run(&self, ctx: &ContextHost) -> bool {
let Some(path) = ctx.file_path().to_str() else {
return;
return false;
};

if is_document_page(path) {
return;
}

ctx.diagnostic(no_document_import_in_page_diagnostic(import_decl.span));
!is_document_page(path)
}
}

Expand Down
Loading