clippy_lints/src/redundant_pub_crate.rs

   1 use crate::utils::span_lint_and_help;
   2 use rustc_hir::{Item, ItemKind, VisibilityKind};
   3 use rustc_lint::{LateContext, LateLintPass};
   4 use rustc_session::{declare_tool_lint, impl_lint_pass};
   5
   6 declare_clippy_lint! {
   7     /// **What it does:** Checks for items declared `pub(crate)` that are not crate visible because they
   8     /// are inside a private module.
   9     ///
  10     /// **Why is this bad?** Writing `pub(crate)` is misleading when it's redundant due to the parent
  11     /// module's visibility.
  12     ///
  13     /// **Known problems:** None.
  14     ///
  15     /// **Example:**
  16     ///
  17     /// ```rust
  18     /// mod internal {
  19     ///     pub(crate) fn internal_fn() { }
  20     /// }
  21     /// ```
  22     /// This function is not visible outside the module and it can be declared with `pub` or
  23     /// private visibility
  24     /// ```rust
  25     /// mod internal {
  26     ///     pub fn internal_fn() { }
  27     /// }
  28     /// ```
  29     pub REDUNDANT_PUB_CRATE,
  30     nursery,
  31     "Using `pub(crate)` visibility on items that are not crate visible due to the visibility of the module that contains them."
  32 }
  33
  34 #[derive(Default)]
  35 pub struct RedundantPubCrate {
  36     is_exported: Vec<bool>,
  37 }
  38
  39 impl_lint_pass!(RedundantPubCrate => [REDUNDANT_PUB_CRATE]);
  40
  41 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for RedundantPubCrate {
  42     fn check_item(&mut self, cx: &LateContext<'a, 'tcx>, item: &'tcx Item<'tcx>) {
  43         if let VisibilityKind::Crate { .. } = item.vis.node {
  44             if !cx.access_levels.is_exported(item.hir_id) {
  45                 if let Some(false) = self.is_exported.last() {
  46                     span_lint_and_help(
  47                         cx,
  48                         REDUNDANT_PUB_CRATE,
  49                         item.span,
  50                         &format!("pub(crate) {} inside private module", item.kind.descr()),
  51                         "consider using `pub` instead of `pub(crate)`",
  52                     )
  53                 }
  54             }
  55         }
  56
  57         if let ItemKind::Mod { .. } = item.kind {
  58             self.is_exported.push(cx.access_levels.is_exported(item.hir_id));
  59         }
  60     }
  61
  62     fn check_item_post(&mut self, _cx: &LateContext<'a, 'tcx>, item: &'tcx Item<'tcx>) {
  63         if let ItemKind::Mod { .. } = item.kind {
  64             self.is_exported.pop().expect("unbalanced check_item/check_item_post");
  65         }
  66     }
  67 }