From 21db74bc3f04dbe7fb711def0a32fe7af21d55b1 Mon Sep 17 00:00:00 2001 From: kaykdm Date: Thu, 11 Jan 2024 21:43:50 +0900 Subject: [PATCH] feat(linter): implement @next/next/no-document-import-in-page --- crates/oxc_linter/src/rules.rs | 2 + .../nextjs/no_document_import_in_page.rs | 218 ++++++++++++++++++ .../snapshots/no_document_import_in_page.snap | 41 ++++ 3 files changed, 261 insertions(+) create mode 100644 crates/oxc_linter/src/rules/nextjs/no_document_import_in_page.rs create mode 100644 crates/oxc_linter/src/snapshots/no_document_import_in_page.snap diff --git a/crates/oxc_linter/src/rules.rs b/crates/oxc_linter/src/rules.rs index b62e15af977dee..d4029f4456356b 100644 --- a/crates/oxc_linter/src/rules.rs +++ b/crates/oxc_linter/src/rules.rs @@ -282,6 +282,7 @@ mod nextjs { pub mod no_assign_module_variable; pub mod no_async_client_component; pub mod no_css_tags; + pub mod no_document_import_in_page; pub mod no_head_import_in_document; pub mod no_img_element; pub mod no_script_component_in_head; @@ -543,4 +544,5 @@ oxc_macros::declare_all_lint_rules! { nextjs::no_script_component_in_head, nextjs::no_sync_scripts, nextjs::no_title_in_document_head, + nextjs::no_document_import_in_page, } diff --git a/crates/oxc_linter/src/rules/nextjs/no_document_import_in_page.rs b/crates/oxc_linter/src/rules/nextjs/no_document_import_in_page.rs new file mode 100644 index 00000000000000..c5f66483f5c23f --- /dev/null +++ b/crates/oxc_linter/src/rules/nextjs/no_document_import_in_page.rs @@ -0,0 +1,218 @@ +use oxc_ast::{ast::ModuleDeclaration, AstKind}; +use oxc_diagnostics::{ + miette::{self, Diagnostic}, + thiserror::Error, +}; +use oxc_macros::declare_oxc_lint; +use oxc_span::Span; + +use crate::{context::LintContext, rule::Rule, AstNode}; + +#[derive(Debug, Error, Diagnostic)] +#[error("eslint-plugin-next(no-document-import-in-page): `` from `next/document` should not be imported outside of `pages/_document.js`. See: https://nextjs.org/docs/messages/no-document-import-in-page")] +#[diagnostic( + severity(warning), + help("Prevent importing `next/document` outside of `pages/_document.js`.") +)] +struct NoDocumentImportInPageDiagnostic(#[label] pub Span); + +#[derive(Debug, Default, Clone)] +pub struct NoDocumentImportInPage; + +declare_oxc_lint!( + /// ### What it does + /// Prevent importing `next/document` outside of `pages/_document.js`. + /// + /// ### Why is this bad? + /// + /// + /// ### Example + /// ```javascript + /// ``` + NoDocumentImportInPage, + correctness +); + +impl Rule for NoDocumentImportInPage { + fn run<'a>(&self, node: &AstNode<'a>, ctx: &LintContext<'a>) { + let AstKind::ModuleDeclaration(ModuleDeclaration::ImportDeclaration(import_decl)) = + node.kind() + else { + return; + }; + + if import_decl.source.value.as_str() != "next/document" { + return; + } + + if let Some(path) = ctx.file_path().to_str() { + if let Some(page) = path.split("pages").last() { + if !page.starts_with("/_document") && !page.starts_with("\\_document") { + ctx.diagnostic(NoDocumentImportInPageDiagnostic(import_decl.span)); + } + } + } + } +} + +#[test] +fn test() { + use crate::tester::Tester; + use std::path::PathBuf; + + let pass = vec![ + ( + r#"import Document from "next/document" + + export default class MyDocument extends Document { + render() { + return ( + + + ); + } + } + "#, + None, + None, + Some(PathBuf::from("pages/_document.tsx")), + ), + ( + r#"import Document from "next/document" + + export default class MyDocument extends Document { + render() { + return ( + + + ); + } + } + "#, + None, + None, + Some(PathBuf::from("pages/_document.tsx")), + ), + ( + r#"import NextDocument from "next/document" + + export default class MyDocument extends NextDocument { + render() { + return ( + + + ); + } + } + "#, + None, + None, + Some(PathBuf::from("pages/_document.tsx")), + ), + ( + r#"import Document from "next/document" + + export default class MyDocument extends Document { + render() { + return ( + + + ); + } + } + "#, + None, + None, + Some(PathBuf::from("pages/_document.tsx")), + ), + ( + r#"import NDocument from "next/document" + + export default class Document extends NDocument { + render() { + return ( + + + ); + } + } + "#, + None, + None, + Some(PathBuf::from("pages/_document.tsx")), + ), + ( + r#"import NDocument from "next/document" + + export default class Document extends NDocument { + render() { + return ( + + + ); + } + } + "#, + None, + None, + Some(PathBuf::from("pages/_document.tsx")), + ), + ( + r#"import Document from "next/document" + + export default class MyDocument extends Document { + render() { + return ( + + + ); + } + } + "#, + None, + None, + Some(PathBuf::from("src/pages/_document.tsx")), + ), + ]; + + let fail = vec![ + ( + r#"import Document from "next/document" + + export const Test = () =>

Test

+ "#, + None, + None, + Some(PathBuf::from("pages/test.tsx")), + ), + ( + r#"import Document from "next/document" + + export const Test = () =>

Test

+ "#, + None, + None, + Some(PathBuf::from("pages/test.tsx")), + ), + ( + r#"import Document from "next/document" + + export const Test = () =>

Test

+ "#, + None, + None, + Some(PathBuf::from("src/pages/user/test.tsx")), + ), + ( + r#"import Document from "next/document" + + export const Test = () =>

Test

+ "#, + None, + None, + Some(PathBuf::from("src/pages/user/_document.tsx")), + ), + ]; + + Tester::new_with_settings(NoDocumentImportInPage::NAME, pass, fail).test_and_snapshot(); +} diff --git a/crates/oxc_linter/src/snapshots/no_document_import_in_page.snap b/crates/oxc_linter/src/snapshots/no_document_import_in_page.snap new file mode 100644 index 00000000000000..4872eb617718c8 --- /dev/null +++ b/crates/oxc_linter/src/snapshots/no_document_import_in_page.snap @@ -0,0 +1,41 @@ +--- +source: crates/oxc_linter/src/tester.rs +expression: no_document_import_in_page +--- + ⚠ eslint-plugin-next(no-document-import-in-page): `` from `next/document` should not be imported outside of `pages/_document.js`. See: https://nextjs.org/docs/messages/no-document- + │ import-in-page + ╭─[no_document_import_in_page.tsx:1:1] + 1 │ import Document from "next/document" + · ──────────────────────────────────── + 2 │ + ╰──── + help: Prevent importing `next/document` outside of `pages/_document.js`. + + ⚠ eslint-plugin-next(no-document-import-in-page): `` from `next/document` should not be imported outside of `pages/_document.js`. See: https://nextjs.org/docs/messages/no-document- + │ import-in-page + ╭─[no_document_import_in_page.tsx:1:1] + 1 │ import Document from "next/document" + · ──────────────────────────────────── + 2 │ + ╰──── + help: Prevent importing `next/document` outside of `pages/_document.js`. + + ⚠ eslint-plugin-next(no-document-import-in-page): `` from `next/document` should not be imported outside of `pages/_document.js`. See: https://nextjs.org/docs/messages/no-document- + │ import-in-page + ╭─[no_document_import_in_page.tsx:1:1] + 1 │ import Document from "next/document" + · ──────────────────────────────────── + 2 │ + ╰──── + help: Prevent importing `next/document` outside of `pages/_document.js`. + + ⚠ eslint-plugin-next(no-document-import-in-page): `` from `next/document` should not be imported outside of `pages/_document.js`. See: https://nextjs.org/docs/messages/no-document- + │ import-in-page + ╭─[no_document_import_in_page.tsx:1:1] + 1 │ import Document from "next/document" + · ──────────────────────────────────── + 2 │ + ╰──── + help: Prevent importing `next/document` outside of `pages/_document.js`. + +