Skip to content
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

Jump to bottom

feat(lint): add noDocumentImportInPage rule #4265

Merged
merged 3 commits into from
Oct 13, 2024
Merged

feat(lint): add noDocumentImportInPage rule #4265

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
146cc88
feat(lint): add `noDocumentImportInPage` rule
kaioduarte Oct 12, 2024
70b1977
Update crates/biome_js_analyze/src/lint/nursery/no_document_import_in…
kaioduarte Oct 13, 2024
d82e847
update CHANGELOG.md
kaioduarte Oct 13, 2024
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
10 changes: 10 additions & 0 deletions crates/biome_cli/src/execute/migrate/eslint_any_rule_to_biome.rs
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

188 changes: 104 additions & 84 deletions crates/biome_configuration/src/analyzer/linter/rules.rs
View file
Open in desktop

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions crates/biome_diagnostics_categories/src/categories.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,7 @@ define_categories! {
"lint/nursery/noConsole": "https://biomejs.dev/linter/rules/no-console",
"lint/nursery/noDescendingSpecificity": "https://biomejs.dev/linter/rules/no-descending-specificity",
"lint/nursery/noDocumentCookie": "https://biomejs.dev/linter/rules/no-document-cookie",
"lint/nursery/noDocumentImportInPage": "https://biomejs.dev/linter/rules/no-document-import-in-page",
"lint/nursery/noDoneCallback": "https://biomejs.dev/linter/rules/no-done-callback",
"lint/nursery/noDuplicateAtImportRules": "https://biomejs.dev/linter/rules/no-duplicate-at-import-rules",
"lint/nursery/noDuplicateCustomProperties": "https://biomejs.dev/linter/rules/no-duplicate-custom-properties",
Expand Down
2 changes: 2 additions & 0 deletions crates/biome_js_analyze/src/lint/nursery.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ use biome_analyze::declare_lint_group;

pub mod no_common_js;
pub mod no_document_cookie;
pub mod no_document_import_in_page;
pub mod no_duplicate_else_if;
pub mod no_dynamic_namespace_import_access;
pub mod no_enum;
Expand Down Expand Up @@ -42,6 +43,7 @@ declare_lint_group! {
rules : [
self :: no_common_js :: NoCommonJs ,
self :: no_document_cookie :: NoDocumentCookie ,
self :: no_document_import_in_page :: NoDocumentImportInPage ,
self :: no_duplicate_else_if :: NoDuplicateElseIf ,
self :: no_dynamic_namespace_import_access :: NoDynamicNamespaceImportAccess ,
self :: no_enum :: NoEnum ,
Expand Down
95 changes: 95 additions & 0 deletions crates/biome_js_analyze/src/lint/nursery/no_document_import_in_page.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
use biome_analyze::{
context::RuleContext, declare_lint_rule, Ast, Rule, RuleDiagnostic, RuleSource, RuleSourceKind,
};
use biome_console::markup;
use biome_js_syntax::{JsFileSource, JsImport};
use biome_rowan::AstNode;

declare_lint_rule! {
/// 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>
/// )
/// }
/// }
/// ```
///
pub NoDocumentImportInPage {
version: "next",
name: "noDocumentImportInPage",
language: "jsx",
sources: &[RuleSource::EslintNext("no-document-import-in-page")],
source_kind: RuleSourceKind::SameLogic,
recommended: false,
}
}

impl Rule for NoDocumentImportInPage {
type Query = Ast<JsImport>;
type State = ();
type Signals = Option<Self::State>;
type Options = ();

fn run(ctx: &RuleContext<Self>) -> Self::Signals {
if !ctx.source_type::<JsFileSource>().is_jsx() {
return None;
}

let import = ctx.query();
let import_source = import.import_clause().ok()?.source().ok()?;
let module_name = import_source.inner_string_text().ok()?;

if module_name != "next/document" {
return None;
}

let path = ctx.file_path();

if !path
.ancestors()
.filter_map(|a| a.file_name())
.any(|f| f == "pages")
{
return None;
}

let file_name = path.file_stem()?.to_str()?;
let parent_name = path.parent()?.file_stem()?.to_str()?;

if parent_name == "_document" || file_name == "_document" {
return None;
}

Some(())
}

fn diagnostic(ctx: &RuleContext<Self>, _: &Self::State) -> Option<RuleDiagnostic> {
return Some(
RuleDiagnostic::new(
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You might want to explain the users why this error occurs ( See Rule pllars in this case.
In eslint-plugin-next/no-document-import-in-page, they are not explaining why the error is triggered but providing the link Why This Error Occurred.
We could add an explanation IMHO.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The explanation in their link is pretty vague 😅

"to avoid unexpected behaviors" was the best I could extract from it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, Next.js documentation is usually bad 😔

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree

rule_category!(),
ctx.query().range(),
markup! {
"Don't use "<Emphasis>"next/document"</Emphasis>" outside of pages/_document.jsx to avoid unexpected behaviors."
},
)
.note(markup! {
"Only import "<Emphasis>"next/document"</Emphasis>" within "<Emphasis>"pages/_document.jsx"</Emphasis>" to customize the global document structure."
})
);
}
}
1 change: 1 addition & 0 deletions crates/biome_js_analyze/src/options.rs
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions crates/biome_js_analyze/tests/specs/nursery/noDocumentImportInPage/app/valid.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
import Document from "next/document";
9 changes: 9 additions & 0 deletions crates/biome_js_analyze/tests/specs/nursery/noDocumentImportInPage/app/valid.jsx.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
source: crates/biome_js_analyze/tests/spec_tests.rs
assertion_line: 86
expression: valid.jsx
---
# Input
```jsx
import Document from "next/document";
```
1 change: 1 addition & 0 deletions crates/biome_js_analyze/tests/specs/nursery/noDocumentImportInPage/pages/_document.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
import Document from "next/document";
9 changes: 9 additions & 0 deletions crates/biome_js_analyze/tests/specs/nursery/noDocumentImportInPage/pages/_document.jsx.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
source: crates/biome_js_analyze/tests/spec_tests.rs
assertion_line: 86
expression: _document.jsx
---
# Input
```jsx
import Document from "next/document";
```
1 change: 1 addition & 0 deletions crates/biome_js_analyze/tests/specs/nursery/noDocumentImportInPage/pages/invalid.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
import Document from "next/document";
23 changes: 23 additions & 0 deletions crates/biome_js_analyze/tests/specs/nursery/noDocumentImportInPage/pages/invalid.jsx.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
source: crates/biome_js_analyze/tests/spec_tests.rs
assertion_line: 86
expression: invalid.jsx
---
# Input
```jsx
import Document from "next/document";
```

# Diagnostics
```
invalid.jsx:1:1 lint/nursery/noDocumentImportInPage ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

! Don't use next/document outside of pages/_document.jsx to avoid unexpected behaviors.

> 1 │ import Document from "next/document";
│ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

i Only import next/document within pages/_document.jsx to customize the global document structure.


```
1 change: 1 addition & 0 deletions crates/biome_js_analyze/tests/specs/nursery/noDocumentImportInPage/valid.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
import Document from "next/document";
9 changes: 9 additions & 0 deletions crates/biome_js_analyze/tests/specs/nursery/noDocumentImportInPage/valid.jsx.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
source: crates/biome_js_analyze/tests/spec_tests.rs
assertion_line: 86
expression: valid.jsx
---
# Input
```jsx
import Document from "next/document";
```
5 changes: 5 additions & 0 deletions packages/@biomejs/backend-jsonrpc/src/workspace.ts
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 7 additions & 0 deletions packages/@biomejs/biome/configuration_schema.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.