2 import_assets::{ImportAssets, ImportCandidate},
3 insert_use::{insert_use, ImportScope},
6 use syntax::{ast, AstNode, SyntaxNode};
8 use crate::{AssistContext, AssistId, AssistKind, Assists, GroupLabel};
10 // Feature: Auto Import
12 // Using the `auto-import` assist it is possible to insert missing imports for unresolved items.
13 // When inserting an import it will do so in a structured manner by keeping imports grouped,
14 // separated by a newline in the following order:
18 // - Current Crate, paths prefixed by `crate`
19 // - Current Module, paths prefixed by `self`
20 // - Super Module, paths prefixed by `super`
26 // use itertools::Itertools;
29 // use crate::utils::insert_use;
31 // use self::auto_import;
33 // use super::AssistContext;
36 // .Import Granularity
38 // It is possible to configure how use-trees are merged with the `importGranularity` setting.
39 // It has the following configurations:
41 // - `crate`: Merge imports from the same crate into a single use statement. This kind of
42 // nesting is only supported in Rust versions later than 1.24.
43 // - `module`: Merge imports from the same module into a single use statement.
44 // - `item`: Don't merge imports at all, creating one import per item.
45 // - `preserve`: Do not change the granularity of any imports. For auto-import this has the same
48 // In `VS Code` the configuration for this is `rust-analyzer.assist.importGranularity`.
52 // The style of imports in the same crate is configurable through the `importPrefix` setting.
53 // It has the following configurations:
55 // - `by_crate`: This setting will force paths to be always absolute, starting with the `crate`
56 // prefix, unless the item is defined outside of the current crate.
57 // - `by_self`: This setting will force paths that are relative to the current module to always
58 // start with `self`. This will result in paths that always start with either `crate`, `self`,
59 // `super` or an extern crate identifier.
60 // - `plain`: This setting does not impose any restrictions in imports.
62 // In `VS Code` the configuration for this is `rust-analyzer.assist.importPrefix`.
64 // image::https://user-images.githubusercontent.com/48062697/113020673-b85be580-917a-11eb-9022-59585f35d4f8.gif[]
66 // Assist: auto_import
68 // If the name is unresolved, provides all possible imports for it.
72 // let map = HashMap$0::new();
74 // # pub mod std { pub mod collections { pub struct HashMap { } } }
78 // use std::collections::HashMap;
81 // let map = HashMap::new();
83 // # pub mod std { pub mod collections { pub struct HashMap { } } }
85 pub(crate) fn auto_import(acc: &mut Assists, ctx: &AssistContext) -> Option<()> {
86 let (import_assets, syntax_under_caret) = find_importable_node(ctx)?;
87 let mut proposed_imports =
88 import_assets.search_for_imports(&ctx.sema, ctx.config.insert_use.prefix_kind);
89 if proposed_imports.is_empty() {
93 let range = ctx.sema.original_range(&syntax_under_caret).range;
94 let group_label = group_label(import_assets.import_candidate());
95 let scope = ImportScope::find_insert_use_container_with_macros(&syntax_under_caret, &ctx.sema)?;
97 // we aren't interested in different namespaces
98 proposed_imports.dedup_by(|a, b| a.import_path == b.import_path);
99 for import in proposed_imports {
102 AssistId("auto_import", AssistKind::QuickFix),
103 format!("Import `{}`", import.import_path),
106 let scope = match scope.clone() {
107 ImportScope::File(it) => ImportScope::File(builder.make_mut(it)),
108 ImportScope::Module(it) => ImportScope::Module(builder.make_mut(it)),
109 ImportScope::Block(it) => ImportScope::Block(builder.make_mut(it)),
111 insert_use(&scope, mod_path_to_ast(&import.import_path), &ctx.config.insert_use);
118 pub(super) fn find_importable_node(ctx: &AssistContext) -> Option<(ImportAssets, SyntaxNode)> {
119 if let Some(path_under_caret) = ctx.find_node_at_offset_with_descend::<ast::Path>() {
120 ImportAssets::for_exact_path(&path_under_caret, &ctx.sema)
121 .zip(Some(path_under_caret.syntax().clone()))
122 } else if let Some(method_under_caret) =
123 ctx.find_node_at_offset_with_descend::<ast::MethodCallExpr>()
125 ImportAssets::for_method_call(&method_under_caret, &ctx.sema)
126 .zip(Some(method_under_caret.syntax().clone()))
127 } else if let Some(pat) = ctx
128 .find_node_at_offset_with_descend::<ast::IdentPat>()
129 .filter(ast::IdentPat::is_simple_ident)
131 ImportAssets::for_ident_pat(&pat, &ctx.sema).zip(Some(pat.syntax().clone()))
137 fn group_label(import_candidate: &ImportCandidate) -> GroupLabel {
138 let name = match import_candidate {
139 ImportCandidate::Path(candidate) => format!("Import {}", candidate.name.text()),
140 ImportCandidate::TraitAssocItem(candidate) => {
141 format!("Import a trait for item {}", candidate.assoc_item_name.text())
143 ImportCandidate::TraitMethod(candidate) => {
144 format!("Import a trait for method {}", candidate.assoc_item_name.text())
154 use crate::tests::{check_assist, check_assist_not_applicable, check_assist_target};
157 fn applicable_when_found_an_import_partial() {
163 pub struct Formatter;
174 pub struct Formatter;
178 use std::fmt::{self, Formatter};
186 fn applicable_when_found_an_import() {
193 pub struct PubStruct;
197 use PubMod::PubStruct;
202 pub struct PubStruct;
209 fn applicable_when_found_an_import_in_macros() {
214 ($i:ident) => { fn foo(a: $i) {} }
219 pub struct PubStruct;
223 use PubMod::PubStruct;
226 ($i:ident) => { fn foo(a: $i) {} }
231 pub struct PubStruct;
238 fn applicable_when_found_multiple_imports() {
245 pub struct PubStruct;
248 pub struct PubStruct;
251 pub struct PubStruct;
255 use PubMod3::PubStruct;
260 pub struct PubStruct;
263 pub struct PubStruct;
266 pub struct PubStruct;
273 fn not_applicable_for_already_imported_types() {
274 check_assist_not_applicable(
277 use PubMod::PubStruct;
282 pub struct PubStruct;
289 fn not_applicable_for_types_with_private_paths() {
290 check_assist_not_applicable(
296 struct PrivateStruct;
303 fn not_applicable_when_no_imports_found() {
304 check_assist_not_applicable(
312 fn not_applicable_in_import_statements() {
313 check_assist_not_applicable(
319 pub struct PubStruct;
325 fn function_import() {
332 pub fn test_function() {};
336 use PubMod::test_function;
341 pub fn test_function() {};
352 //- /lib.rs crate:crate_with_macro
358 //- /main.rs crate:main deps:crate_with_macro
363 r"use crate_with_macro::foo;
373 fn auto_import_target() {
378 group_label: Option<$0GroupLabel>,
381 mod m { pub struct GroupLabel; }
388 fn not_applicable_when_path_start_is_imported() {
389 check_assist_not_applicable(
395 pub struct TestStruct;
402 mod2::mod3::TestStruct$0
409 fn not_applicable_for_imported_function() {
410 check_assist_not_applicable(
414 pub fn test_function() {}
417 use test_mod::test_function;
426 fn associated_struct_function() {
431 pub struct TestStruct {}
433 pub fn test_function() {}
438 TestStruct::test_function$0
442 use test_mod::TestStruct;
445 pub struct TestStruct {}
447 pub fn test_function() {}
452 TestStruct::test_function
459 fn associated_struct_const() {
464 pub struct TestStruct {}
466 const TEST_CONST: u8 = 42;
471 TestStruct::TEST_CONST$0
475 use test_mod::TestStruct;
478 pub struct TestStruct {}
480 const TEST_CONST: u8 = 42;
485 TestStruct::TEST_CONST
492 fn associated_trait_function() {
497 pub trait TestTrait {
500 pub struct TestStruct {}
501 impl TestTrait for TestStruct {
502 fn test_function() {}
507 test_mod::TestStruct::test_function$0
511 use test_mod::TestTrait;
514 pub trait TestTrait {
517 pub struct TestStruct {}
518 impl TestTrait for TestStruct {
519 fn test_function() {}
524 test_mod::TestStruct::test_function
531 fn not_applicable_for_imported_trait_for_function() {
532 check_assist_not_applicable(
536 pub trait TestTrait {
539 pub trait TestTrait2 {
546 impl TestTrait2 for TestEnum {
547 fn test_function() {}
549 impl TestTrait for TestEnum {
550 fn test_function() {}
554 use test_mod::TestTrait2;
556 test_mod::TestEnum::test_function$0;
563 fn associated_trait_const() {
568 pub trait TestTrait {
569 const TEST_CONST: u8;
571 pub struct TestStruct {}
572 impl TestTrait for TestStruct {
573 const TEST_CONST: u8 = 42;
578 test_mod::TestStruct::TEST_CONST$0
582 use test_mod::TestTrait;
585 pub trait TestTrait {
586 const TEST_CONST: u8;
588 pub struct TestStruct {}
589 impl TestTrait for TestStruct {
590 const TEST_CONST: u8 = 42;
595 test_mod::TestStruct::TEST_CONST
602 fn not_applicable_for_imported_trait_for_const() {
603 check_assist_not_applicable(
607 pub trait TestTrait {
608 const TEST_CONST: u8;
610 pub trait TestTrait2 {
611 const TEST_CONST: f64;
617 impl TestTrait2 for TestEnum {
618 const TEST_CONST: f64 = 42.0;
620 impl TestTrait for TestEnum {
621 const TEST_CONST: u8 = 42;
625 use test_mod::TestTrait2;
627 test_mod::TestEnum::TEST_CONST$0;
639 pub trait TestTrait {
640 fn test_method(&self);
642 pub struct TestStruct {}
643 impl TestTrait for TestStruct {
644 fn test_method(&self) {}
649 let test_struct = test_mod::TestStruct {};
650 test_struct.test_meth$0od()
654 use test_mod::TestTrait;
657 pub trait TestTrait {
658 fn test_method(&self);
660 pub struct TestStruct {}
661 impl TestTrait for TestStruct {
662 fn test_method(&self) {}
667 let test_struct = test_mod::TestStruct {};
668 test_struct.test_method()
675 fn trait_method_cross_crate() {
679 //- /main.rs crate:main deps:dep
681 let test_struct = dep::test_mod::TestStruct {};
682 test_struct.test_meth$0od()
684 //- /dep.rs crate:dep
686 pub trait TestTrait {
687 fn test_method(&self);
689 pub struct TestStruct {}
690 impl TestTrait for TestStruct {
691 fn test_method(&self) {}
696 use dep::test_mod::TestTrait;
699 let test_struct = dep::test_mod::TestStruct {};
700 test_struct.test_method()
707 fn assoc_fn_cross_crate() {
711 //- /main.rs crate:main deps:dep
713 dep::test_mod::TestStruct::test_func$0tion
715 //- /dep.rs crate:dep
717 pub trait TestTrait {
720 pub struct TestStruct {}
721 impl TestTrait for TestStruct {
722 fn test_function() {}
727 use dep::test_mod::TestTrait;
730 dep::test_mod::TestStruct::test_function
737 fn assoc_const_cross_crate() {
741 //- /main.rs crate:main deps:dep
743 dep::test_mod::TestStruct::CONST$0
745 //- /dep.rs crate:dep
747 pub trait TestTrait {
750 pub struct TestStruct {}
751 impl TestTrait for TestStruct {
752 const CONST: bool = true;
757 use dep::test_mod::TestTrait;
760 dep::test_mod::TestStruct::CONST
767 fn assoc_fn_as_method_cross_crate() {
768 check_assist_not_applicable(
771 //- /main.rs crate:main deps:dep
773 let test_struct = dep::test_mod::TestStruct {};
774 test_struct.test_func$0tion()
776 //- /dep.rs crate:dep
778 pub trait TestTrait {
781 pub struct TestStruct {}
782 impl TestTrait for TestStruct {
783 fn test_function() {}
791 fn private_trait_cross_crate() {
792 check_assist_not_applicable(
795 //- /main.rs crate:main deps:dep
797 let test_struct = dep::test_mod::TestStruct {};
798 test_struct.test_meth$0od()
800 //- /dep.rs crate:dep
803 fn test_method(&self);
805 pub struct TestStruct {}
806 impl TestTrait for TestStruct {
807 fn test_method(&self) {}
815 fn not_applicable_for_imported_trait_for_method() {
816 check_assist_not_applicable(
820 pub trait TestTrait {
821 fn test_method(&self);
823 pub trait TestTrait2 {
824 fn test_method(&self);
830 impl TestTrait2 for TestEnum {
831 fn test_method(&self) {}
833 impl TestTrait for TestEnum {
834 fn test_method(&self) {}
838 use test_mod::TestTrait2;
840 let one = test_mod::TestEnum::One;
852 //- /lib.rs crate:dep
855 //- /main.rs crate:main deps:dep
871 // Tests that only imports whose last segment matches the identifier get suggested.
875 //- /lib.rs crate:dep
880 pub fn panic_fmt() {}
882 //- /main.rs crate:main deps:dep
885 impl f$0mt::Display for S {}
891 impl fmt::Display for S {}
897 fn macro_generated() {
898 // Tests that macro-generated items are suggested from external crates.
902 //- /lib.rs crate:dep
911 //- /main.rs crate:main deps:dep
927 // Tests that differently cased names don't interfere and we only suggest the matching one.
931 //- /lib.rs crate:dep
935 //- /main.rs crate:main deps:dep
983 fn uses_abs_path_with_extern_crate_clash() {
984 cov_mark::check!(ambiguous_crate_start);
988 //- /main.rs crate:main deps:foo
994 //- /foo.rs crate:foo
1010 fn works_on_ident_patterns() {