clippy_lints/src/enum_glob_use.rs

   1 //! lint on `use`ing all variants of an enum
   2
   3 use crate::utils::span_lint;
   4 use rustc::hir::def::{DefKind, Res};
   5 use rustc::hir::*;
   6 use rustc::lint::{LateContext, LateLintPass, LintArray, LintPass};
   7 use rustc::{declare_lint_pass, declare_tool_lint};
   8 use syntax::source_map::Span;
   9
  10 declare_clippy_lint! {
  11     /// **What it does:** Checks for `use Enum::*`.
  12     ///
  13     /// **Why is this bad?** It is usually better style to use the prefixed name of
  14     /// an enumeration variant, rather than importing variants.
  15     ///
  16     /// **Known problems:** Old-style enumerations that prefix the variants are
  17     /// still around.
  18     ///
  19     /// **Example:**
  20     /// ```rust
  21     /// use std::cmp::Ordering::*;
  22     /// ```
  23     pub ENUM_GLOB_USE,
  24     pedantic,
  25     "use items that import all variants of an enum"
  26 }
  27
  28 declare_lint_pass!(EnumGlobUse => [ENUM_GLOB_USE]);
  29
  30 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for EnumGlobUse {
  31     fn check_mod(&mut self, cx: &LateContext<'a, 'tcx>, m: &'tcx Mod, _: Span, _: HirId) {
  32         let map = cx.tcx.hir();
  33         // only check top level `use` statements
  34         for item in &m.item_ids {
  35             self.lint_item(cx, map.expect_item(item.id));
  36         }
  37     }
  38 }
  39
  40 impl EnumGlobUse {
  41     fn lint_item(self, cx: &LateContext<'_, '_>, item: &Item) {
  42         if item.vis.node.is_pub() {
  43             return; // re-exports are fine
  44         }
  45         if let ItemKind::Use(ref path, UseKind::Glob) = item.node {
  46             if let Res::Def(DefKind::Enum, _) = path.res {
  47                 span_lint(cx, ENUM_GLOB_USE, item.span, "don't use glob imports for enum variants");
  48             }
  49         }
  50     }
  51 }