X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=clippy_lints%2Fsrc%2Fnon_expressive_names.rs;h=7bdeec0a56f0ee0fc53951b92267d12fa9ab9023;hb=6937d5581af14b71e23af0db81241a3fea11c70a;hp=69a02b0c50d5c2117633241eb597d2beee0322b6;hpb=424a33720d61e1cdc0f8886000d4549857a6ee55;p=rust.git diff --git a/clippy_lints/src/non_expressive_names.rs b/clippy_lints/src/non_expressive_names.rs index 69a02b0c50d..7bdeec0a56f 100644 --- a/clippy_lints/src/non_expressive_names.rs +++ b/clippy_lints/src/non_expressive_names.rs @@ -1,62 +1,63 @@ -use rustc::lint::*; -use syntax::codemap::Span; -use syntax::symbol::LocalInternedString; +use crate::utils::{span_lint, span_lint_and_then}; +use rustc::lint::{EarlyContext, EarlyLintPass, LintArray, LintPass}; +use rustc::{declare_tool_lint, lint_array}; use syntax::ast::*; use syntax::attr; +use syntax::source_map::Span; +use syntax::symbol::LocalInternedString; use syntax::visit::{walk_block, walk_expr, walk_pat, Visitor}; -use crate::utils::{in_macro, span_lint, span_lint_and_then}; -/// **What it does:** Checks for names that are very similar and thus confusing. -/// -/// **Why is this bad?** It's hard to distinguish between names that differ only -/// by a single character. -/// -/// **Known problems:** None? -/// -/// **Example:** -/// ```rust -/// let checked_exp = something; -/// let checked_expr = something_else; -/// ``` declare_clippy_lint! { + /// **What it does:** Checks for names that are very similar and thus confusing. + /// + /// **Why is this bad?** It's hard to distinguish between names that differ only + /// by a single character. + /// + /// **Known problems:** None? + /// + /// **Example:** + /// ```ignore + /// let checked_exp = something; + /// let checked_expr = something_else; + /// ``` pub SIMILAR_NAMES, pedantic, "similarly named items and bindings" } -/// **What it does:** Checks for too many variables whose name consists of a -/// single character. -/// -/// **Why is this bad?** It's hard to memorize what a variable means without a -/// descriptive name. -/// -/// **Known problems:** None? -/// -/// **Example:** -/// ```rust -/// let (a, b, c, d, e, f, g) = (...); -/// ``` declare_clippy_lint! { + /// **What it does:** Checks for too many variables whose name consists of a + /// single character. + /// + /// **Why is this bad?** It's hard to memorize what a variable means without a + /// descriptive name. + /// + /// **Known problems:** None? + /// + /// **Example:** + /// ```ignore + /// let (a, b, c, d, e, f, g) = (...); + /// ``` pub MANY_SINGLE_CHAR_NAMES, style, "too many single character bindings" } -/// **What it does:** Checks if you have variables whose name consists of just -/// underscores and digits. -/// -/// **Why is this bad?** It's hard to memorize what a variable means without a -/// descriptive name. -/// -/// **Known problems:** None? -/// -/// **Example:** -/// ```rust -/// let _1 = 1; -/// let ___1 = 1; -/// let __1___2 = 11; -/// ``` declare_clippy_lint! { + /// **What it does:** Checks if you have variables whose name consists of just + /// underscores and digits. + /// + /// **Why is this bad?** It's hard to memorize what a variable means without a + /// descriptive name. + /// + /// **Known problems:** None? + /// + /// **Example:** + /// ```rust + /// let _1 = 1; + /// let ___1 = 1; + /// let __1___2 = 11; + /// ``` pub JUST_UNDERSCORES_AND_DIGITS, style, "unclear name" @@ -70,6 +71,10 @@ impl LintPass for NonExpressiveNames { fn get_lints(&self) -> LintArray { lint_array!(SIMILAR_NAMES, MANY_SINGLE_CHAR_NAMES, JUST_UNDERSCORES_AND_DIGITS) } + + fn name(&self) -> &'static str { + "NoneExpressiveNames" + } } struct ExistingName { @@ -88,7 +93,7 @@ struct SimilarNamesLocalVisitor<'a, 'tcx: 'a> { // this list contains lists of names that are allowed to be similar // the assumption is that no name is ever contained in multiple lists. -#[cfg_attr(rustfmt, rustfmt_skip)] +#[rustfmt::skip] const WHITELIST: &[&[&str]] = &[ &["parsed", "parser"], &["lhs", "rhs"], @@ -105,14 +110,19 @@ impl<'a, 'tcx: 'a, 'b> Visitor<'tcx> for SimilarNamesNameVisitor<'a, 'tcx, 'b> { fn visit_pat(&mut self, pat: &'tcx Pat) { match pat.node { PatKind::Ident(_, ident, _) => self.check_name(ident.span, ident.name), - PatKind::Struct(_, ref fields, _) => for field in fields { - if !field.node.is_shorthand { - self.visit_pat(&field.node.pat); + PatKind::Struct(_, ref fields, _) => { + for field in fields { + if !field.node.is_shorthand { + self.visit_pat(&field.node.pat); + } } }, _ => walk_pat(self, pat), } } + fn visit_mac(&mut self, _mac: &Mac) { + // do not check macs + } } fn get_whitelist(interned_name: &str) -> Option<&'static [&'static str]> { @@ -141,14 +151,15 @@ fn check_short_name(&mut self, c: char, span: Span) { self.0.cx, MANY_SINGLE_CHAR_NAMES, span, - &format!("{}th binding whose name is just one char", self.0.single_char_names.len()), + &format!( + "{}th binding whose name is just one char", + self.0.single_char_names.len() + ), ); } } + #[allow(clippy::too_many_lines)] fn check_name(&mut self, span: Span, name: Name) { - if in_macro(span) { - return; - } let interned_name = name.as_str(); if interned_name.chars().any(char::is_uppercase) { return; @@ -186,26 +197,19 @@ fn check_name(&mut self, span: Span, name: Name) { } else { let mut interned_chars = interned_name.chars(); let mut existing_chars = existing_name.interned.chars(); - let first_i = interned_chars - .next() - .expect("we know we have at least one char"); - let first_e = existing_chars - .next() - .expect("we know we have at least one char"); + let first_i = interned_chars.next().expect("we know we have at least one char"); + let first_e = existing_chars.next().expect("we know we have at least one char"); let eq_or_numeric = |(a, b): (char, char)| a == b || a.is_numeric() && b.is_numeric(); if eq_or_numeric((first_i, first_e)) { - let last_i = interned_chars - .next_back() - .expect("we know we have at least two chars"); - let last_e = existing_chars - .next_back() - .expect("we know we have at least two chars"); + let last_i = interned_chars.next_back().expect("we know we have at least two chars"); + let last_e = existing_chars.next_back().expect("we know we have at least two chars"); if eq_or_numeric((last_i, last_e)) { if interned_chars .zip(existing_chars) .filter(|&ie| !eq_or_numeric(ie)) - .count() != 1 + .count() + != 1 { continue; } @@ -216,7 +220,8 @@ fn check_name(&mut self, span: Span, name: Name) { let second_last_e = existing_chars .next_back() .expect("we know we have at least three chars"); - if !eq_or_numeric((second_last_i, second_last_e)) || second_last_i == '_' + if !eq_or_numeric((second_last_i, second_last_e)) + || second_last_i == '_' || !interned_chars.zip(existing_chars).all(eq_or_numeric) { // allowed similarity foo_x, foo_y @@ -226,20 +231,17 @@ fn check_name(&mut self, span: Span, name: Name) { split_at = interned_name.char_indices().rev().next().map(|(i, _)| i); } } else { - let second_i = interned_chars - .next() - .expect("we know we have at least two chars"); - let second_e = existing_chars - .next() - .expect("we know we have at least two chars"); - if !eq_or_numeric((second_i, second_e)) || second_i == '_' + let second_i = interned_chars.next().expect("we know we have at least two chars"); + let second_e = existing_chars.next().expect("we know we have at least two chars"); + if !eq_or_numeric((second_i, second_e)) + || second_i == '_' || !interned_chars.zip(existing_chars).all(eq_or_numeric) { // allowed similarity x_foo, y_foo // or too many chars differ (x_foo, y_boo) or (xfoo, yboo) continue; } - split_at = interned_name.chars().next().map(|c| c.len_utf8()); + split_at = interned_name.chars().next().map(char::len_utf8); } } span_lint_and_then( @@ -308,24 +310,26 @@ fn visit_arm(&mut self, arm: &'tcx Arm) { fn visit_item(&mut self, _: &Item) { // do not recurse into inner items } + fn visit_mac(&mut self, _mac: &Mac) { + // do not check macs + } } impl EarlyLintPass for NonExpressiveNames { - fn check_item(&mut self, cx: &EarlyContext, item: &Item) { - if let ItemKind::Fn(ref decl, _, _, _, _, ref blk) = item.node { + fn check_item(&mut self, cx: &EarlyContext<'_>, item: &Item) { + if let ItemKind::Fn(ref decl, _, _, ref blk) = item.node { do_check(self, cx, &item.attrs, decl, blk); } } - fn check_impl_item(&mut self, cx: &EarlyContext, item: &ImplItem) { + fn check_impl_item(&mut self, cx: &EarlyContext<'_>, item: &ImplItem) { if let ImplItemKind::Method(ref sig, ref blk) = item.node { do_check(self, cx, &item.attrs, &sig.decl, blk); } } - } -fn do_check(lint: &mut NonExpressiveNames, cx: &EarlyContext, attrs: &[Attribute], decl: &FnDecl, blk: &Block) { +fn do_check(lint: &mut NonExpressiveNames, cx: &EarlyContext<'_>, attrs: &[Attribute], decl: &FnDecl, blk: &Block) { if !attr::contains_name(attrs, "test") { let mut visitor = SimilarNamesLocalVisitor { names: Vec::new(),