Skip to content

Commit

Permalink
Fix FP in single_component_path_imports lint
Browse files Browse the repository at this point in the history
  • Loading branch information
ThibsG committed Mar 20, 2021
1 parent 65d046c commit b018bca
Show file tree
Hide file tree
Showing 4 changed files with 110 additions and 16 deletions.
2 changes: 1 addition & 1 deletion clippy_lints/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1231,7 +1231,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
91 changes: 76 additions & 15 deletions clippy_lints/src/single_component_path_imports.rs
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
use crate::utils::{in_macro, span_lint_and_sugg};
use if_chain::if_chain;
use rustc_ast::{Item, ItemKind, UseTreeKind};
use rustc_ast::{Crate, Item, ItemKind, 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 @@ -34,29 +36,88 @@ 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) {
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) {
// println!("lint {:?}", name);
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_chain! {
if !in_macro(item.span);
if !item.vis.kind.is_pub();
if let ItemKind::Use(use_tree) = &item.kind;
if let segments = &use_tree.prefix.segments;

then {
// 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);
}
}
}
}
}
}
}
}
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() {}

0 comments on commit b018bca

Please sign in to comment.