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.

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

Fix FP in single_component_path_imports lint #6905

Merged
merged 4 commits into from
Apr 11, 2021
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
2 changes: 1 addition & 1 deletion clippy_lints/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1232,7 +1232,7 @@ pub fn register_plugins(store: &mut rustc_lint::LintStore, sess: &Session, conf:
store.register_early_pass(|| box as_conversions::AsConversions);
store.register_late_pass(|| box let_underscore::LetUnderscore);
store.register_late_pass(|| box atomic_ordering::AtomicOrdering);
store.register_early_pass(|| box single_component_path_imports::SingleComponentPathImports);
store.register_early_pass(|| box single_component_path_imports::SingleComponentPathImports::default());
let max_fn_params_bools = conf.max_fn_params_bools;
let max_struct_bools = conf.max_struct_bools;
store.register_early_pass(move || box excessive_bools::ExcessiveBools::new(max_struct_bools, max_fn_params_bools));
Expand Down
98 changes: 82 additions & 16 deletions clippy_lints/src/single_component_path_imports.rs
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
use clippy_utils::diagnostics::span_lint_and_sugg;
use clippy_utils::in_macro;
use if_chain::if_chain;
use rustc_ast::{Item, ItemKind, UseTreeKind};
use rustc_ast::{Crate, Item, ItemKind, ModKind, UseTreeKind};
use rustc_errors::Applicability;
use rustc_lint::{EarlyContext, EarlyLintPass};
use rustc_session::{declare_lint_pass, declare_tool_lint};
use rustc_session::{declare_tool_lint, impl_lint_pass};
use rustc_span::edition::Edition;
use rustc_span::symbol::kw;
use rustc_span::{Span, Symbol};

declare_clippy_lint! {
/// **What it does:** Checking for imports with single component use path.
Expand Down Expand Up @@ -35,29 +36,94 @@ declare_clippy_lint! {
"imports with single component path are redundant"
}

declare_lint_pass!(SingleComponentPathImports => [SINGLE_COMPONENT_PATH_IMPORTS]);
#[derive(Default)]
pub struct SingleComponentPathImports {
/// keep track of imports reused with `self` keyword,
/// such as `self::crypto_hash` in the example below
///
/// ```rust,ignore
/// use self::crypto_hash::{Algorithm, Hasher};
/// ```
imports_reused_with_self: Vec<Symbol>,
/// keep track of single use statements
/// such as `crypto_hash` in the example below
///
/// ```rust,ignore
/// use crypto_hash;
/// ```
single_use_usages: Vec<(Symbol, Span)>,
}

impl_lint_pass!(SingleComponentPathImports => [SINGLE_COMPONENT_PATH_IMPORTS]);

impl EarlyLintPass for SingleComponentPathImports {
fn check_item(&mut self, cx: &EarlyContext<'_>, item: &Item) {
if_chain! {
if !in_macro(item.span);
if cx.sess.opts.edition >= Edition::Edition2018;
if !item.vis.kind.is_pub();
if let ItemKind::Use(use_tree) = &item.kind;
if let segments = &use_tree.prefix.segments;
if segments.len() == 1;
if let UseTreeKind::Simple(None, _, _) = use_tree.kind;
then {
fn check_crate(&mut self, cx: &EarlyContext<'_>, krate: &Crate) {
ThibsG marked this conversation as resolved.
Show resolved Hide resolved
if cx.sess.opts.edition < Edition::Edition2018 {
return;
}
for item in &krate.items {
self.track_uses(&item);
}
for single_use in &self.single_use_usages {
if !self.imports_reused_with_self.contains(&single_use.0) {
span_lint_and_sugg(
cx,
SINGLE_COMPONENT_PATH_IMPORTS,
item.span,
single_use.1,
"this import is redundant",
"remove it entirely",
String::new(),
Applicability::MachineApplicable
Applicability::MachineApplicable,
);
}
}
}
}

impl SingleComponentPathImports {
fn track_uses(&mut self, item: &Item) {
if in_macro(item.span) || item.vis.kind.is_pub() {
return;
}

match &item.kind {
ItemKind::Mod(_, ModKind::Loaded(ref items, ..)) => {
for item in items.iter() {
self.track_uses(&item);
}
},
ItemKind::Use(use_tree) => {
let segments = &use_tree.prefix.segments;

// keep track of `use some_module;` usages
if segments.len() == 1 {
if let UseTreeKind::Simple(None, _, _) = use_tree.kind {
let ident = &segments[0].ident;
self.single_use_usages.push((ident.name, item.span));
}
return;
}

// keep track of `use self::some_module` usages
if segments[0].ident.name == kw::SelfLower {
// simple case such as `use self::module::SomeStruct`
if segments.len() > 1 {
self.imports_reused_with_self.push(segments[1].ident.name);
return;
}

// nested case such as `use self::{module1::Struct1, module2::Struct2}`
if let UseTreeKind::Nested(trees) = &use_tree.kind {
for tree in trees {
let segments = &tree.0.prefix.segments;
if !segments.is_empty() {
self.imports_reused_with_self.push(segments[0].ident.name);
}
}
}
}
},
_ => {},
}
}
}
6 changes: 6 additions & 0 deletions tests/ui/single_component_path_imports.fixed
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,9 @@ fn main() {
// False positive #5154, shouldn't trigger lint.
m!();
}

mod hello_mod {

#[allow(dead_code)]
fn hello_mod() {}
}
6 changes: 6 additions & 0 deletions tests/ui/single_component_path_imports.rs
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,9 @@ fn main() {
// False positive #5154, shouldn't trigger lint.
m!();
}

mod hello_mod {
use regex;
#[allow(dead_code)]
fn hello_mod() {}
}
ThibsG marked this conversation as resolved.
Show resolved Hide resolved
8 changes: 7 additions & 1 deletion tests/ui/single_component_path_imports.stderr
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,11 @@ LL | use regex;
|
= note: `-D clippy::single-component-path-imports` implied by `-D warnings`

error: aborting due to previous error
error: this import is redundant
--> $DIR/single_component_path_imports.rs:24:5
|
LL | use regex;
| ^^^^^^^^^^ help: remove it entirely

error: aborting due to 2 previous errors

16 changes: 16 additions & 0 deletions tests/ui/single_component_path_imports_self_after.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
// edition:2018
#![warn(clippy::single_component_path_imports)]
#![allow(unused_imports)]

use self::regex::{Regex as xeger, RegexSet as tesxeger};
pub use self::{
regex::{Regex, RegexSet},
some_mod::SomeType,
};
use regex;

mod some_mod {
pub struct SomeType;
}

fn main() {}
17 changes: 17 additions & 0 deletions tests/ui/single_component_path_imports_self_before.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
// edition:2018
#![warn(clippy::single_component_path_imports)]
#![allow(unused_imports)]

use regex;

use self::regex::{Regex as xeger, RegexSet as tesxeger};
pub use self::{
regex::{Regex, RegexSet},
some_mod::SomeType,
};

mod some_mod {
pub struct SomeType;
}

fn main() {}