clippy_lints/src/wildcard_imports.rs

   1 use crate::utils::{in_macro, snippet, snippet_with_applicability, span_lint_and_sugg};
   2 use if_chain::if_chain;
   3 use rustc_errors::Applicability;
   4 use rustc_hir::{
   5     def::{DefKind, Res},
   6     Item, ItemKind, PathSegment, UseKind,
   7 };
   8 use rustc_lint::{LateContext, LateLintPass};
   9 use rustc_session::{declare_tool_lint, impl_lint_pass};
  10 use rustc_span::BytePos;
  11
  12 declare_clippy_lint! {
  13     /// **What it does:** Checks for `use Enum::*`.
  14     ///
  15     /// **Why is this bad?** It is usually better style to use the prefixed name of
  16     /// an enumeration variant, rather than importing variants.
  17     ///
  18     /// **Known problems:** Old-style enumerations that prefix the variants are
  19     /// still around.
  20     ///
  21     /// **Example:**
  22     /// ```rust
  23     /// use std::cmp::Ordering::*;
  24     /// ```
  25     pub ENUM_GLOB_USE,
  26     pedantic,
  27     "use items that import all variants of an enum"
  28 }
  29
  30 declare_clippy_lint! {
  31     /// **What it does:** Checks for wildcard imports `use _::*`.
  32     ///
  33     /// **Why is this bad?** wildcard imports can polute the namespace. This is especially bad if
  34     /// you try to import something through a wildcard, that already has been imported by name from
  35     /// a different source:
  36     ///
  37     /// ```rust,ignore
  38     /// use crate1::foo; // Imports a function named foo
  39     /// use crate2::*; // Has a function named foo
  40     ///
  41     /// foo(); // Calls crate1::foo
  42     /// ```
  43     ///
  44     /// This can lead to confusing error messages at best and to unexpected behavior at worst.
  45     ///
  46     /// Note that this will not warn about wildcard imports from modules named `prelude`; many
  47     /// crates (including the standard library) provide modules named "prelude" specifically
  48     /// designed for wildcard import.
  49     ///
  50     /// **Known problems:** If macros are imported through the wildcard, this macro is not included
  51     /// by the suggestion and has to be added by hand.
  52     ///
  53     /// Applying the suggestion when explicit imports of the things imported with a glob import
  54     /// exist, may result in `unused_imports` warnings.
  55     ///
  56     /// **Example:**
  57     ///
  58     /// Bad:
  59     /// ```rust,ignore
  60     /// use crate1::*;
  61     ///
  62     /// foo();
  63     /// ```
  64     ///
  65     /// Good:
  66     /// ```rust,ignore
  67     /// use crate1::foo;
  68     ///
  69     /// foo();
  70     /// ```
  71     pub WILDCARD_IMPORTS,
  72     pedantic,
  73     "lint `use _::*` statements"
  74 }
  75
  76 #[derive(Default)]
  77 pub struct WildcardImports {
  78     warn_on_all: bool,
  79     test_modules_deep: u32,
  80 }
  81
  82 impl WildcardImports {
  83     pub fn new(warn_on_all: bool) -> Self {
  84         Self {
  85             warn_on_all,
  86             test_modules_deep: 0,
  87         }
  88     }
  89 }
  90
  91 impl_lint_pass!(WildcardImports => [ENUM_GLOB_USE, WILDCARD_IMPORTS]);
  92
  93 impl LateLintPass<'_, '_> for WildcardImports {
  94     fn check_item(&mut self, cx: &LateContext<'_, '_>, item: &Item<'_>) {
  95         if item.vis.node.is_pub() || item.vis.node.is_pub_restricted() {
  96             return;
  97         }
  98         if is_test_module_or_function(item) {
  99             self.test_modules_deep += 1;
 100         }
 101         if_chain! {
 102             if self.warn_on_all || !in_macro(item.span);
 103             if let ItemKind::Use(use_path, UseKind::Glob) = &item.kind;
 104             if self.warn_on_all || !self.check_exceptions(use_path.segments);
 105             let used_imports = cx.tcx.names_imported_by_glob_use(item.hir_id.owner);
 106             if !used_imports.is_empty(); // Already handled by `unused_imports`
 107             then {
 108                 let mut applicability = Applicability::MachineApplicable;
 109                 let import_source_snippet = snippet_with_applicability(cx, use_path.span, "..", &mut applicability);
 110                 let (span, braced_glob) = if import_source_snippet.is_empty() {
 111                     // This is a `_::{_, *}` import
 112                     // In this case `use_path.span` is empty and ends directly in front of the `*`,
 113                     // so we need to extend it by one byte.
 114                     (
 115                         use_path.span.with_hi(use_path.span.hi() + BytePos(1)),
 116                         true,
 117                     )
 118                 } else {
 119                     // In this case, the `use_path.span` ends right before the `::*`, so we need to
 120                     // extend it up to the `*`. Since it is hard to find the `*` in weird
 121                     // formattings like `use _ ::  *;`, we extend it up to, but not including the
 122                     // `;`. In nested imports, like `use _::{inner::*, _}` there is no `;` and we
 123                     // can just use the end of the item span
 124                     let mut span = use_path.span.with_hi(item.span.hi());
 125                     if snippet(cx, span, "").ends_with(';') {
 126                         span = use_path.span.with_hi(item.span.hi() - BytePos(1));
 127                     }
 128                     (
 129                         span, false,
 130                     )
 131                 };
 132
 133                 let imports_string = if used_imports.len() == 1 {
 134                     used_imports.iter().next().unwrap().to_string()
 135                 } else {
 136                     let mut imports = used_imports
 137                         .iter()
 138                         .map(ToString::to_string)
 139                         .collect::<Vec<_>>();
 140                     imports.sort();
 141                     if braced_glob {
 142                         imports.join(", ")
 143                     } else {
 144                         format!("{{{}}}", imports.join(", "))
 145                     }
 146                 };
 147
 148                 let sugg = if braced_glob {
 149                     imports_string
 150                 } else {
 151                     format!("{}::{}", import_source_snippet, imports_string)
 152                 };
 153
 154                 let (lint, message) = if let Res::Def(DefKind::Enum, _) = use_path.res {
 155                     (ENUM_GLOB_USE, "usage of wildcard import for enum variants")
 156                 } else {
 157                     (WILDCARD_IMPORTS, "usage of wildcard import")
 158                 };
 159
 160                 span_lint_and_sugg(
 161                     cx,
 162                     lint,
 163                     span,
 164                     message,
 165                     "try",
 166                     sugg,
 167                     applicability,
 168                 );
 169             }
 170         }
 171     }
 172
 173     fn check_item_post(&mut self, _: &LateContext<'_, '_>, item: &Item<'_>) {
 174         if is_test_module_or_function(item) {
 175             self.test_modules_deep -= 1;
 176         }
 177     }
 178 }
 179
 180 impl WildcardImports {
 181     fn check_exceptions(&self, segments: &[PathSegment<'_>]) -> bool {
 182         is_prelude_import(segments) || (is_super_only_import(segments) && self.test_modules_deep > 0)
 183     }
 184 }
 185
 186 // Allow "...prelude::*" imports.
 187 // Many crates have a prelude, and it is imported as a glob by design.
 188 fn is_prelude_import(segments: &[PathSegment<'_>]) -> bool {
 189     segments
 190         .iter()
 191         .last()
 192         .map_or(false, |ps| ps.ident.as_str() == "prelude")
 193 }
 194
 195 // Allow "super::*" imports in tests.
 196 fn is_super_only_import(segments: &[PathSegment<'_>]) -> bool {
 197     segments.len() == 1 && segments[0].ident.as_str() == "super"
 198 }
 199
 200 fn is_test_module_or_function(item: &Item<'_>) -> bool {
 201     matches!(item.kind, ItemKind::Fn(..) | ItemKind::Mod(..)) && item.ident.name.as_str().contains("test")
 202 }