1 //! `assists` crate provides a bunch of code assists, also known as code actions
2 //! (in LSP) or intentions (in IntelliJ).
4 //! An assist is a micro-refactoring, which is automatically activated in
5 //! certain context. For example, if the cursor is over `,`, a "swap `,`" assist
8 //! ## Assists Guidelines
10 //! Assists are the main mechanism to deliver advanced IDE features to the user,
11 //! so we should pay extra attention to the UX.
13 //! The power of assists comes from their context-awareness. The main problem
14 //! with IDE features is that there are a lot of them, and it's hard to teach
15 //! the user what's available. Assists solve this problem nicely: 💡 signifies
16 //! that *something* is possible, and clicking on it reveals a *short* list of
17 //! actions. Contrast it with Emacs `M-x`, which just spits an infinite list of
20 //! Here are some considerations when creating a new assist:
22 //! * It's good to preserve semantics, and it's good to keep the code compiling,
23 //! but it isn't necessary. Example: "flip binary operation" might change
25 //! * Assist shouldn't necessary make the code "better". A lot of assist come in
26 //! pairs: "if let <-> match".
27 //! * Assists should have as narrow scope as possible. Each new assists greatly
28 //! improves UX for cases where the user actually invokes it, but it makes UX
29 //! worse for every case where the user clicks 💡 to invoke some *other*
30 //! assist. So, a rarely useful assist which is always applicable can be a net
32 //! * Rarely useful actions are tricky. Sometimes there are features which are
33 //! clearly useful to some users, but are just noise most of the time. We
34 //! don't have a good solution here, our current approach is to make this
35 //! functionality available only if assist is applicable to the whole
36 //! selection. Example: `sort_items` sorts items alphabetically. Naively, it
37 //! should be available more or less everywhere, which isn't useful. So
38 //! instead we only show it if the user *selects* the items they want to sort.
39 //! * Consider grouping related assists together (see [`Assists::add_group`]).
40 //! * Make assists robust. If the assist depends on results of type-inference too
41 //! much, it might only fire in fully-correct code. This makes assist less
42 //! useful and (worse) less predictable. The user should have a clear
43 //! intuition when each particular assist is available.
44 //! * Make small assists, which compose. Example: rather than auto-importing
45 //! enums in `add_missing_match_arms`, we use fully-qualified names. There's a
46 //! separate assist to shorten a fully-qualified name.
47 //! * Distinguish between assists and fixits for diagnostics. Internally, fixits
48 //! and assists are equivalent. They have the same "show a list + invoke a
49 //! single element" workflow, and both use [`Assist`] data structure. The main
50 //! difference is in the UX: while 💡 looks only at the cursor position,
51 //! diagnostics squigglies and fixits are calculated for the whole file and
52 //! are presented to the user eagerly. So, diagnostics should be fixable
53 //! errors, while assists can be just suggestions for an alternative way to do
54 //! something. If something *could* be a diagnostic, it should be a
55 //! diagnostic. Conversely, it might be valuable to turn a diagnostic with a
56 //! lot of false errors into an assist.
58 //! See also this post:
59 //! <https://rust-analyzer.github.io/blog/2020/09/28/how-to-make-a-light-bulb.html>
61 #![warn(rust_2018_idioms, unused_lifetimes, semicolon_in_expressions_from_macros)]
64 macro_rules! eprintln {
65 ($($tt:tt)*) => { stdx::eprintln!($($tt)*) };
75 use ide_db::{base_db::FileRange, RootDatabase};
76 use syntax::TextRange;
78 pub(crate) use crate::assist_context::{AssistContext, Assists};
80 pub use assist_config::AssistConfig;
81 pub use ide_db::assists::{
82 Assist, AssistId, AssistKind, AssistResolveStrategy, GroupLabel, SingleResolve,
85 /// Return all the assists applicable at the given position.
87 // NOTE: We don't have a `Feature: ` section for assists, they are special-cased
91 config: &AssistConfig,
92 resolve: AssistResolveStrategy,
95 let sema = Semantics::new(db);
96 let ctx = AssistContext::new(sema, config, range);
97 let mut acc = Assists::new(&ctx, resolve);
98 handlers::all().iter().for_each(|handler| {
99 handler(&mut acc, &ctx);
105 use crate::{AssistContext, Assists};
107 pub(crate) type Handler = fn(&mut Assists, &AssistContext<'_>) -> Option<()>;
109 mod add_explicit_type;
110 mod add_label_to_loop;
111 mod add_lifetime_to_type;
112 mod add_missing_impl_members;
116 mod change_visibility;
117 mod convert_bool_then;
118 mod convert_comment_block;
119 mod convert_integer_literal;
120 mod convert_into_to_from;
121 mod convert_iter_for_each_to_for;
122 mod convert_let_else_to_match;
123 mod convert_tuple_struct_to_named_struct;
124 mod convert_named_struct_to_tuple_struct;
125 mod convert_to_guarded_return;
126 mod convert_two_arm_bool_match_to_matches_macro;
127 mod convert_while_to_loop;
128 mod destructure_tuple_binding;
129 mod expand_glob_import;
130 mod extract_function;
132 mod extract_struct_from_enum_variant;
133 mod extract_type_alias;
134 mod extract_variable;
135 mod add_missing_match_arms;
139 mod flip_trait_bound;
140 mod move_format_string_arg;
141 mod generate_constant;
142 mod generate_default_from_enum_variant;
143 mod generate_default_from_new;
146 mod generate_documentation_template;
147 mod generate_enum_is_method;
148 mod generate_enum_projection_method;
149 mod generate_enum_variant;
150 mod generate_from_impl_for_enum;
151 mod generate_function;
154 mod generate_is_empty_from_len;
157 mod generate_delegate_methods;
160 mod inline_local_variable;
161 mod inline_type_alias;
162 mod introduce_named_lifetime;
165 mod merge_match_arms;
168 mod move_module_to_file;
170 mod move_from_mod_rs;
171 mod number_representation;
172 mod promote_local_to_const;
173 mod pull_assignment_up;
175 mod qualify_method_call;
179 mod remove_unused_param;
181 mod reorder_impl_items;
182 mod replace_try_expr_with_match;
183 mod replace_derive_with_manual_impl;
184 mod replace_if_let_with_match;
185 mod replace_or_with_or_else;
186 mod introduce_named_generic;
187 mod replace_let_with_if_let;
188 mod replace_qualified_name_with_use;
189 mod replace_string_with_char;
190 mod replace_turbofish_with_explicit_type;
192 mod unmerge_match_arm;
197 mod unnecessary_async;
199 mod unwrap_result_return_type;
200 mod wrap_return_type_in_result;
202 pub(crate) fn all() -> &'static [Handler] {
204 // These are alphabetic for the foolish consistency
205 add_explicit_type::add_explicit_type,
206 add_label_to_loop::add_label_to_loop,
207 add_missing_match_arms::add_missing_match_arms,
208 add_lifetime_to_type::add_lifetime_to_type,
209 add_return_type::add_return_type,
210 add_turbo_fish::add_turbo_fish,
211 apply_demorgan::apply_demorgan,
212 auto_import::auto_import,
213 change_visibility::change_visibility,
214 convert_bool_then::convert_bool_then_to_if,
215 convert_bool_then::convert_if_to_bool_then,
216 convert_comment_block::convert_comment_block,
217 convert_integer_literal::convert_integer_literal,
218 convert_into_to_from::convert_into_to_from,
219 convert_iter_for_each_to_for::convert_iter_for_each_to_for,
220 convert_iter_for_each_to_for::convert_for_loop_with_for_each,
221 convert_let_else_to_match::convert_let_else_to_match,
222 convert_named_struct_to_tuple_struct::convert_named_struct_to_tuple_struct,
223 convert_to_guarded_return::convert_to_guarded_return,
224 convert_tuple_struct_to_named_struct::convert_tuple_struct_to_named_struct,
225 convert_two_arm_bool_match_to_matches_macro::convert_two_arm_bool_match_to_matches_macro,
226 convert_while_to_loop::convert_while_to_loop,
227 destructure_tuple_binding::destructure_tuple_binding,
228 expand_glob_import::expand_glob_import,
229 extract_struct_from_enum_variant::extract_struct_from_enum_variant,
230 extract_type_alias::extract_type_alias,
231 fix_visibility::fix_visibility,
232 flip_binexpr::flip_binexpr,
233 flip_comma::flip_comma,
234 flip_trait_bound::flip_trait_bound,
235 generate_constant::generate_constant,
236 generate_default_from_enum_variant::generate_default_from_enum_variant,
237 generate_default_from_new::generate_default_from_new,
238 generate_derive::generate_derive,
239 generate_documentation_template::generate_documentation_template,
240 generate_documentation_template::generate_doc_example,
241 generate_enum_is_method::generate_enum_is_method,
242 generate_enum_projection_method::generate_enum_as_method,
243 generate_enum_projection_method::generate_enum_try_into_method,
244 generate_enum_variant::generate_enum_variant,
245 generate_from_impl_for_enum::generate_from_impl_for_enum,
246 generate_function::generate_function,
247 generate_impl::generate_impl,
248 generate_is_empty_from_len::generate_is_empty_from_len,
249 generate_new::generate_new,
250 inline_call::inline_call,
251 inline_call::inline_into_callers,
252 inline_local_variable::inline_local_variable,
253 inline_type_alias::inline_type_alias,
254 inline_type_alias::inline_type_alias_uses,
255 introduce_named_generic::introduce_named_generic,
256 introduce_named_lifetime::introduce_named_lifetime,
257 invert_if::invert_if,
258 merge_imports::merge_imports,
259 merge_match_arms::merge_match_arms,
260 move_bounds::move_bounds_to_where_clause,
261 move_format_string_arg::move_format_string_arg,
262 move_guard::move_arm_cond_to_match_guard,
263 move_guard::move_guard_to_arm_body,
264 move_module_to_file::move_module_to_file,
265 move_to_mod_rs::move_to_mod_rs,
266 move_from_mod_rs::move_from_mod_rs,
267 number_representation::reformat_number_literal,
268 pull_assignment_up::pull_assignment_up,
269 promote_local_to_const::promote_local_to_const,
270 qualify_path::qualify_path,
271 qualify_method_call::qualify_method_call,
272 raw_string::add_hash,
273 raw_string::make_usual_string,
274 raw_string::remove_hash,
275 remove_dbg::remove_dbg,
276 remove_mut::remove_mut,
277 remove_unused_param::remove_unused_param,
278 reorder_fields::reorder_fields,
279 reorder_impl_items::reorder_impl_items,
280 replace_try_expr_with_match::replace_try_expr_with_match,
281 replace_derive_with_manual_impl::replace_derive_with_manual_impl,
282 replace_if_let_with_match::replace_if_let_with_match,
283 replace_if_let_with_match::replace_match_with_if_let,
284 replace_let_with_if_let::replace_let_with_if_let,
285 replace_or_with_or_else::replace_or_else_with_or,
286 replace_or_with_or_else::replace_or_with_or_else,
287 replace_turbofish_with_explicit_type::replace_turbofish_with_explicit_type,
288 replace_qualified_name_with_use::replace_qualified_name_with_use,
289 sort_items::sort_items,
290 split_import::split_import,
291 toggle_ignore::toggle_ignore,
292 unmerge_match_arm::unmerge_match_arm,
293 unmerge_use::unmerge_use,
294 unnecessary_async::unnecessary_async,
295 unwrap_block::unwrap_block,
296 unwrap_result_return_type::unwrap_result_return_type,
297 unwrap_tuple::unwrap_tuple,
298 wrap_return_type_in_result::wrap_return_type_in_result,
299 // These are manually sorted for better priorities. By default,
300 // priority is determined by the size of the target range (smaller
301 // target wins). If the ranges are equal, position in this list is
302 // used as a tie-breaker.
303 add_missing_impl_members::add_missing_impl_members,
304 add_missing_impl_members::add_missing_default_members,
306 replace_string_with_char::replace_string_with_char,
307 replace_string_with_char::replace_char_with_string,
308 raw_string::make_raw_string,
310 extract_variable::extract_variable,
311 extract_function::extract_function,
312 extract_module::extract_module,
314 generate_getter::generate_getter,
315 generate_getter::generate_getter_mut,
316 generate_setter::generate_setter,
317 generate_delegate_methods::generate_delegate_methods,
318 generate_deref::generate_deref,
319 // Are you sure you want to add new assist here, and not to the
320 // sorted list above?