-
-
Notifications
You must be signed in to change notification settings - Fork 497
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(lint/noUnusedImports): add rule
- Loading branch information
Showing
26 changed files
with
1,474 additions
and
34 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
228 changes: 228 additions & 0 deletions
228
crates/biome_js_analyze/src/semantic_analyzers/nursery/no_unused_imports.rs
This file contains 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,228 @@ | ||
| use crate::{ | ||
| react::{is_global_react_import, ReactLibrary}, | ||
| semantic_services::Semantic, | ||
| JsRuleAction, | ||
| }; | ||
| use biome_analyze::{context::RuleContext, declare_rule, ActionCategory, Rule, RuleDiagnostic}; | ||
| use biome_console::markup; | ||
| use biome_diagnostics::Applicability; | ||
| use biome_js_factory::make; | ||
| use biome_js_semantic::ReferencesExtensions; | ||
| use biome_js_syntax::{ | ||
| binding_ext::AnyJsBindingDeclaration, AnyJsImportClause, JsFileSource, JsIdentifierBinding, | ||
| JsImport, JsImportNamedClause, JsLanguage, JsNamedImportSpecifierList, JsSyntaxNode, T, | ||
| }; | ||
| use biome_rowan::{ | ||
| AstNode, AstSeparatedList, BatchMutation, BatchMutationExt, NodeOrToken, SyntaxResult, | ||
| }; | ||
|
|
||
| declare_rule! { | ||
| /// Disallow unused imports. | ||
| /// | ||
| /// Unused imports usually are result of incomplete refactoring. | ||
| /// | ||
| /// There is one exception to the rule: the `React` import. | ||
| /// Importing the `React` variable was a mandatory pattern until some time ago: | ||
| /// For the time being this rule will ignore it, | ||
| /// but this **might change in the future releases**. | ||
| /// | ||
| /// ## Examples | ||
| /// | ||
| /// ### Invalid | ||
| /// | ||
| /// ```js,expect_diagnostic | ||
| /// // Comment | ||
| /// import A from 'mod'; | ||
| /// ``` | ||
| /// | ||
| /// ```js,expect_diagnostic | ||
| /// // Comment | ||
| /// import * as A from 'mod'; | ||
| /// ``` | ||
| /// | ||
| /// ```ts,expect_diagnostic | ||
| /// import { type A, B } from 'mod'; | ||
| /// | ||
| /// export { B } | ||
| /// ``` | ||
| /// | ||
| /// ## Valid | ||
| /// | ||
| /// ```ts | ||
| /// import { A, type B } from 'mod'; | ||
| /// | ||
| /// function f(arg: B): A { | ||
| /// return new A(arg); | ||
| /// } | ||
| /// ``` | ||
| /// | ||
| /// ```jsx | ||
| /// import React from 'react'; | ||
| /// | ||
| /// function foo() { | ||
| /// return <div />; | ||
| /// }; | ||
| /// | ||
| /// foo(); | ||
| /// ``` | ||
| pub(crate) NoUnusedImports { | ||
| version: "next", | ||
| name: "noUnusedImports", | ||
| recommended: false, | ||
| } | ||
| } | ||
|
|
||
| impl Rule for NoUnusedImports { | ||
| type Query = Semantic<JsIdentifierBinding>; | ||
| type State = (); | ||
| type Signals = Option<Self::State>; | ||
| type Options = (); | ||
|
|
||
| fn run(ctx: &RuleContext<Self>) -> Self::Signals { | ||
| let binding = ctx.query(); | ||
| let declaration = binding.declaration()?; | ||
| if !is_import(&declaration) { | ||
| return None; | ||
| } | ||
|
|
||
| if ctx.source_type::<JsFileSource>().variant().is_jsx() { | ||
| let js_import = declaration.syntax().ancestors().find_map(JsImport::cast)?; | ||
| // Legacy React framework requires to import `React`, even if it is not used. | ||
| // This is required for transpiling JSX. | ||
| if is_global_react_import(&js_import, ReactLibrary::React).unwrap_or(false) { | ||
| return None; | ||
| } | ||
| } | ||
|
|
||
| let model = ctx.model(); | ||
| binding.all_references(model).next().is_none().then_some(()) | ||
| } | ||
|
|
||
| fn diagnostic(ctx: &RuleContext<Self>, _: &Self::State) -> Option<RuleDiagnostic> { | ||
| let binding = ctx.query(); | ||
| Some( | ||
| RuleDiagnostic::new( | ||
| rule_category!(), | ||
| binding.range(), | ||
| markup! { | ||
| "This "<Emphasis>"import"</Emphasis>" is unused." | ||
| }, | ||
| ) | ||
| .note(markup! { | ||
| "Unused imports usually are result of incomplete refactoring." | ||
| }), | ||
| ) | ||
| } | ||
|
|
||
| fn action(ctx: &RuleContext<Self>, _: &Self::State) -> Option<JsRuleAction> { | ||
| let declaration = ctx.query().declaration()?; | ||
| let mut mutation = ctx.root().begin(); | ||
| match declaration { | ||
| AnyJsBindingDeclaration::JsImportDefaultClause(_) | ||
| | AnyJsBindingDeclaration::JsImportNamespaceClause(_) => { | ||
| let import = declaration.parent::<JsImport>()?; | ||
| transfer_leading_trivia_to_sibling(&mut mutation, import.syntax()); | ||
| mutation.remove_node(import); | ||
| } | ||
| AnyJsBindingDeclaration::JsShorthandNamedImportSpecifier(_) | ||
| | AnyJsBindingDeclaration::JsNamedImportSpecifier(_) | ||
| | AnyJsBindingDeclaration::JsBogusNamedImportSpecifier(_) => { | ||
| let specifier_list = declaration.parent::<JsNamedImportSpecifierList>()?; | ||
| if specifier_list.iter().count() == 1 { | ||
| let import_clause = | ||
| JsImportNamedClause::cast(specifier_list.syntax().parent()?.parent()?)?; | ||
| remove_named_import_from_import_clause(&mut mutation, import_clause).ok()?; | ||
| } else { | ||
| let following_separator = specifier_list | ||
| .iter() | ||
| .zip(specifier_list.separators().map(|separator| separator.ok())) | ||
| .find(|(specifier, _)| { | ||
| specifier | ||
| .as_ref() | ||
| .is_ok_and(|x| x.syntax() == declaration.syntax()) | ||
| }) | ||
| .and_then(|(_, separator)| separator); | ||
| if let Some(separator) = following_separator { | ||
| mutation.remove_token(separator); | ||
| } | ||
| mutation.remove_node(declaration); | ||
| } | ||
| } | ||
| AnyJsBindingDeclaration::JsDefaultImportSpecifier(_) => { | ||
| mutation.remove_node(declaration); | ||
| } | ||
| AnyJsBindingDeclaration::JsNamespaceImportSpecifier(_) => { | ||
| let import_clause = JsImportNamedClause::cast(declaration.syntax().parent()?)?; | ||
| remove_named_import_from_import_clause(&mut mutation, import_clause).ok()?; | ||
| } | ||
| AnyJsBindingDeclaration::TsImportEqualsDeclaration(_) => { | ||
| mutation.remove_node(declaration); | ||
| } | ||
| _ => { | ||
| return None; | ||
| } | ||
| } | ||
| Some(JsRuleAction { | ||
| mutation, | ||
| category: ActionCategory::QuickFix, | ||
| applicability: Applicability::Always, | ||
| message: markup! { "Remove the unused import." }.to_owned(), | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| fn remove_named_import_from_import_clause( | ||
| mutation: &mut BatchMutation<JsLanguage>, | ||
| import_clause: JsImportNamedClause, | ||
| ) -> SyntaxResult<()> { | ||
| if let Some(default_specifier) = import_clause.default_specifier() { | ||
| let default_clause = make::js_import_default_clause( | ||
| default_specifier.local_name()?, | ||
| make::token_decorated_with_space(T![from]), | ||
| import_clause.source()?, | ||
| ) | ||
| .build(); | ||
| mutation.replace_node( | ||
| AnyJsImportClause::from(import_clause), | ||
| default_clause.into(), | ||
| ); | ||
| } else if let Some(import) = import_clause.syntax().parent() { | ||
| transfer_leading_trivia_to_sibling(mutation, &import); | ||
| mutation.remove_element(NodeOrToken::Node(import)); | ||
| } | ||
| Ok(()) | ||
| } | ||
|
|
||
| fn transfer_leading_trivia_to_sibling( | ||
| mutation: &mut BatchMutation<JsLanguage>, | ||
| node: &JsSyntaxNode, | ||
| ) -> Option<()> { | ||
| node.first_leading_trivia(); | ||
| let pieces = node.first_leading_trivia()?.pieces(); | ||
| let (sibling, new_sibling) = if let Some(next_sibling) = node.next_sibling() { | ||
| let new_next_sibling = next_sibling.clone().prepend_trivia_pieces(pieces)?; | ||
| (next_sibling, new_next_sibling) | ||
| } else if let Some(prev_sibling) = node.prev_sibling() { | ||
| let new_prev_sibling = prev_sibling.clone().append_trivia_pieces(pieces)?; | ||
| (prev_sibling, new_prev_sibling) | ||
| } else { | ||
| return None; | ||
| }; | ||
| mutation | ||
| .replace_element_discard_trivia(NodeOrToken::Node(sibling), NodeOrToken::Node(new_sibling)); | ||
| Some(()) | ||
| } | ||
|
|
||
| fn is_import(declaration: &AnyJsBindingDeclaration) -> bool { | ||
| matches!( | ||
| declaration, | ||
| AnyJsBindingDeclaration::JsBogusNamedImportSpecifier(_) | ||
| | AnyJsBindingDeclaration::JsDefaultImportSpecifier(_) | ||
| | AnyJsBindingDeclaration::JsImportDefaultClause(_) | ||
| | AnyJsBindingDeclaration::JsImportNamespaceClause(_) | ||
| | AnyJsBindingDeclaration::JsNamedImportSpecifier(_) | ||
| | AnyJsBindingDeclaration::JsNamespaceImportSpecifier(_) | ||
| | AnyJsBindingDeclaration::JsShorthandNamedImportSpecifier(_) | ||
| | AnyJsBindingDeclaration::TsImportEqualsDeclaration(_) | ||
| ) | ||
| } |
24 changes: 24 additions & 0 deletions
24
crates/biome_js_analyze/tests/specs/nursery/noUnusedImports/invalid.js
This file contains 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,24 @@ | ||
| // Header comment | ||
| import A from "mod"; | ||
|
|
||
| // Header comment | ||
| import * as B from "mod"; // Import comment | ||
|
|
||
| // Header comment | ||
| import { C } from "mod"; // Import comment | ||
|
|
||
| // Header comment | ||
| import /*a*/ D /*b*/, /*c*/{ E }/*d*/ from "mod"; // Import comment | ||
|
|
||
| import /*a*/ F /*b*/, /*c*/ * as G /*d*/ from "mod"; | ||
|
|
||
| import { | ||
| // Comment | ||
| H, | ||
| I, | ||
| } from "mod"; | ||
|
|
||
| import {/*a*/J/*b*/, /*c*/K/*d*/} from "mod"; | ||
|
|
||
| // Header comment | ||
| import { L as M, } from "mod"; // Import comment |
Oops, something went wrong.