snippet edit support no longer experimental

Author: BenjaminBrienen

Cargo.lock

@@ -1,12 +1,8 @@
 //! Settings for tweaking assists.
-//!
-//! The fun thing here is `SnippetCap` -- this type can only be created in this
-//! module, and we use to statically check that we only produce snippet
-//! assists if we are allowed to.
 
 use hir::FindPathConfig;
 use ide_db::{
-    SnippetCap,
+    WorkspaceSnippetCap,
     assists::ExprFillDefaultMode,
     imports::{import_assets::ImportPathConfig, insert_use::InsertUseConfig},
     rename::RenameConfig,
@@ -16,7 +12,7 @@ use crate::AssistKind;
 
 #[derive(Clone, Debug, PartialEq, Eq)]
 pub struct AssistConfig {
-    pub snippet_cap: Option<SnippetCap>,
+    pub workspace_snippet_cap: Option<WorkspaceSnippetCap>,
     pub allowed: Option<Vec<AssistKind>>,
     pub insert_use: InsertUseConfig,
     pub prefer_no_std: bool,

crates/ide-assists/src/assist_config.rs

@@ -53,8 +53,11 @@ pub(crate) fn add_label_to_loop(acc: &mut Assists, ctx: &AssistContext<'_>) -> O
             ];
             editor.insert_all(Position::before(&loop_kw), elements);
 
-            if let Some(cap) = ctx.config.snippet_cap {
-                editor.add_annotation(label.syntax(), builder.make_placeholder_snippet(cap));
+            if let Some(workspace_snippet_cap) = ctx.config.workspace_snippet_cap {
+                editor.add_annotation(
+                    label.syntax(),
+                    builder.make_placeholder_snippet(workspace_snippet_cap),
+                );
             }
 
             let loop_body = loop_expr.loop_body().and_then(|it| it.stmt_list());
@@ -94,8 +97,11 @@ fn insert_label_after_token(
     let elements = vec![make.whitespace(" ").into(), label.syntax().clone().into()];
     editor.insert_all(Position::after(token), elements);
 
-    if let Some(cap) = ctx.config.snippet_cap {
-        editor.add_annotation(label.syntax(), builder.make_placeholder_snippet(cap));
+    if let Some(workspace_snippet_cap) = ctx.config.workspace_snippet_cap {
+        editor.add_annotation(
+            label.syntax(),
+            builder.make_placeholder_snippet(workspace_snippet_cap),
+        );
     }
 }
 

crates/ide-assists/src/handlers/add_label_to_loop.rs

@@ -200,7 +200,7 @@ fn add_missing_impl_members_inner(
             first_new_item = assoc_item_list.assoc_items().next();
         }
 
-        if let Some(cap) = ctx.config.snippet_cap {
+        if let Some(workspace_snippet_cap) = ctx.config.workspace_snippet_cap {
             let mut placeholder = None;
             if let DefaultMethods::No = mode
                 && let Some(ast::AssocItem::Fn(func)) = &first_new_item
@@ -211,10 +211,10 @@ fn add_missing_impl_members_inner(
             }
 
             if let Some(macro_call) = placeholder {
-                let placeholder = edit.make_placeholder_snippet(cap);
+                let placeholder = edit.make_placeholder_snippet(workspace_snippet_cap);
                 editor.add_annotation(macro_call.syntax(), placeholder);
             } else if let Some(first_new_item) = first_new_item {
-                let tabstop = edit.make_tabstop_before(cap);
+                let tabstop = edit.make_tabstop_before(workspace_snippet_cap);
                 editor.add_annotation(first_new_item.syntax(), tabstop);
             };
         };

crates/ide-assists/src/handlers/add_missing_impl_members.rs

@@ -278,22 +278,31 @@ pub(crate) fn add_missing_match_arms(acc: &mut Assists, ctx: &AssistContext<'_>)
             arms_edit.add_comma_after_last_arm(ctx, &make, &editor);
             arms_edit.append_arms(&missing_arms, &make, &editor);
 
-            if let Some(cap) = ctx.config.snippet_cap {
+            if let Some(workspace_snippet_cap) = ctx.config.workspace_snippet_cap {
                 if let Some(it) = missing_arms
                     .first()
                     .and_then(|arm| arm.syntax().descendants().find_map(ast::WildcardPat::cast))
                 {
-                    editor.add_annotation(it.syntax(), builder.make_placeholder_snippet(cap));
+                    editor.add_annotation(
+                        it.syntax(),
+                        builder.make_placeholder_snippet(workspace_snippet_cap),
+                    );
                 }
 
                 for arm in &missing_arms {
                     if let Some(expr) = arm.expr() {
-                        editor.add_annotation(expr.syntax(), builder.make_placeholder_snippet(cap));
+                        editor.add_annotation(
+                            expr.syntax(),
+                            builder.make_placeholder_snippet(workspace_snippet_cap),
+                        );
                     }
                 }
 
                 if let Some(arm) = missing_arms.last() {
-                    editor.add_annotation(arm.syntax(), builder.make_tabstop_after(cap));
+                    editor.add_annotation(
+                        arm.syntax(),
+                        builder.make_tabstop_after(workspace_snippet_cap),
+                    );
                 }
             }
 

crates/ide-assists/src/handlers/add_missing_match_arms.rs

@@ -112,10 +112,10 @@ pub(crate) fn add_turbo_fish(acc: &mut Assists, ctx: &AssistContext<'_>) -> Opti
                             placeholder_ty.syntax().clone().into(),
                         ];
                         editor.insert_all(Position::after(pat.syntax()), elements);
-                        if let Some(cap) = ctx.config.snippet_cap {
+                        if let Some(workspace_snippet_cap) = ctx.config.workspace_snippet_cap {
                             editor.add_annotation(
                                 placeholder_ty.syntax(),
-                                builder.make_placeholder_snippet(cap),
+                                builder.make_placeholder_snippet(workspace_snippet_cap),
                             );
                         }
                     }
@@ -173,9 +173,12 @@ pub(crate) fn add_turbo_fish(acc: &mut Assists, ctx: &AssistContext<'_>) -> Opti
                 }
             };
 
-            if let Some(cap) = ctx.config.snippet_cap {
+            if let Some(workspace_snippet_cap) = ctx.config.workspace_snippet_cap {
                 for arg in fish_head.generic_args() {
-                    editor.add_annotation(arg.syntax(), builder.make_placeholder_snippet(cap));
+                    editor.add_annotation(
+                        arg.syntax(),
+                        builder.make_placeholder_snippet(workspace_snippet_cap),
+                    );
                 }
             }
             builder.add_file_edits(ctx.vfs_file_id(), editor);

crates/ide-assists/src/handlers/add_turbo_fish.rs

@@ -94,11 +94,11 @@ pub(crate) fn convert_from_to_tryfrom(acc: &mut Assists, ctx: &AssistContext<'_>
                 make.ty_alias(None, "Error", None, None, None, Some((make.ty("()"), None)));
             let error_type = ast::AssocItem::TypeAlias(error_type_alias);
 
-            if let Some(cap) = ctx.config.snippet_cap
+            if let Some(workspace_snippet_cap) = ctx.config.workspace_snippet_cap
                 && let ast::AssocItem::TypeAlias(type_alias) = &error_type
                 && let Some(ty) = type_alias.ty()
             {
-                let placeholder = builder.make_placeholder_snippet(cap);
+                let placeholder = builder.make_placeholder_snippet(workspace_snippet_cap);
                 editor.add_annotation(ty.syntax(), placeholder);
             }
 

crates/ide-assists/src/handlers/convert_from_to_tryfrom.rs

@@ -192,10 +192,10 @@ fn edit_tuple_assignment(
         .and_then(ast::RecordPatField::for_field_name)
         .is_some_and(|field| field.colon_token().is_none());
 
-    if let Some(cap) = ctx.config.snippet_cap {
+    if let Some(workspace_snippet_cap) = ctx.config.workspace_snippet_cap {
         // place cursor on first tuple name
         if let Some(ast::Pat::IdentPat(first_pat)) = tuple_pat.fields().next() {
-            let annotation = edit.make_tabstop_before(cap);
+            let annotation = edit.make_tabstop_before(workspace_snippet_cap);
             editor.add_annotation(
                 first_pat.name().expect("first ident pattern should have a name").syntax(),
                 annotation,

crates/ide-assists/src/handlers/destructure_tuple_binding.rs

@@ -134,7 +134,7 @@ pub(crate) fn extract_expressions_from_format_string(
             let new_tt = make.token_tree(tt_delimiter, new_tt_bits);
             editor.replace(tt.syntax(), new_tt.syntax());
 
-            if let Some(cap) = ctx.config.snippet_cap {
+            if let Some(workspace_snippet_cap) = ctx.config.workspace_snippet_cap {
                 // Add placeholder snippets over placeholder args
                 for pos in placeholder_indexes {
                     // Skip the opening delimiter
@@ -145,7 +145,7 @@ pub(crate) fn extract_expressions_from_format_string(
                     };
 
                     if stdx::always!(placeholder.kind() == T![_]) {
-                        let annotation = edit.make_placeholder_snippet(cap);
+                        let annotation = edit.make_placeholder_snippet(workspace_snippet_cap);
                         editor.add_annotation(placeholder, annotation);
                     }
                 }
@@ -154,7 +154,7 @@ pub(crate) fn extract_expressions_from_format_string(
                 if let Some(NodeOrToken::Token(literal)) =
                     new_tt.token_trees_and_tokens().nth(1 + format_string_index)
                 {
-                    let annotation = edit.make_tabstop_after(cap);
+                    let annotation = edit.make_tabstop_after(workspace_snippet_cap);
                     editor.add_annotation(literal, annotation);
                 }
             }
@@ -179,7 +179,7 @@ fn format_str_index(
 #[cfg(test)]
 mod tests {
     use super::*;
-    use crate::tests::{check_assist, check_assist_no_snippet_cap};
+    use crate::tests::{check_assist, check_assist_no_workspace_snippet_cap};
 
     #[test]
     fn multiple_middle_arg() {
@@ -347,7 +347,7 @@ fn main() {
 
     #[test]
     fn without_snippets() {
-        check_assist_no_snippet_cap(
+        check_assist_no_workspace_snippet_cap(
             extract_expressions_from_format_string,
             r#"
 //- minicore: fmt

crates/ide-assists/src/handlers/extract_expressions_from_format_string.rs

@@ -177,10 +177,10 @@ pub(crate) fn extract_function(acc: &mut Assists, ctx: &AssistContext<'_>) -> Op
 
             let fn_def = format_function(ctx, module, &fun, old_indent).clone_for_update();
 
-            if let Some(cap) = ctx.config.snippet_cap
+            if let Some(workspace_snippet_cap) = ctx.config.workspace_snippet_cap
                 && let Some(name) = fn_def.name()
             {
-                builder.add_tabstop_before(cap, name);
+                builder.add_tabstop_before(workspace_snippet_cap, name);
             }
 
             // FIXME: wrap non-adt types