clippy_lints/src/non_expressive_names.rs

   1 use crate::utils::{span_lint, span_lint_and_then};
   2 use rustc_ast::ast::{
   3     Arm, AssocItem, AssocItemKind, Attribute, Block, FnDecl, Ident, Item, ItemKind, Local, Mac, Pat, PatKind,
   4 };
   5 use rustc_ast::attr;
   6 use rustc_ast::visit::{walk_block, walk_expr, walk_pat, Visitor};
   7 use rustc_lint::{EarlyContext, EarlyLintPass};
   8 use rustc_session::{declare_tool_lint, impl_lint_pass};
   9 use rustc_span::source_map::Span;
  10 use rustc_span::symbol::SymbolStr;
  11 use std::cmp::Ordering;
  12
  13 declare_clippy_lint! {
  14     /// **What it does:** Checks for names that are very similar and thus confusing.
  15     ///
  16     /// **Why is this bad?** It's hard to distinguish between names that differ only
  17     /// by a single character.
  18     ///
  19     /// **Known problems:** None?
  20     ///
  21     /// **Example:**
  22     /// ```ignore
  23     /// let checked_exp = something;
  24     /// let checked_expr = something_else;
  25     /// ```
  26     pub SIMILAR_NAMES,
  27     pedantic,
  28     "similarly named items and bindings"
  29 }
  30
  31 declare_clippy_lint! {
  32     /// **What it does:** Checks for too many variables whose name consists of a
  33     /// single character.
  34     ///
  35     /// **Why is this bad?** It's hard to memorize what a variable means without a
  36     /// descriptive name.
  37     ///
  38     /// **Known problems:** None?
  39     ///
  40     /// **Example:**
  41     /// ```ignore
  42     /// let (a, b, c, d, e, f, g) = (...);
  43     /// ```
  44     pub MANY_SINGLE_CHAR_NAMES,
  45     style,
  46     "too many single character bindings"
  47 }
  48
  49 declare_clippy_lint! {
  50     /// **What it does:** Checks if you have variables whose name consists of just
  51     /// underscores and digits.
  52     ///
  53     /// **Why is this bad?** It's hard to memorize what a variable means without a
  54     /// descriptive name.
  55     ///
  56     /// **Known problems:** None?
  57     ///
  58     /// **Example:**
  59     /// ```rust
  60     /// let _1 = 1;
  61     /// let ___1 = 1;
  62     /// let __1___2 = 11;
  63     /// ```
  64     pub JUST_UNDERSCORES_AND_DIGITS,
  65     style,
  66     "unclear name"
  67 }
  68
  69 #[derive(Copy, Clone)]
  70 pub struct NonExpressiveNames {
  71     pub single_char_binding_names_threshold: u64,
  72 }
  73
  74 impl_lint_pass!(NonExpressiveNames => [SIMILAR_NAMES, MANY_SINGLE_CHAR_NAMES, JUST_UNDERSCORES_AND_DIGITS]);
  75
  76 struct ExistingName {
  77     interned: SymbolStr,
  78     span: Span,
  79     len: usize,
  80     whitelist: &'static [&'static str],
  81 }
  82
  83 struct SimilarNamesLocalVisitor<'a, 'tcx> {
  84     names: Vec<ExistingName>,
  85     cx: &'a EarlyContext<'tcx>,
  86     lint: &'a NonExpressiveNames,
  87
  88     /// A stack of scopes containing the single-character bindings in each scope.
  89     single_char_names: Vec<Vec<Ident>>,
  90 }
  91
  92 impl<'a, 'tcx> SimilarNamesLocalVisitor<'a, 'tcx> {
  93     fn check_single_char_names(&self) {
  94         let num_single_char_names = self.single_char_names.iter().flatten().count();
  95         let threshold = self.lint.single_char_binding_names_threshold;
  96         if num_single_char_names as u64 >= threshold {
  97             let span = self
  98                 .single_char_names
  99                 .iter()
 100                 .flatten()
 101                 .map(|ident| ident.span)
 102                 .collect::<Vec<_>>();
 103             span_lint(
 104                 self.cx,
 105                 MANY_SINGLE_CHAR_NAMES,
 106                 span,
 107                 &format!(
 108                     "{} bindings with single-character names in scope",
 109                     num_single_char_names
 110                 ),
 111             );
 112         }
 113     }
 114 }
 115
 116 // this list contains lists of names that are allowed to be similar
 117 // the assumption is that no name is ever contained in multiple lists.
 118 #[rustfmt::skip]
 119 const WHITELIST: &[&[&str]] = &[
 120     &["parsed", "parser"],
 121     &["lhs", "rhs"],
 122     &["tx", "rx"],
 123     &["set", "get"],
 124     &["args", "arms"],
 125     &["qpath", "path"],
 126     &["lit", "lint"],
 127 ];
 128
 129 struct SimilarNamesNameVisitor<'a, 'tcx, 'b>(&'b mut SimilarNamesLocalVisitor<'a, 'tcx>);
 130
 131 impl<'a, 'tcx, 'b> Visitor<'tcx> for SimilarNamesNameVisitor<'a, 'tcx, 'b> {
 132     fn visit_pat(&mut self, pat: &'tcx Pat) {
 133         match pat.kind {
 134             PatKind::Ident(_, ident, _) => self.check_ident(ident),
 135             PatKind::Struct(_, ref fields, _) => {
 136                 for field in fields {
 137                     if !field.is_shorthand {
 138                         self.visit_pat(&field.pat);
 139                     }
 140                 }
 141             },
 142             // just go through the first pattern, as either all patterns
 143             // bind the same bindings or rustc would have errored much earlier
 144             PatKind::Or(ref pats) => self.visit_pat(&pats[0]),
 145             _ => walk_pat(self, pat),
 146         }
 147     }
 148     fn visit_mac(&mut self, _mac: &Mac) {
 149         // do not check macs
 150     }
 151 }
 152
 153 #[must_use]
 154 fn get_whitelist(interned_name: &str) -> Option<&'static [&'static str]> {
 155     for &allow in WHITELIST {
 156         if whitelisted(interned_name, allow) {
 157             return Some(allow);
 158         }
 159     }
 160     None
 161 }
 162
 163 #[must_use]
 164 fn whitelisted(interned_name: &str, list: &[&str]) -> bool {
 165     list.iter()
 166         .any(|&name| interned_name.starts_with(name) || interned_name.ends_with(name))
 167 }
 168
 169 impl<'a, 'tcx, 'b> SimilarNamesNameVisitor<'a, 'tcx, 'b> {
 170     fn check_short_ident(&mut self, ident: Ident) {
 171         // Ignore shadowing
 172         if self
 173             .0
 174             .single_char_names
 175             .iter()
 176             .flatten()
 177             .any(|id| id.name == ident.name)
 178         {
 179             return;
 180         }
 181
 182         if let Some(scope) = &mut self.0.single_char_names.last_mut() {
 183             scope.push(ident);
 184         }
 185     }
 186
 187     #[allow(clippy::too_many_lines)]
 188     fn check_ident(&mut self, ident: Ident) {
 189         let interned_name = ident.name.as_str();
 190         if interned_name.chars().any(char::is_uppercase) {
 191             return;
 192         }
 193         if interned_name.chars().all(|c| c.is_digit(10) || c == '_') {
 194             span_lint(
 195                 self.0.cx,
 196                 JUST_UNDERSCORES_AND_DIGITS,
 197                 ident.span,
 198                 "consider choosing a more descriptive name",
 199             );
 200             return;
 201         }
 202         let count = interned_name.chars().count();
 203         if count < 3 {
 204             if count == 1 {
 205                 self.check_short_ident(ident);
 206             }
 207             return;
 208         }
 209         for existing_name in &self.0.names {
 210             if whitelisted(&interned_name, existing_name.whitelist) {
 211                 continue;
 212             }
 213             let mut split_at = None;
 214             match existing_name.len.cmp(&count) {
 215                 Ordering::Greater => {
 216                     if existing_name.len - count != 1 || levenstein_not_1(&interned_name, &existing_name.interned) {
 217                         continue;
 218                     }
 219                 },
 220                 Ordering::Less => {
 221                     if count - existing_name.len != 1 || levenstein_not_1(&existing_name.interned, &interned_name) {
 222                         continue;
 223                     }
 224                 },
 225                 Ordering::Equal => {
 226                     let mut interned_chars = interned_name.chars();
 227                     let mut existing_chars = existing_name.interned.chars();
 228                     let first_i = interned_chars.next().expect("we know we have at least one char");
 229                     let first_e = existing_chars.next().expect("we know we have at least one char");
 230                     let eq_or_numeric = |(a, b): (char, char)| a == b || a.is_numeric() && b.is_numeric();
 231
 232                     if eq_or_numeric((first_i, first_e)) {
 233                         let last_i = interned_chars.next_back().expect("we know we have at least two chars");
 234                         let last_e = existing_chars.next_back().expect("we know we have at least two chars");
 235                         if eq_or_numeric((last_i, last_e)) {
 236                             if interned_chars
 237                                 .zip(existing_chars)
 238                                 .filter(|&ie| !eq_or_numeric(ie))
 239                                 .count()
 240                                 != 1
 241                             {
 242                                 continue;
 243                             }
 244                         } else {
 245                             let second_last_i = interned_chars
 246                                 .next_back()
 247                                 .expect("we know we have at least three chars");
 248                             let second_last_e = existing_chars
 249                                 .next_back()
 250                                 .expect("we know we have at least three chars");
 251                             if !eq_or_numeric((second_last_i, second_last_e))
 252                                 || second_last_i == '_'
 253                                 || !interned_chars.zip(existing_chars).all(eq_or_numeric)
 254                             {
 255                                 // allowed similarity foo_x, foo_y
 256                                 // or too many chars differ (foo_x, boo_y) or (foox, booy)
 257                                 continue;
 258                             }
 259                             split_at = interned_name.char_indices().rev().next().map(|(i, _)| i);
 260                         }
 261                     } else {
 262                         let second_i = interned_chars.next().expect("we know we have at least two chars");
 263                         let second_e = existing_chars.next().expect("we know we have at least two chars");
 264                         if !eq_or_numeric((second_i, second_e))
 265                             || second_i == '_'
 266                             || !interned_chars.zip(existing_chars).all(eq_or_numeric)
 267                         {
 268                             // allowed similarity x_foo, y_foo
 269                             // or too many chars differ (x_foo, y_boo) or (xfoo, yboo)
 270                             continue;
 271                         }
 272                         split_at = interned_name.chars().next().map(char::len_utf8);
 273                     }
 274                 },
 275             }
 276             span_lint_and_then(
 277                 self.0.cx,
 278                 SIMILAR_NAMES,
 279                 ident.span,
 280                 "binding's name is too similar to existing binding",
 281                 |diag| {
 282                     diag.span_note(existing_name.span, "existing binding defined here");
 283                     if let Some(split) = split_at {
 284                         diag.span_help(
 285                             ident.span,
 286                             &format!(
 287                                 "separate the discriminating character by an \
 288                                  underscore like: `{}_{}`",
 289                                 &interned_name[..split],
 290                                 &interned_name[split..]
 291                             ),
 292                         );
 293                     }
 294                 },
 295             );
 296             return;
 297         }
 298         self.0.names.push(ExistingName {
 299             whitelist: get_whitelist(&interned_name).unwrap_or(&[]),
 300             interned: interned_name,
 301             span: ident.span,
 302             len: count,
 303         });
 304     }
 305 }
 306
 307 impl<'a, 'b> SimilarNamesLocalVisitor<'a, 'b> {
 308     /// ensure scoping rules work
 309     fn apply<F: for<'c> Fn(&'c mut Self)>(&mut self, f: F) {
 310         let n = self.names.len();
 311         let single_char_count = self.single_char_names.len();
 312         f(self);
 313         self.names.truncate(n);
 314         self.single_char_names.truncate(single_char_count);
 315     }
 316 }
 317
 318 impl<'a, 'tcx> Visitor<'tcx> for SimilarNamesLocalVisitor<'a, 'tcx> {
 319     fn visit_local(&mut self, local: &'tcx Local) {
 320         if let Some(ref init) = local.init {
 321             self.apply(|this| walk_expr(this, &**init));
 322         }
 323         // add the pattern after the expression because the bindings aren't available
 324         // yet in the init
 325         // expression
 326         SimilarNamesNameVisitor(self).visit_pat(&*local.pat);
 327     }
 328     fn visit_block(&mut self, blk: &'tcx Block) {
 329         self.single_char_names.push(vec![]);
 330
 331         self.apply(|this| walk_block(this, blk));
 332
 333         self.check_single_char_names();
 334         self.single_char_names.pop();
 335     }
 336     fn visit_arm(&mut self, arm: &'tcx Arm) {
 337         self.single_char_names.push(vec![]);
 338
 339         self.apply(|this| {
 340             SimilarNamesNameVisitor(this).visit_pat(&arm.pat);
 341             this.apply(|this| walk_expr(this, &arm.body));
 342         });
 343
 344         self.check_single_char_names();
 345         self.single_char_names.pop();
 346     }
 347     fn visit_item(&mut self, _: &Item) {
 348         // do not recurse into inner items
 349     }
 350     fn visit_mac(&mut self, _mac: &Mac) {
 351         // do not check macs
 352     }
 353 }
 354
 355 impl EarlyLintPass for NonExpressiveNames {
 356     fn check_item(&mut self, cx: &EarlyContext<'_>, item: &Item) {
 357         if let ItemKind::Fn(_, ref sig, _, Some(ref blk)) = item.kind {
 358             do_check(self, cx, &item.attrs, &sig.decl, blk);
 359         }
 360     }
 361
 362     fn check_impl_item(&mut self, cx: &EarlyContext<'_>, item: &AssocItem) {
 363         if let AssocItemKind::Fn(_, ref sig, _, Some(ref blk)) = item.kind {
 364             do_check(self, cx, &item.attrs, &sig.decl, blk);
 365         }
 366     }
 367 }
 368
 369 fn do_check(lint: &mut NonExpressiveNames, cx: &EarlyContext<'_>, attrs: &[Attribute], decl: &FnDecl, blk: &Block) {
 370     if !attr::contains_name(attrs, sym!(test)) {
 371         let mut visitor = SimilarNamesLocalVisitor {
 372             names: Vec::new(),
 373             cx,
 374             lint,
 375             single_char_names: vec![vec![]],
 376         };
 377
 378         // initialize with function arguments
 379         for arg in &decl.inputs {
 380             SimilarNamesNameVisitor(&mut visitor).visit_pat(&arg.pat);
 381         }
 382         // walk all other bindings
 383         walk_block(&mut visitor, blk);
 384
 385         visitor.check_single_char_names();
 386     }
 387 }
 388
 389 /// Precondition: `a_name.chars().count() < b_name.chars().count()`.
 390 #[must_use]
 391 fn levenstein_not_1(a_name: &str, b_name: &str) -> bool {
 392     debug_assert!(a_name.chars().count() < b_name.chars().count());
 393     let mut a_chars = a_name.chars();
 394     let mut b_chars = b_name.chars();
 395     while let (Some(a), Some(b)) = (a_chars.next(), b_chars.next()) {
 396         if a == b {
 397             continue;
 398         }
 399         if let Some(b2) = b_chars.next() {
 400             // check if there's just one character inserted
 401             return a != b2 || a_chars.ne(b_chars);
 402         } else {
 403             // tuple
 404             // ntuple
 405             return true;
 406         }
 407     }
 408     // for item in items
 409     true
 410 }