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