Add import_rename lint, this adds a field on the Conf struct

rust-lang · Jun 20, 2021 · 8b44012 · 8b44012
1 parent 3120b09
commit 8b44012
Show file tree

Hide file tree

Showing 8 changed files with 172 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2562,6 +2562,7 @@ Released 2018-09-13
 [`implicit_hasher`]: https://rust-lang.github.io/rust-clippy/master/index.html#implicit_hasher
 [`implicit_return`]: https://rust-lang.github.io/rust-clippy/master/index.html#implicit_return
 [`implicit_saturating_sub`]: https://rust-lang.github.io/rust-clippy/master/index.html#implicit_saturating_sub
+[`import_rename`]: https://rust-lang.github.io/rust-clippy/master/index.html#import_rename
 [`imprecise_flops`]: https://rust-lang.github.io/rust-clippy/master/index.html#imprecise_flops
 [`inconsistent_digit_grouping`]: https://rust-lang.github.io/rust-clippy/master/index.html#inconsistent_digit_grouping
 [`inconsistent_struct_constructor`]: https://rust-lang.github.io/rust-clippy/master/index.html#inconsistent_struct_constructor

diff --git a/clippy_lints/src/import_rename.rs b/clippy_lints/src/import_rename.rs
@@ -0,0 +1,98 @@
+use clippy_utils::{diagnostics::span_lint_and_sugg, source::snippet_opt};
+
+use rustc_data_structures::fx::FxHashMap;
+use rustc_errors::Applicability;
+use rustc_hir::{def::Res, def_id::DefId, Crate, Item, ItemKind, UseKind};
+use rustc_lint::{LateContext, LateLintPass};
+use rustc_session::{declare_tool_lint, impl_lint_pass};
+use rustc_span::Symbol;
+
+use crate::utils::conf::Rename;
+
+declare_clippy_lint! {
+    /// **What it does:** Checks that any import matching `import_renames` is renamed.
+    ///
+    /// **Why is this bad?** This is bad for some items because their defined names are
+    /// too vauge outside of their defining scope.
+    ///
+    /// **Known problems:** None
+    ///
+    /// **Example:**
+    ///
+    /// An example clippy.toml configuration:
+    /// ```toml
+    /// # clippy.toml
+    /// import-renames = [ {path = "serde_json::Value", rename = "JsonValue" }]
+    /// ```
+    ///
+    /// ```rust,ignore
+    /// use serde_json::Value;
+    /// ```
+    /// Use instead:
+    /// ```rust,ignore
+    /// use serde_json::Value as JsonValue;
+    /// ```
+    pub IMPORT_RENAME,
+    restriction,
+    "enforce import renames"
+}
+
+pub struct ImportRename {
+    conf_renames: Vec<Rename>,
+    renames: FxHashMap<DefId, Symbol>,
+}
+
+impl ImportRename {
+    pub fn new(conf_renames: Vec<Rename>) -> Self {
+        Self {
+            conf_renames,
+            renames: FxHashMap::default(),
+        }
+    }
+}
+
+impl_lint_pass!(ImportRename => [IMPORT_RENAME]);
+
+impl LateLintPass<'_> for ImportRename {
+    fn check_crate(&mut self, cx: &LateContext<'_>, _: &Crate<'_>) {
+        for Rename { path, rename } in &self.conf_renames {
+            if let Res::Def(_, id) = clippy_utils::path_to_res(cx, &path.split("::").collect::<Vec<_>>()) {
+                self.renames.insert(id, Symbol::intern(rename));
+            }
+        }
+    }
+
+    fn check_item(&mut self, cx: &LateContext<'_>, item: &Item<'_>) {
+        if_chain! {
+            if let ItemKind::Use(path, UseKind::Single) = &item.kind;
+            if let Res::Def(_, id) = path.res;
+            if let Some(snip) = snippet_opt(cx, item.span);
+            if let Some(name) = self.renames.get(&id);
+            // Remove semicolon since it is not present for nested imports
+            if !snip.replace(";", "").ends_with(&*name.as_str());
+            then {
+                let import = if snip.ends_with(';') {
+                    snip.split_whitespace().take(2).collect::<Vec<_>>().join(" ").replace(";", "")
+                } else if snip.contains("as") {
+                    snip.split_whitespace().take(1).collect::<Vec<_>>().join(" ")
+                } else {
+                    snip.clone()
+                };
+                span_lint_and_sugg(
+                    cx,
+                    IMPORT_RENAME,
+                    item.span,
+                    "this import should be renamed",
+                    "try",
+                    format!(
+                        "{} as {}{}",
+                        import,
+                        name,
+                        if snip.ends_with(';') { ";" } else { "" },
+                    ),
+                    Applicability::MachineApplicable,
+                );
+            }
+        }
+    }
+}
diff --git a/clippy_lints/src/lib.rs b/clippy_lints/src/lib.rs
@@ -226,6 +226,7 @@ mod if_then_some_else_none;
 mod implicit_hasher;
 mod implicit_return;
 mod implicit_saturating_sub;
+mod import_rename;
 mod inconsistent_struct_constructor;
 mod indexing_slicing;
 mod infinite_iter;
@@ -648,6 +649,7 @@ pub fn register_plugins(store: &mut rustc_lint::LintStore, sess: &Session, conf:
         implicit_hasher::IMPLICIT_HASHER,
         implicit_return::IMPLICIT_RETURN,
         implicit_saturating_sub::IMPLICIT_SATURATING_SUB,
+        import_rename::IMPORT_RENAME,
         inconsistent_struct_constructor::INCONSISTENT_STRUCT_CONSTRUCTOR,
         indexing_slicing::INDEXING_SLICING,
         indexing_slicing::OUT_OF_BOUNDS_INDEXING,
@@ -1000,6 +1002,7 @@ pub fn register_plugins(store: &mut rustc_lint::LintStore, sess: &Session, conf:
         LintId::of(float_literal::LOSSY_FLOAT_LITERAL),
         LintId::of(if_then_some_else_none::IF_THEN_SOME_ELSE_NONE),
         LintId::of(implicit_return::IMPLICIT_RETURN),
+        LintId::of(import_rename::IMPORT_RENAME),
         LintId::of(indexing_slicing::INDEXING_SLICING),
         LintId::of(inherent_impl::MULTIPLE_INHERENT_IMPL),
         LintId::of(integer_division::INTEGER_DIVISION),
@@ -2077,6 +2080,8 @@ pub fn register_plugins(store: &mut rustc_lint::LintStore, sess: &Session, conf:
     store.register_late_pass(|| box unused_async::UnusedAsync);
     let disallowed_types = conf.disallowed_types.iter().cloned().collect::<FxHashSet<_>>();
     store.register_late_pass(move || box disallowed_type::DisallowedType::new(&disallowed_types));
+    let import_renames = conf.import_renames.clone();
+    store.register_late_pass(move || box import_rename::ImportRename::new(import_renames.clone()));
 
 }
 

diff --git a/clippy_lints/src/utils/conf.rs b/clippy_lints/src/utils/conf.rs
@@ -8,6 +8,13 @@ use std::error::Error;
 use std::path::{Path, PathBuf};
 use std::{env, fmt, fs, io};
 
+/// Holds information used by `IMPORT_RENAME` lint.
+#[derive(Clone, Debug, Deserialize, PartialEq, Eq, Hash)]
+pub struct Rename {
+    pub path: String,
+    pub rename: String,
+}
+
 /// Conf with parse errors
 #[derive(Default)]
 pub struct TryConf {
@@ -201,9 +208,11 @@ define_Conf! {
     /// Lint: NONSTANDARD_MACRO_BRACES. Enforce the named macros always use the braces specified.
     ///
     /// A `MacroMatcher` can be added like so `{ name = "macro_name", brace = "(" }`.
-    /// If the macro is could be used with a full path two `MacroMatcher`s have to be added one
+    /// If the macro could be used with a full path two `MacroMatcher`s have to be added one
     /// with the full path `crate_name::macro_name` and one with just the macro name.
     (standard_macro_braces: Vec<crate::nonstandard_macro_braces::MacroMatcher> = Vec::new()),
+    /// Lint: IMPORT_RENAMES. The list of imports to always rename, a fully qualified path followed by the rename.
+    (import_renames: Vec<crate::utils::conf::Rename> = Vec::new()),
 }
 
 /// Search for the configuration file.

diff --git a/tests/ui-toml/toml_import_rename/clippy.toml b/tests/ui-toml/toml_import_rename/clippy.toml
@@ -0,0 +1,9 @@
+import-renames = [
+    { path = "std::option::Option", rename = "Maybe" },
+    { path = "std::process::Child", rename = "Kid" },
+    { path = "std::process::exit", rename = "goodbye" },
+    { path = "std::collections::BTreeMap", rename = "Map" },
+    { path = "std::clone", rename = "foo" },
+    { path = "std::thread::sleep", rename = "thread_sleep" },
+    { path = "std::any::type_name", rename = "ident" }
+]
diff --git a/tests/ui-toml/toml_import_rename/conf_import_rename.rs b/tests/ui-toml/toml_import_rename/conf_import_rename.rs
@@ -0,0 +1,14 @@
+#![warn(clippy::import_rename)]
+
+use std::alloc as colla;
+use std::option::Option as Maybe;
+use std::process::{exit as wrong_exit, Child as Kid};
+use std::thread::sleep;
+use std::{
+    any::{type_name, Any},
+    clone,
+};
+
+fn main() {
+    use std::collections::BTreeMap as OopsWrongRename;
+}
diff --git a/tests/ui-toml/toml_import_rename/conf_import_rename.stderr b/tests/ui-toml/toml_import_rename/conf_import_rename.stderr
@@ -0,0 +1,34 @@
+error: this import should be renamed
+  --> $DIR/conf_import_rename.rs:5:20
+   |
+LL | use std::process::{exit as wrong_exit, Child as Kid};
+   |                    ^^^^^^^^^^^^^^^^^^ help: try: `exit as goodbye`
+   |
+   = note: `-D clippy::import-rename` implied by `-D warnings`
+
+error: this import should be renamed
+  --> $DIR/conf_import_rename.rs:6:1
+   |
+LL | use std::thread::sleep;
+   | ^^^^^^^^^^^^^^^^^^^^^^^ help: try: `use std::thread::sleep as thread_sleep;`
+
+error: this import should be renamed
+  --> $DIR/conf_import_rename.rs:8:11
+   |
+LL |     any::{type_name, Any},
+   |           ^^^^^^^^^ help: try: `type_name as ident`
+
+error: this import should be renamed
+  --> $DIR/conf_import_rename.rs:9:5
+   |
+LL |     clone,
+   |     ^^^^^ help: try: `clone as foo`
+
+error: this import should be renamed
+  --> $DIR/conf_import_rename.rs:13:5
+   |
+LL |     use std::collections::BTreeMap as OopsWrongRename;
+   |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: try: `use std::collections::BTreeMap as Map;`
+
+error: aborting due to 5 previous errors
+
diff --git a/tests/ui-toml/toml_unknown_key/conf_unknown_key.stderr b/tests/ui-toml/toml_unknown_key/conf_unknown_key.stderr
@@ -1,4 +1,4 @@
-error: error reading Clippy's configuration file `$DIR/clippy.toml`: unknown field `foobar`, expected one of `avoid-breaking-exported-api`, `msrv`, `blacklisted-names`, `cognitive-complexity-threshold`, `cyclomatic-complexity-threshold`, `doc-valid-idents`, `too-many-arguments-threshold`, `type-complexity-threshold`, `single-char-binding-names-threshold`, `too-large-for-stack`, `enum-variant-name-threshold`, `enum-variant-size-threshold`, `verbose-bit-mask-threshold`, `literal-representation-threshold`, `trivial-copy-size-limit`, `pass-by-value-size-limit`, `too-many-lines-threshold`, `array-size-threshold`, `vec-box-size-threshold`, `max-trait-bounds`, `max-struct-bools`, `max-fn-params-bools`, `warn-on-all-wildcard-imports`, `disallowed-methods`, `disallowed-types`, `unreadable-literal-lint-fractions`, `upper-case-acronyms-aggressive`, `cargo-ignore-publish`, `standard-macro-braces`, `third-party` at line 5 column 1
+error: error reading Clippy's configuration file `$DIR/clippy.toml`: unknown field `foobar`, expected one of `avoid-breaking-exported-api`, `msrv`, `blacklisted-names`, `cognitive-complexity-threshold`, `cyclomatic-complexity-threshold`, `doc-valid-idents`, `too-many-arguments-threshold`, `type-complexity-threshold`, `single-char-binding-names-threshold`, `too-large-for-stack`, `enum-variant-name-threshold`, `enum-variant-size-threshold`, `verbose-bit-mask-threshold`, `literal-representation-threshold`, `trivial-copy-size-limit`, `pass-by-value-size-limit`, `too-many-lines-threshold`, `array-size-threshold`, `vec-box-size-threshold`, `max-trait-bounds`, `max-struct-bools`, `max-fn-params-bools`, `warn-on-all-wildcard-imports`, `disallowed-methods`, `disallowed-types`, `unreadable-literal-lint-fractions`, `upper-case-acronyms-aggressive`, `cargo-ignore-publish`, `standard-macro-braces`, `import-renames`, `third-party` at line 5 column 1
 
 error: aborting due to previous error