-
-
Notifications
You must be signed in to change notification settings - Fork 864
feat(biome_js_analyze): port noHtmlLinkForPages from Next.js
#8698
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.
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
Closed
Closed
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| --- | ||
| "@biomejs/biome": patch | ||
| --- | ||
|
|
||
| Added the nursery rule [`noHtmlLinkForPages`](https://biomejs.dev/linter/rules/no-html-link-for-pages/) to the Next.js domain. | ||
| This rule prevents usage of `<a>` elements to navigate to internal Next.js pages. | ||
|
|
||
| The following code is invalid: | ||
|
|
||
| ```jsx | ||
| export const Page = () => { | ||
| return ( | ||
| <div> | ||
| <a href='/about'>About</a> | ||
| </div> | ||
| ); | ||
| } | ||
| ``` |
12 changes: 12 additions & 0 deletions
12
crates/biome_cli/src/execute/migrate/eslint_any_rule_to_biome.rs
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
151 changes: 151 additions & 0 deletions
151
crates/biome_js_analyze/src/lint/nursery/no_html_link_for_pages.rs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,151 @@ | ||
| use biome_analyze::{ | ||
| Ast, Rule, RuleDiagnostic, RuleDomain, RuleSource, context::RuleContext, declare_lint_rule, | ||
| }; | ||
| use biome_console::markup; | ||
| use biome_diagnostics::Severity; | ||
| use biome_js_syntax::jsx_ext::AnyJsxElement; | ||
| use biome_rowan::{AstNode, AstNodeList, TextRange}; | ||
| use biome_rule_options::no_html_link_for_pages::NoHtmlLinkForPagesOptions; | ||
|
|
||
| declare_lint_rule! { | ||
| /// Prevent usage of `<a>` elements to navigate to internal Next.js pages. | ||
| /// | ||
| /// Using `<a>` elements instead of `next/link` for internal navigation can cause unnecessary full-page reloads. | ||
| /// | ||
| /// ## Examples | ||
| /// | ||
| /// ### Invalid | ||
| /// | ||
| /// ```jsx,expect_diagnostic | ||
| /// export const Page = () => { | ||
| /// return ( | ||
| /// <div> | ||
| /// <a href='/about'>About</a> | ||
| /// </div> | ||
| /// ); | ||
| /// } | ||
| /// ``` | ||
| /// | ||
| /// ### Valid | ||
| /// | ||
| /// ```jsx | ||
| /// import Link from "next/link"; | ||
| /// | ||
| /// export const Page = () => { | ||
| /// return ( | ||
| /// <div> | ||
| /// <Link href="/about">About</Link> | ||
| /// </div> | ||
| /// ); | ||
| /// } | ||
| /// ``` | ||
| /// | ||
| pub NoHtmlLinkForPages { | ||
| version: "next", | ||
| name: "noHtmlLinkForPages", | ||
| language: "jsx", | ||
| sources: &[RuleSource::EslintNext("no-html-link-for-pages").same()], | ||
| recommended: false, | ||
| severity: Severity::Warning, | ||
| domains: &[RuleDomain::Next], | ||
| } | ||
| } | ||
|
|
||
| impl Rule for NoHtmlLinkForPages { | ||
| type Query = Ast<AnyJsxElement>; | ||
| type State = TextRange; | ||
| type Signals = Option<Self::State>; | ||
| type Options = NoHtmlLinkForPagesOptions; | ||
|
|
||
| fn run(ctx: &RuleContext<Self>) -> Self::Signals { | ||
| let jsx_element = ctx.query(); | ||
|
|
||
| let element_name = jsx_element.name().ok()?.name_value_token().ok()?; | ||
| if element_name.text_trimmed() != "a" { | ||
| return None; | ||
| } | ||
|
|
||
| if jsx_element.attributes().is_empty() { | ||
| return None; | ||
| } | ||
|
|
||
| // Skip when download attribute is present | ||
| if let Some(_) = jsx_element.find_attribute_by_name("download") { | ||
| return None; | ||
| } | ||
|
|
||
| // Should not enforce when target="_blank" present | ||
| if let Some(target) = jsx_element.find_attribute_by_name("target") | ||
| && let Some(target_value) = target.as_static_value() | ||
| && target_value.text().trim() == "_blank" | ||
| { | ||
| return None; | ||
| } | ||
|
|
||
| let href_attribute = jsx_element.find_attribute_by_name("href")?; | ||
| let href_value = href_attribute.as_static_value()?; | ||
| let href_value = href_value.text(); | ||
| if href_value.is_empty() { | ||
| return None; | ||
| } | ||
|
|
||
| if is_internal_link(href_value) { | ||
| return Some(jsx_element.range()); | ||
| } | ||
|
|
||
| None | ||
| } | ||
|
|
||
| fn diagnostic(ctx: &RuleContext<Self>, state: &Self::State) -> Option<RuleDiagnostic> { | ||
| let jsx_element = ctx.query(); | ||
| let href_attribute = jsx_element.find_attribute_by_name("href")?; | ||
| let href_value = href_attribute.as_static_value()?; | ||
| let href_value = href_value.text(); | ||
|
|
||
| Some( | ||
| RuleDiagnostic::new( | ||
| rule_category!(), | ||
| state, | ||
| markup! { | ||
| ""<Emphasis>"<a>"</Emphasis>" element has an internal link to "<Emphasis>{href_value}</Emphasis>"." | ||
| }, | ||
| ) | ||
| .note(markup! { | ||
| ""<Emphasis>"<a>"</Emphasis>" elements for internal navigation can cause unnecessary full-page reloads. Use "<Emphasis>"next/link"</Emphasis>" component instead." | ||
| }) | ||
| .note(markup! { | ||
| "See the "<Hyperlink href="https://nextjs.org/docs/messages/no-html-link-for-pages">"Next.js docs"</Hyperlink>" for more details." | ||
| }), | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| fn is_internal_link(href: &str) -> bool { | ||
| let href = href.trim(); | ||
| if href.is_empty() { | ||
| return false; | ||
| } | ||
|
|
||
| if href.starts_with("http://") || href.starts_with("https://") || href.starts_with("//") { | ||
| return false; | ||
| } | ||
|
|
||
| // Skip other protocols | ||
| if href.starts_with("mailto:") | ||
| || href.starts_with("tel:") | ||
| || href.starts_with("ftp:") | ||
| || href.starts_with("file:") | ||
| { | ||
| return false; | ||
| } | ||
|
|
||
| // Skip if it appears to be a public file (e.g. .pdf) | ||
| // Internal links in Next.js do not contain file extensions basically | ||
| if let Some(last_segment) = href.split("/").last() | ||
| && last_segment.contains(".") | ||
| { | ||
| return false; | ||
| } | ||
|
|
||
| href.starts_with('/') || href.starts_with("./") || href.starts_with("../") | ||
| } | ||
41 changes: 41 additions & 0 deletions
41
crates/biome_js_analyze/tests/specs/nursery/noHtmlLinkForPages/invalid.jsx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| /* should generate diagnostics */ | ||
|
|
||
| export const Page = () => { | ||
| return ( | ||
| <a href='/'>Homepage</a> | ||
| ); | ||
| } | ||
|
|
||
| export const Page = () => { | ||
| return ( | ||
| <a href='/list/foo/bar'>Homepage</a> | ||
| ); | ||
| } | ||
|
|
||
| export const Page = () => { | ||
| return ( | ||
| <a href='/list/foo?q=bar'>Homepage</a> | ||
| ); | ||
| } | ||
|
|
||
| export const Page = () => { | ||
| return ( | ||
| <a href='/photo/1/#section'>Photo</a> | ||
| ); | ||
| } | ||
|
|
||
| export const Page = () => { | ||
| return ( | ||
| <div> | ||
| <a href='./photo'>Photo</a> | ||
| </div> | ||
| ); | ||
| } | ||
|
|
||
| export const Page = () => { | ||
| return ( | ||
| <div> | ||
| <a href='../photo'>Photo</a> | ||
| </div> | ||
| ); | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.