diff options
Diffstat (limited to 'crates/ra_assists')
-rw-r--r-- | crates/ra_assists/src/assist_ctx.rs | 2 | ||||
-rw-r--r-- | crates/ra_assists/src/assists/add_explicit_type.rs | 26 | ||||
-rw-r--r-- | crates/ra_assists/src/assists/auto_import.rs | 222 | ||||
-rw-r--r-- | crates/ra_assists/src/assists/inline_local_variable.rs | 65 | ||||
-rw-r--r-- | crates/ra_assists/src/doc_tests.rs | 4 | ||||
-rw-r--r-- | crates/ra_assists/src/doc_tests/generated.rs | 19 | ||||
-rw-r--r-- | crates/ra_assists/src/lib.rs | 179 |
7 files changed, 475 insertions, 42 deletions
diff --git a/crates/ra_assists/src/assist_ctx.rs b/crates/ra_assists/src/assist_ctx.rs index 43f0d664b..2ab65ab99 100644 --- a/crates/ra_assists/src/assist_ctx.rs +++ b/crates/ra_assists/src/assist_ctx.rs | |||
@@ -101,7 +101,6 @@ impl<'a, DB: HirDatabase> AssistCtx<'a, DB> { | |||
101 | Some(assist) | 101 | Some(assist) |
102 | } | 102 | } |
103 | 103 | ||
104 | #[allow(dead_code)] // will be used for auto import assist with multiple actions | ||
105 | pub(crate) fn add_assist_group( | 104 | pub(crate) fn add_assist_group( |
106 | self, | 105 | self, |
107 | id: AssistId, | 106 | id: AssistId, |
@@ -168,7 +167,6 @@ pub(crate) struct ActionBuilder { | |||
168 | } | 167 | } |
169 | 168 | ||
170 | impl ActionBuilder { | 169 | impl ActionBuilder { |
171 | #[allow(dead_code)] | ||
172 | /// Adds a custom label to the action, if it needs to be different from the assist label | 170 | /// Adds a custom label to the action, if it needs to be different from the assist label |
173 | pub(crate) fn label(&mut self, label: impl Into<String>) { | 171 | pub(crate) fn label(&mut self, label: impl Into<String>) { |
174 | self.label = Some(label.into()) | 172 | self.label = Some(label.into()) |
diff --git a/crates/ra_assists/src/assists/add_explicit_type.rs b/crates/ra_assists/src/assists/add_explicit_type.rs index f9f826b88..38a351a54 100644 --- a/crates/ra_assists/src/assists/add_explicit_type.rs +++ b/crates/ra_assists/src/assists/add_explicit_type.rs | |||
@@ -1,7 +1,7 @@ | |||
1 | use hir::{db::HirDatabase, HirDisplay}; | 1 | use hir::{db::HirDatabase, HirDisplay}; |
2 | use ra_syntax::{ | 2 | use ra_syntax::{ |
3 | ast::{self, AstNode, LetStmt, NameOwner}, | 3 | ast::{self, AstNode, LetStmt, NameOwner}, |
4 | T, | 4 | TextRange, T, |
5 | }; | 5 | }; |
6 | 6 | ||
7 | use crate::{Assist, AssistCtx, AssistId}; | 7 | use crate::{Assist, AssistCtx, AssistId}; |
@@ -34,6 +34,14 @@ pub(crate) fn add_explicit_type(ctx: AssistCtx<impl HirDatabase>) -> Option<Assi | |||
34 | // The binding must have a name | 34 | // The binding must have a name |
35 | let name = pat.name()?; | 35 | let name = pat.name()?; |
36 | let name_range = name.syntax().text_range(); | 36 | let name_range = name.syntax().text_range(); |
37 | // Assist should only be applicable if cursor is between 'let' and '=' | ||
38 | let stmt_range = stmt.syntax().text_range(); | ||
39 | let eq_range = stmt.eq_token()?.text_range(); | ||
40 | let let_range = TextRange::from_to(stmt_range.start(), eq_range.start()); | ||
41 | let cursor_in_range = ctx.frange.range.is_subrange(&let_range); | ||
42 | if !cursor_in_range { | ||
43 | return None; | ||
44 | } | ||
37 | // Assist not applicable if the type has already been specified | 45 | // Assist not applicable if the type has already been specified |
38 | if stmt.syntax().children_with_tokens().any(|child| child.kind() == T![:]) { | 46 | if stmt.syntax().children_with_tokens().any(|child| child.kind() == T![:]) { |
39 | return None; | 47 | return None; |
@@ -109,4 +117,20 @@ mod tests { | |||
109 | fn add_explicit_type_not_applicable_if_specified_ty_is_tuple() { | 117 | fn add_explicit_type_not_applicable_if_specified_ty_is_tuple() { |
110 | check_assist_not_applicable(add_explicit_type, "fn f() { let a<|>: (i32, i32) = (3, 4); }"); | 118 | check_assist_not_applicable(add_explicit_type, "fn f() { let a<|>: (i32, i32) = (3, 4); }"); |
111 | } | 119 | } |
120 | |||
121 | #[test] | ||
122 | fn add_explicit_type_not_applicable_if_cursor_after_equals() { | ||
123 | check_assist_not_applicable( | ||
124 | add_explicit_type, | ||
125 | "fn f() {let a =<|> match 1 {2 => 3, 3 => 5};}", | ||
126 | ) | ||
127 | } | ||
128 | |||
129 | #[test] | ||
130 | fn add_explicit_type_not_applicable_if_cursor_before_let() { | ||
131 | check_assist_not_applicable( | ||
132 | add_explicit_type, | ||
133 | "fn f() <|>{let a = match 1 {2 => 3, 3 => 5};}", | ||
134 | ) | ||
135 | } | ||
112 | } | 136 | } |
diff --git a/crates/ra_assists/src/assists/auto_import.rs b/crates/ra_assists/src/assists/auto_import.rs new file mode 100644 index 000000000..9163cc662 --- /dev/null +++ b/crates/ra_assists/src/assists/auto_import.rs | |||
@@ -0,0 +1,222 @@ | |||
1 | use hir::db::HirDatabase; | ||
2 | use ra_syntax::{ | ||
3 | ast::{self, AstNode}, | ||
4 | SmolStr, SyntaxElement, | ||
5 | SyntaxKind::{NAME_REF, USE_ITEM}, | ||
6 | SyntaxNode, | ||
7 | }; | ||
8 | |||
9 | use crate::{ | ||
10 | assist_ctx::{ActionBuilder, Assist, AssistCtx}, | ||
11 | auto_import_text_edit, AssistId, ImportsLocator, | ||
12 | }; | ||
13 | |||
14 | // Assist: auto_import | ||
15 | // | ||
16 | // If the name is unresolved, provides all possible imports for it. | ||
17 | // | ||
18 | // ``` | ||
19 | // fn main() { | ||
20 | // let map = HashMap<|>::new(); | ||
21 | // } | ||
22 | // ``` | ||
23 | // -> | ||
24 | // ``` | ||
25 | // use std::collections::HashMap; | ||
26 | // | ||
27 | // fn main() { | ||
28 | // let map = HashMap<|>::new(); | ||
29 | // } | ||
30 | // ``` | ||
31 | pub(crate) fn auto_import<F: ImportsLocator>( | ||
32 | ctx: AssistCtx<impl HirDatabase>, | ||
33 | imports_locator: &mut F, | ||
34 | ) -> Option<Assist> { | ||
35 | let path: ast::Path = ctx.find_node_at_offset()?; | ||
36 | let module = path.syntax().ancestors().find_map(ast::Module::cast); | ||
37 | let position = match module.and_then(|it| it.item_list()) { | ||
38 | Some(item_list) => item_list.syntax().clone(), | ||
39 | None => { | ||
40 | let current_file = path.syntax().ancestors().find_map(ast::SourceFile::cast)?; | ||
41 | current_file.syntax().clone() | ||
42 | } | ||
43 | }; | ||
44 | let source_analyzer = ctx.source_analyzer(&position, None); | ||
45 | let module_with_name_to_import = source_analyzer.module()?; | ||
46 | let path_to_import = ctx.covering_element().ancestors().find_map(ast::Path::cast)?; | ||
47 | if source_analyzer.resolve_path(ctx.db, &path_to_import).is_some() { | ||
48 | return None; | ||
49 | } | ||
50 | |||
51 | let name_to_import = &find_applicable_name_ref(ctx.covering_element())?.syntax().to_string(); | ||
52 | let proposed_imports = imports_locator | ||
53 | .find_imports(&name_to_import.to_string()) | ||
54 | .into_iter() | ||
55 | .filter_map(|module_def| module_with_name_to_import.find_use_path(ctx.db, module_def)) | ||
56 | .filter(|use_path| !use_path.segments.is_empty()) | ||
57 | .take(20) | ||
58 | .map(|import| import.to_string()) | ||
59 | .collect::<std::collections::BTreeSet<_>>(); | ||
60 | if proposed_imports.is_empty() { | ||
61 | return None; | ||
62 | } | ||
63 | |||
64 | ctx.add_assist_group(AssistId("auto_import"), "auto import", || { | ||
65 | proposed_imports | ||
66 | .into_iter() | ||
67 | .map(|import| import_to_action(import, &position, &path_to_import.syntax())) | ||
68 | .collect() | ||
69 | }) | ||
70 | } | ||
71 | |||
72 | fn find_applicable_name_ref(element: SyntaxElement) -> Option<ast::NameRef> { | ||
73 | if element.ancestors().find(|ancestor| ancestor.kind() == USE_ITEM).is_some() { | ||
74 | None | ||
75 | } else if element.kind() == NAME_REF { | ||
76 | Some(element.as_node().cloned().and_then(ast::NameRef::cast)?) | ||
77 | } else { | ||
78 | let parent = element.parent()?; | ||
79 | if parent.kind() == NAME_REF { | ||
80 | Some(ast::NameRef::cast(parent)?) | ||
81 | } else { | ||
82 | None | ||
83 | } | ||
84 | } | ||
85 | } | ||
86 | |||
87 | fn import_to_action(import: String, position: &SyntaxNode, anchor: &SyntaxNode) -> ActionBuilder { | ||
88 | let mut action_builder = ActionBuilder::default(); | ||
89 | action_builder.label(format!("Import `{}`", &import)); | ||
90 | auto_import_text_edit( | ||
91 | position, | ||
92 | anchor, | ||
93 | &[SmolStr::new(import)], | ||
94 | action_builder.text_edit_builder(), | ||
95 | ); | ||
96 | action_builder | ||
97 | } | ||
98 | |||
99 | #[cfg(test)] | ||
100 | mod tests { | ||
101 | use super::*; | ||
102 | use crate::helpers::{ | ||
103 | check_assist_with_imports_locator, check_assist_with_imports_locator_not_applicable, | ||
104 | TestImportsLocator, | ||
105 | }; | ||
106 | |||
107 | #[test] | ||
108 | fn applicable_when_found_an_import() { | ||
109 | check_assist_with_imports_locator( | ||
110 | auto_import, | ||
111 | TestImportsLocator::new, | ||
112 | r" | ||
113 | PubStruct<|> | ||
114 | |||
115 | pub mod PubMod { | ||
116 | pub struct PubStruct; | ||
117 | } | ||
118 | ", | ||
119 | r" | ||
120 | use PubMod::PubStruct; | ||
121 | |||
122 | PubStruct<|> | ||
123 | |||
124 | pub mod PubMod { | ||
125 | pub struct PubStruct; | ||
126 | } | ||
127 | ", | ||
128 | ); | ||
129 | } | ||
130 | |||
131 | #[test] | ||
132 | fn applicable_when_found_multiple_imports() { | ||
133 | check_assist_with_imports_locator( | ||
134 | auto_import, | ||
135 | TestImportsLocator::new, | ||
136 | r" | ||
137 | PubStruct<|> | ||
138 | |||
139 | pub mod PubMod1 { | ||
140 | pub struct PubStruct; | ||
141 | } | ||
142 | pub mod PubMod2 { | ||
143 | pub struct PubStruct; | ||
144 | } | ||
145 | pub mod PubMod3 { | ||
146 | pub struct PubStruct; | ||
147 | } | ||
148 | ", | ||
149 | r" | ||
150 | use PubMod1::PubStruct; | ||
151 | |||
152 | PubStruct<|> | ||
153 | |||
154 | pub mod PubMod1 { | ||
155 | pub struct PubStruct; | ||
156 | } | ||
157 | pub mod PubMod2 { | ||
158 | pub struct PubStruct; | ||
159 | } | ||
160 | pub mod PubMod3 { | ||
161 | pub struct PubStruct; | ||
162 | } | ||
163 | ", | ||
164 | ); | ||
165 | } | ||
166 | |||
167 | #[test] | ||
168 | fn not_applicable_for_already_imported_types() { | ||
169 | check_assist_with_imports_locator_not_applicable( | ||
170 | auto_import, | ||
171 | TestImportsLocator::new, | ||
172 | r" | ||
173 | use PubMod::PubStruct; | ||
174 | |||
175 | PubStruct<|> | ||
176 | |||
177 | pub mod PubMod { | ||
178 | pub struct PubStruct; | ||
179 | } | ||
180 | ", | ||
181 | ); | ||
182 | } | ||
183 | |||
184 | #[test] | ||
185 | fn not_applicable_for_types_with_private_paths() { | ||
186 | check_assist_with_imports_locator_not_applicable( | ||
187 | auto_import, | ||
188 | TestImportsLocator::new, | ||
189 | r" | ||
190 | PrivateStruct<|> | ||
191 | |||
192 | pub mod PubMod { | ||
193 | struct PrivateStruct; | ||
194 | } | ||
195 | ", | ||
196 | ); | ||
197 | } | ||
198 | |||
199 | #[test] | ||
200 | fn not_applicable_when_no_imports_found() { | ||
201 | check_assist_with_imports_locator_not_applicable( | ||
202 | auto_import, | ||
203 | TestImportsLocator::new, | ||
204 | " | ||
205 | PubStruct<|>", | ||
206 | ); | ||
207 | } | ||
208 | |||
209 | #[test] | ||
210 | fn not_applicable_in_import_statements() { | ||
211 | check_assist_with_imports_locator_not_applicable( | ||
212 | auto_import, | ||
213 | TestImportsLocator::new, | ||
214 | r" | ||
215 | use PubStruct<|>; | ||
216 | |||
217 | pub mod PubMod { | ||
218 | pub struct PubStruct; | ||
219 | }", | ||
220 | ); | ||
221 | } | ||
222 | } | ||
diff --git a/crates/ra_assists/src/assists/inline_local_variable.rs b/crates/ra_assists/src/assists/inline_local_variable.rs index 45e0f983f..83527d904 100644 --- a/crates/ra_assists/src/assists/inline_local_variable.rs +++ b/crates/ra_assists/src/assists/inline_local_variable.rs | |||
@@ -23,7 +23,7 @@ use crate::{Assist, AssistCtx, AssistId}; | |||
23 | // (1 + 2) * 4; | 23 | // (1 + 2) * 4; |
24 | // } | 24 | // } |
25 | // ``` | 25 | // ``` |
26 | pub(crate) fn inline_local_varialbe(ctx: AssistCtx<impl HirDatabase>) -> Option<Assist> { | 26 | pub(crate) fn inline_local_variable(ctx: AssistCtx<impl HirDatabase>) -> Option<Assist> { |
27 | let let_stmt = ctx.find_node_at_offset::<ast::LetStmt>()?; | 27 | let let_stmt = ctx.find_node_at_offset::<ast::LetStmt>()?; |
28 | let bind_pat = match let_stmt.pat()? { | 28 | let bind_pat = match let_stmt.pat()? { |
29 | ast::Pat::BindPat(pat) => pat, | 29 | ast::Pat::BindPat(pat) => pat, |
@@ -47,6 +47,9 @@ pub(crate) fn inline_local_varialbe(ctx: AssistCtx<impl HirDatabase>) -> Option< | |||
47 | }; | 47 | }; |
48 | let analyzer = ctx.source_analyzer(bind_pat.syntax(), None); | 48 | let analyzer = ctx.source_analyzer(bind_pat.syntax(), None); |
49 | let refs = analyzer.find_all_refs(&bind_pat); | 49 | let refs = analyzer.find_all_refs(&bind_pat); |
50 | if refs.is_empty() { | ||
51 | return None; | ||
52 | }; | ||
50 | 53 | ||
51 | let mut wrap_in_parens = vec![true; refs.len()]; | 54 | let mut wrap_in_parens = vec![true; refs.len()]; |
52 | 55 | ||
@@ -117,7 +120,7 @@ mod tests { | |||
117 | #[test] | 120 | #[test] |
118 | fn test_inline_let_bind_literal_expr() { | 121 | fn test_inline_let_bind_literal_expr() { |
119 | check_assist( | 122 | check_assist( |
120 | inline_local_varialbe, | 123 | inline_local_variable, |
121 | " | 124 | " |
122 | fn bar(a: usize) {} | 125 | fn bar(a: usize) {} |
123 | fn foo() { | 126 | fn foo() { |
@@ -151,7 +154,7 @@ fn foo() { | |||
151 | #[test] | 154 | #[test] |
152 | fn test_inline_let_bind_bin_expr() { | 155 | fn test_inline_let_bind_bin_expr() { |
153 | check_assist( | 156 | check_assist( |
154 | inline_local_varialbe, | 157 | inline_local_variable, |
155 | " | 158 | " |
156 | fn bar(a: usize) {} | 159 | fn bar(a: usize) {} |
157 | fn foo() { | 160 | fn foo() { |
@@ -185,7 +188,7 @@ fn foo() { | |||
185 | #[test] | 188 | #[test] |
186 | fn test_inline_let_bind_function_call_expr() { | 189 | fn test_inline_let_bind_function_call_expr() { |
187 | check_assist( | 190 | check_assist( |
188 | inline_local_varialbe, | 191 | inline_local_variable, |
189 | " | 192 | " |
190 | fn bar(a: usize) {} | 193 | fn bar(a: usize) {} |
191 | fn foo() { | 194 | fn foo() { |
@@ -219,7 +222,7 @@ fn foo() { | |||
219 | #[test] | 222 | #[test] |
220 | fn test_inline_let_bind_cast_expr() { | 223 | fn test_inline_let_bind_cast_expr() { |
221 | check_assist( | 224 | check_assist( |
222 | inline_local_varialbe, | 225 | inline_local_variable, |
223 | " | 226 | " |
224 | fn bar(a: usize): usize { a } | 227 | fn bar(a: usize): usize { a } |
225 | fn foo() { | 228 | fn foo() { |
@@ -253,7 +256,7 @@ fn foo() { | |||
253 | #[test] | 256 | #[test] |
254 | fn test_inline_let_bind_block_expr() { | 257 | fn test_inline_let_bind_block_expr() { |
255 | check_assist( | 258 | check_assist( |
256 | inline_local_varialbe, | 259 | inline_local_variable, |
257 | " | 260 | " |
258 | fn foo() { | 261 | fn foo() { |
259 | let a<|> = { 10 + 1 }; | 262 | let a<|> = { 10 + 1 }; |
@@ -285,7 +288,7 @@ fn foo() { | |||
285 | #[test] | 288 | #[test] |
286 | fn test_inline_let_bind_paren_expr() { | 289 | fn test_inline_let_bind_paren_expr() { |
287 | check_assist( | 290 | check_assist( |
288 | inline_local_varialbe, | 291 | inline_local_variable, |
289 | " | 292 | " |
290 | fn foo() { | 293 | fn foo() { |
291 | let a<|> = ( 10 + 1 ); | 294 | let a<|> = ( 10 + 1 ); |
@@ -317,7 +320,7 @@ fn foo() { | |||
317 | #[test] | 320 | #[test] |
318 | fn test_not_inline_mut_variable() { | 321 | fn test_not_inline_mut_variable() { |
319 | check_assist_not_applicable( | 322 | check_assist_not_applicable( |
320 | inline_local_varialbe, | 323 | inline_local_variable, |
321 | " | 324 | " |
322 | fn foo() { | 325 | fn foo() { |
323 | let mut a<|> = 1 + 1; | 326 | let mut a<|> = 1 + 1; |
@@ -329,7 +332,7 @@ fn foo() { | |||
329 | #[test] | 332 | #[test] |
330 | fn test_call_expr() { | 333 | fn test_call_expr() { |
331 | check_assist( | 334 | check_assist( |
332 | inline_local_varialbe, | 335 | inline_local_variable, |
333 | " | 336 | " |
334 | fn foo() { | 337 | fn foo() { |
335 | let a<|> = bar(10 + 1); | 338 | let a<|> = bar(10 + 1); |
@@ -347,7 +350,7 @@ fn foo() { | |||
347 | #[test] | 350 | #[test] |
348 | fn test_index_expr() { | 351 | fn test_index_expr() { |
349 | check_assist( | 352 | check_assist( |
350 | inline_local_varialbe, | 353 | inline_local_variable, |
351 | " | 354 | " |
352 | fn foo() { | 355 | fn foo() { |
353 | let x = vec![1, 2, 3]; | 356 | let x = vec![1, 2, 3]; |
@@ -367,7 +370,7 @@ fn foo() { | |||
367 | #[test] | 370 | #[test] |
368 | fn test_method_call_expr() { | 371 | fn test_method_call_expr() { |
369 | check_assist( | 372 | check_assist( |
370 | inline_local_varialbe, | 373 | inline_local_variable, |
371 | " | 374 | " |
372 | fn foo() { | 375 | fn foo() { |
373 | let bar = vec![1]; | 376 | let bar = vec![1]; |
@@ -387,7 +390,7 @@ fn foo() { | |||
387 | #[test] | 390 | #[test] |
388 | fn test_field_expr() { | 391 | fn test_field_expr() { |
389 | check_assist( | 392 | check_assist( |
390 | inline_local_varialbe, | 393 | inline_local_variable, |
391 | " | 394 | " |
392 | struct Bar { | 395 | struct Bar { |
393 | foo: usize | 396 | foo: usize |
@@ -415,7 +418,7 @@ fn foo() { | |||
415 | #[test] | 418 | #[test] |
416 | fn test_try_expr() { | 419 | fn test_try_expr() { |
417 | check_assist( | 420 | check_assist( |
418 | inline_local_varialbe, | 421 | inline_local_variable, |
419 | " | 422 | " |
420 | fn foo() -> Option<usize> { | 423 | fn foo() -> Option<usize> { |
421 | let bar = Some(1); | 424 | let bar = Some(1); |
@@ -437,7 +440,7 @@ fn foo() -> Option<usize> { | |||
437 | #[test] | 440 | #[test] |
438 | fn test_ref_expr() { | 441 | fn test_ref_expr() { |
439 | check_assist( | 442 | check_assist( |
440 | inline_local_varialbe, | 443 | inline_local_variable, |
441 | " | 444 | " |
442 | fn foo() { | 445 | fn foo() { |
443 | let bar = 10; | 446 | let bar = 10; |
@@ -455,7 +458,7 @@ fn foo() { | |||
455 | #[test] | 458 | #[test] |
456 | fn test_tuple_expr() { | 459 | fn test_tuple_expr() { |
457 | check_assist( | 460 | check_assist( |
458 | inline_local_varialbe, | 461 | inline_local_variable, |
459 | " | 462 | " |
460 | fn foo() { | 463 | fn foo() { |
461 | let a<|> = (10, 20); | 464 | let a<|> = (10, 20); |
@@ -471,7 +474,7 @@ fn foo() { | |||
471 | #[test] | 474 | #[test] |
472 | fn test_array_expr() { | 475 | fn test_array_expr() { |
473 | check_assist( | 476 | check_assist( |
474 | inline_local_varialbe, | 477 | inline_local_variable, |
475 | " | 478 | " |
476 | fn foo() { | 479 | fn foo() { |
477 | let a<|> = [1, 2, 3]; | 480 | let a<|> = [1, 2, 3]; |
@@ -487,7 +490,7 @@ fn foo() { | |||
487 | #[test] | 490 | #[test] |
488 | fn test_paren() { | 491 | fn test_paren() { |
489 | check_assist( | 492 | check_assist( |
490 | inline_local_varialbe, | 493 | inline_local_variable, |
491 | " | 494 | " |
492 | fn foo() { | 495 | fn foo() { |
493 | let a<|> = (10 + 20); | 496 | let a<|> = (10 + 20); |
@@ -505,7 +508,7 @@ fn foo() { | |||
505 | #[test] | 508 | #[test] |
506 | fn test_path_expr() { | 509 | fn test_path_expr() { |
507 | check_assist( | 510 | check_assist( |
508 | inline_local_varialbe, | 511 | inline_local_variable, |
509 | " | 512 | " |
510 | fn foo() { | 513 | fn foo() { |
511 | let d = 10; | 514 | let d = 10; |
@@ -525,7 +528,7 @@ fn foo() { | |||
525 | #[test] | 528 | #[test] |
526 | fn test_block_expr() { | 529 | fn test_block_expr() { |
527 | check_assist( | 530 | check_assist( |
528 | inline_local_varialbe, | 531 | inline_local_variable, |
529 | " | 532 | " |
530 | fn foo() { | 533 | fn foo() { |
531 | let a<|> = { 10 }; | 534 | let a<|> = { 10 }; |
@@ -543,7 +546,7 @@ fn foo() { | |||
543 | #[test] | 546 | #[test] |
544 | fn test_used_in_different_expr1() { | 547 | fn test_used_in_different_expr1() { |
545 | check_assist( | 548 | check_assist( |
546 | inline_local_varialbe, | 549 | inline_local_variable, |
547 | " | 550 | " |
548 | fn foo() { | 551 | fn foo() { |
549 | let a<|> = 10 + 20; | 552 | let a<|> = 10 + 20; |
@@ -565,7 +568,7 @@ fn foo() { | |||
565 | #[test] | 568 | #[test] |
566 | fn test_used_in_for_expr() { | 569 | fn test_used_in_for_expr() { |
567 | check_assist( | 570 | check_assist( |
568 | inline_local_varialbe, | 571 | inline_local_variable, |
569 | " | 572 | " |
570 | fn foo() { | 573 | fn foo() { |
571 | let a<|> = vec![10, 20]; | 574 | let a<|> = vec![10, 20]; |
@@ -581,7 +584,7 @@ fn foo() { | |||
581 | #[test] | 584 | #[test] |
582 | fn test_used_in_while_expr() { | 585 | fn test_used_in_while_expr() { |
583 | check_assist( | 586 | check_assist( |
584 | inline_local_varialbe, | 587 | inline_local_variable, |
585 | " | 588 | " |
586 | fn foo() { | 589 | fn foo() { |
587 | let a<|> = 1 > 0; | 590 | let a<|> = 1 > 0; |
@@ -597,7 +600,7 @@ fn foo() { | |||
597 | #[test] | 600 | #[test] |
598 | fn test_used_in_break_expr() { | 601 | fn test_used_in_break_expr() { |
599 | check_assist( | 602 | check_assist( |
600 | inline_local_varialbe, | 603 | inline_local_variable, |
601 | " | 604 | " |
602 | fn foo() { | 605 | fn foo() { |
603 | let a<|> = 1 + 1; | 606 | let a<|> = 1 + 1; |
@@ -617,7 +620,7 @@ fn foo() { | |||
617 | #[test] | 620 | #[test] |
618 | fn test_used_in_return_expr() { | 621 | fn test_used_in_return_expr() { |
619 | check_assist( | 622 | check_assist( |
620 | inline_local_varialbe, | 623 | inline_local_variable, |
621 | " | 624 | " |
622 | fn foo() { | 625 | fn foo() { |
623 | let a<|> = 1 > 0; | 626 | let a<|> = 1 > 0; |
@@ -633,7 +636,7 @@ fn foo() { | |||
633 | #[test] | 636 | #[test] |
634 | fn test_used_in_match_expr() { | 637 | fn test_used_in_match_expr() { |
635 | check_assist( | 638 | check_assist( |
636 | inline_local_varialbe, | 639 | inline_local_variable, |
637 | " | 640 | " |
638 | fn foo() { | 641 | fn foo() { |
639 | let a<|> = 1 > 0; | 642 | let a<|> = 1 > 0; |
@@ -645,4 +648,16 @@ fn foo() { | |||
645 | }", | 648 | }", |
646 | ); | 649 | ); |
647 | } | 650 | } |
651 | |||
652 | #[test] | ||
653 | fn test_not_applicable_if_variable_unused() { | ||
654 | check_assist_not_applicable( | ||
655 | inline_local_variable, | ||
656 | " | ||
657 | fn foo() { | ||
658 | let <|>a = 0; | ||
659 | } | ||
660 | ", | ||
661 | ) | ||
662 | } | ||
648 | } | 663 | } |
diff --git a/crates/ra_assists/src/doc_tests.rs b/crates/ra_assists/src/doc_tests.rs index 5dc1ee233..65d51428b 100644 --- a/crates/ra_assists/src/doc_tests.rs +++ b/crates/ra_assists/src/doc_tests.rs | |||
@@ -11,6 +11,10 @@ use test_utils::{assert_eq_text, extract_range_or_offset}; | |||
11 | use crate::test_db::TestDB; | 11 | use crate::test_db::TestDB; |
12 | 12 | ||
13 | fn check(assist_id: &str, before: &str, after: &str) { | 13 | fn check(assist_id: &str, before: &str, after: &str) { |
14 | // FIXME we cannot get the imports search functionality here yet, but still need to generate a test and a doc for an assist | ||
15 | if assist_id == "auto_import" { | ||
16 | return; | ||
17 | } | ||
14 | let (selection, before) = extract_range_or_offset(before); | 18 | let (selection, before) = extract_range_or_offset(before); |
15 | let (db, file_id) = TestDB::with_single_file(&before); | 19 | let (db, file_id) = TestDB::with_single_file(&before); |
16 | let frange = FileRange { file_id, range: selection.into() }; | 20 | let frange = FileRange { file_id, range: selection.into() }; |
diff --git a/crates/ra_assists/src/doc_tests/generated.rs b/crates/ra_assists/src/doc_tests/generated.rs index 7d84dc8fb..ec4587ce7 100644 --- a/crates/ra_assists/src/doc_tests/generated.rs +++ b/crates/ra_assists/src/doc_tests/generated.rs | |||
@@ -215,6 +215,25 @@ fn main() { | |||
215 | } | 215 | } |
216 | 216 | ||
217 | #[test] | 217 | #[test] |
218 | fn doctest_auto_import() { | ||
219 | check( | ||
220 | "auto_import", | ||
221 | r#####" | ||
222 | fn main() { | ||
223 | let map = HashMap<|>::new(); | ||
224 | } | ||
225 | "#####, | ||
226 | r#####" | ||
227 | use std::collections::HashMap; | ||
228 | |||
229 | fn main() { | ||
230 | let map = HashMap<|>::new(); | ||
231 | } | ||
232 | "#####, | ||
233 | ) | ||
234 | } | ||
235 | |||
236 | #[test] | ||
218 | fn doctest_change_visibility() { | 237 | fn doctest_change_visibility() { |
219 | check( | 238 | check( |
220 | "change_visibility", | 239 | "change_visibility", |
diff --git a/crates/ra_assists/src/lib.rs b/crates/ra_assists/src/lib.rs index d45b58966..625ebc4a2 100644 --- a/crates/ra_assists/src/lib.rs +++ b/crates/ra_assists/src/lib.rs | |||
@@ -14,7 +14,7 @@ mod test_db; | |||
14 | pub mod ast_transform; | 14 | pub mod ast_transform; |
15 | 15 | ||
16 | use either::Either; | 16 | use either::Either; |
17 | use hir::db::HirDatabase; | 17 | use hir::{db::HirDatabase, ModuleDef}; |
18 | use ra_db::FileRange; | 18 | use ra_db::FileRange; |
19 | use ra_syntax::{TextRange, TextUnit}; | 19 | use ra_syntax::{TextRange, TextUnit}; |
20 | use ra_text_edit::TextEdit; | 20 | use ra_text_edit::TextEdit; |
@@ -77,6 +77,51 @@ where | |||
77 | }) | 77 | }) |
78 | } | 78 | } |
79 | 79 | ||
80 | /// A functionality for locating imports for the given name. | ||
81 | /// | ||
82 | /// Currently has to be a trait with the real implementation provided by the ra_ide_api crate, | ||
83 | /// due to the search functionality located there. | ||
84 | /// Later, this trait should be removed completely and the search functionality moved to a separate crate, | ||
85 | /// accessible from the ra_assists crate. | ||
86 | pub trait ImportsLocator { | ||
87 | /// Finds all imports for the given name and the module that contains this name. | ||
88 | fn find_imports(&mut self, name_to_import: &str) -> Vec<ModuleDef>; | ||
89 | } | ||
90 | |||
91 | /// Return all the assists applicable at the given position | ||
92 | /// and additional assists that need the imports locator functionality to work. | ||
93 | /// | ||
94 | /// Assists are returned in the "resolved" state, that is with edit fully | ||
95 | /// computed. | ||
96 | pub fn assists_with_imports_locator<H, F>( | ||
97 | db: &H, | ||
98 | range: FileRange, | ||
99 | mut imports_locator: F, | ||
100 | ) -> Vec<ResolvedAssist> | ||
101 | where | ||
102 | H: HirDatabase + 'static, | ||
103 | F: ImportsLocator, | ||
104 | { | ||
105 | AssistCtx::with_ctx(db, range, true, |ctx| { | ||
106 | let mut assists = assists::all() | ||
107 | .iter() | ||
108 | .map(|f| f(ctx.clone())) | ||
109 | .chain( | ||
110 | assists::all_with_imports_locator() | ||
111 | .iter() | ||
112 | .map(|f| f(ctx.clone(), &mut imports_locator)), | ||
113 | ) | ||
114 | .filter_map(std::convert::identity) | ||
115 | .map(|a| match a { | ||
116 | Assist::Resolved { assist } => assist, | ||
117 | Assist::Unresolved { .. } => unreachable!(), | ||
118 | }) | ||
119 | .collect(); | ||
120 | sort_assists(&mut assists); | ||
121 | assists | ||
122 | }) | ||
123 | } | ||
124 | |||
80 | /// Return all the assists applicable at the given position. | 125 | /// Return all the assists applicable at the given position. |
81 | /// | 126 | /// |
82 | /// Assists are returned in the "resolved" state, that is with edit fully | 127 | /// Assists are returned in the "resolved" state, that is with edit fully |
@@ -85,8 +130,6 @@ pub fn assists<H>(db: &H, range: FileRange) -> Vec<ResolvedAssist> | |||
85 | where | 130 | where |
86 | H: HirDatabase + 'static, | 131 | H: HirDatabase + 'static, |
87 | { | 132 | { |
88 | use std::cmp::Ordering; | ||
89 | |||
90 | AssistCtx::with_ctx(db, range, true, |ctx| { | 133 | AssistCtx::with_ctx(db, range, true, |ctx| { |
91 | let mut a = assists::all() | 134 | let mut a = assists::all() |
92 | .iter() | 135 | .iter() |
@@ -95,19 +138,24 @@ where | |||
95 | Assist::Resolved { assist } => assist, | 138 | Assist::Resolved { assist } => assist, |
96 | Assist::Unresolved { .. } => unreachable!(), | 139 | Assist::Unresolved { .. } => unreachable!(), |
97 | }) | 140 | }) |
98 | .collect::<Vec<_>>(); | 141 | .collect(); |
99 | a.sort_by(|a, b| match (a.get_first_action().target, b.get_first_action().target) { | 142 | sort_assists(&mut a); |
100 | (Some(a), Some(b)) => a.len().cmp(&b.len()), | ||
101 | (Some(_), None) => Ordering::Less, | ||
102 | (None, Some(_)) => Ordering::Greater, | ||
103 | (None, None) => Ordering::Equal, | ||
104 | }); | ||
105 | a | 143 | a |
106 | }) | 144 | }) |
107 | } | 145 | } |
108 | 146 | ||
147 | fn sort_assists(assists: &mut Vec<ResolvedAssist>) { | ||
148 | use std::cmp::Ordering; | ||
149 | assists.sort_by(|a, b| match (a.get_first_action().target, b.get_first_action().target) { | ||
150 | (Some(a), Some(b)) => a.len().cmp(&b.len()), | ||
151 | (Some(_), None) => Ordering::Less, | ||
152 | (None, Some(_)) => Ordering::Greater, | ||
153 | (None, None) => Ordering::Equal, | ||
154 | }); | ||
155 | } | ||
156 | |||
109 | mod assists { | 157 | mod assists { |
110 | use crate::{Assist, AssistCtx}; | 158 | use crate::{Assist, AssistCtx, ImportsLocator}; |
111 | use hir::db::HirDatabase; | 159 | use hir::db::HirDatabase; |
112 | 160 | ||
113 | mod add_derive; | 161 | mod add_derive; |
@@ -116,6 +164,7 @@ mod assists { | |||
116 | mod add_custom_impl; | 164 | mod add_custom_impl; |
117 | mod add_new; | 165 | mod add_new; |
118 | mod apply_demorgan; | 166 | mod apply_demorgan; |
167 | mod auto_import; | ||
119 | mod invert_if; | 168 | mod invert_if; |
120 | mod flip_comma; | 169 | mod flip_comma; |
121 | mod flip_binexpr; | 170 | mod flip_binexpr; |
@@ -157,7 +206,7 @@ mod assists { | |||
157 | add_import::add_import, | 206 | add_import::add_import, |
158 | add_missing_impl_members::add_missing_impl_members, | 207 | add_missing_impl_members::add_missing_impl_members, |
159 | add_missing_impl_members::add_missing_default_members, | 208 | add_missing_impl_members::add_missing_default_members, |
160 | inline_local_variable::inline_local_varialbe, | 209 | inline_local_variable::inline_local_variable, |
161 | move_guard::move_guard_to_arm_body, | 210 | move_guard::move_guard_to_arm_body, |
162 | move_guard::move_arm_cond_to_match_guard, | 211 | move_guard::move_arm_cond_to_match_guard, |
163 | move_bounds::move_bounds_to_where_clause, | 212 | move_bounds::move_bounds_to_where_clause, |
@@ -168,15 +217,69 @@ mod assists { | |||
168 | early_return::convert_to_guarded_return, | 217 | early_return::convert_to_guarded_return, |
169 | ] | 218 | ] |
170 | } | 219 | } |
220 | |||
221 | pub(crate) fn all_with_imports_locator<'a, DB: HirDatabase, F: ImportsLocator>( | ||
222 | ) -> &'a [fn(AssistCtx<DB>, &mut F) -> Option<Assist>] { | ||
223 | &[auto_import::auto_import] | ||
224 | } | ||
171 | } | 225 | } |
172 | 226 | ||
173 | #[cfg(test)] | 227 | #[cfg(test)] |
174 | mod helpers { | 228 | mod helpers { |
175 | use ra_db::{fixture::WithFixture, FileRange}; | 229 | use hir::db::DefDatabase; |
230 | use ra_db::{fixture::WithFixture, FileId, FileRange}; | ||
176 | use ra_syntax::TextRange; | 231 | use ra_syntax::TextRange; |
177 | use test_utils::{add_cursor, assert_eq_text, extract_offset, extract_range}; | 232 | use test_utils::{add_cursor, assert_eq_text, extract_offset, extract_range}; |
178 | 233 | ||
179 | use crate::{test_db::TestDB, Assist, AssistCtx}; | 234 | use crate::{test_db::TestDB, Assist, AssistCtx, ImportsLocator}; |
235 | use std::sync::Arc; | ||
236 | |||
237 | // FIXME remove the `ModuleDefId` reexport from `ra_hir` when this gets removed. | ||
238 | pub(crate) struct TestImportsLocator { | ||
239 | db: Arc<TestDB>, | ||
240 | test_file_id: FileId, | ||
241 | } | ||
242 | |||
243 | impl TestImportsLocator { | ||
244 | pub(crate) fn new(db: Arc<TestDB>, test_file_id: FileId) -> Self { | ||
245 | TestImportsLocator { db, test_file_id } | ||
246 | } | ||
247 | } | ||
248 | |||
249 | impl ImportsLocator for TestImportsLocator { | ||
250 | fn find_imports(&mut self, name_to_import: &str) -> Vec<hir::ModuleDef> { | ||
251 | let crate_def_map = self.db.crate_def_map(self.db.test_crate()); | ||
252 | let mut findings = Vec::new(); | ||
253 | |||
254 | let mut module_ids_to_process = | ||
255 | crate_def_map.modules_for_file(self.test_file_id).collect::<Vec<_>>(); | ||
256 | |||
257 | while !module_ids_to_process.is_empty() { | ||
258 | let mut more_ids_to_process = Vec::new(); | ||
259 | for local_module_id in module_ids_to_process.drain(..) { | ||
260 | for (name, namespace_data) in | ||
261 | crate_def_map[local_module_id].scope.entries_without_primitives() | ||
262 | { | ||
263 | let found_a_match = &name.to_string() == name_to_import; | ||
264 | vec![namespace_data.types, namespace_data.values] | ||
265 | .into_iter() | ||
266 | .filter_map(std::convert::identity) | ||
267 | .for_each(|(module_def_id, _)| { | ||
268 | if found_a_match { | ||
269 | findings.push(module_def_id.into()); | ||
270 | } | ||
271 | if let hir::ModuleDefId::ModuleId(module_id) = module_def_id { | ||
272 | more_ids_to_process.push(module_id.local_id); | ||
273 | } | ||
274 | }); | ||
275 | } | ||
276 | } | ||
277 | module_ids_to_process = more_ids_to_process; | ||
278 | } | ||
279 | |||
280 | findings | ||
281 | } | ||
282 | } | ||
180 | 283 | ||
181 | pub(crate) fn check_assist( | 284 | pub(crate) fn check_assist( |
182 | assist: fn(AssistCtx<TestDB>) -> Option<Assist>, | 285 | assist: fn(AssistCtx<TestDB>) -> Option<Assist>, |
@@ -206,6 +309,38 @@ mod helpers { | |||
206 | assert_eq_text!(after, &actual); | 309 | assert_eq_text!(after, &actual); |
207 | } | 310 | } |
208 | 311 | ||
312 | pub(crate) fn check_assist_with_imports_locator<F: ImportsLocator>( | ||
313 | assist: fn(AssistCtx<TestDB>, &mut F) -> Option<Assist>, | ||
314 | imports_locator_provider: fn(db: Arc<TestDB>, file_id: FileId) -> F, | ||
315 | before: &str, | ||
316 | after: &str, | ||
317 | ) { | ||
318 | let (before_cursor_pos, before) = extract_offset(before); | ||
319 | let (db, file_id) = TestDB::with_single_file(&before); | ||
320 | let db = Arc::new(db); | ||
321 | let mut imports_locator = imports_locator_provider(Arc::clone(&db), file_id); | ||
322 | let frange = | ||
323 | FileRange { file_id, range: TextRange::offset_len(before_cursor_pos, 0.into()) }; | ||
324 | let assist = | ||
325 | AssistCtx::with_ctx(db.as_ref(), frange, true, |ctx| assist(ctx, &mut imports_locator)) | ||
326 | .expect("code action is not applicable"); | ||
327 | let action = match assist { | ||
328 | Assist::Unresolved { .. } => unreachable!(), | ||
329 | Assist::Resolved { assist } => assist.get_first_action(), | ||
330 | }; | ||
331 | |||
332 | let actual = action.edit.apply(&before); | ||
333 | let actual_cursor_pos = match action.cursor_position { | ||
334 | None => action | ||
335 | .edit | ||
336 | .apply_to_offset(before_cursor_pos) | ||
337 | .expect("cursor position is affected by the edit"), | ||
338 | Some(off) => off, | ||
339 | }; | ||
340 | let actual = add_cursor(&actual, actual_cursor_pos); | ||
341 | assert_eq_text!(after, &actual); | ||
342 | } | ||
343 | |||
209 | pub(crate) fn check_assist_range( | 344 | pub(crate) fn check_assist_range( |
210 | assist: fn(AssistCtx<TestDB>) -> Option<Assist>, | 345 | assist: fn(AssistCtx<TestDB>) -> Option<Assist>, |
211 | before: &str, | 346 | before: &str, |
@@ -279,6 +414,22 @@ mod helpers { | |||
279 | assert!(assist.is_none()); | 414 | assert!(assist.is_none()); |
280 | } | 415 | } |
281 | 416 | ||
417 | pub(crate) fn check_assist_with_imports_locator_not_applicable<F: ImportsLocator>( | ||
418 | assist: fn(AssistCtx<TestDB>, &mut F) -> Option<Assist>, | ||
419 | imports_locator_provider: fn(db: Arc<TestDB>, file_id: FileId) -> F, | ||
420 | before: &str, | ||
421 | ) { | ||
422 | let (before_cursor_pos, before) = extract_offset(before); | ||
423 | let (db, file_id) = TestDB::with_single_file(&before); | ||
424 | let db = Arc::new(db); | ||
425 | let mut imports_locator = imports_locator_provider(Arc::clone(&db), file_id); | ||
426 | let frange = | ||
427 | FileRange { file_id, range: TextRange::offset_len(before_cursor_pos, 0.into()) }; | ||
428 | let assist = | ||
429 | AssistCtx::with_ctx(db.as_ref(), frange, true, |ctx| assist(ctx, &mut imports_locator)); | ||
430 | assert!(assist.is_none()); | ||
431 | } | ||
432 | |||
282 | pub(crate) fn check_assist_range_not_applicable( | 433 | pub(crate) fn check_assist_range_not_applicable( |
283 | assist: fn(AssistCtx<TestDB>) -> Option<Assist>, | 434 | assist: fn(AssistCtx<TestDB>) -> Option<Assist>, |
284 | before: &str, | 435 | before: &str, |