feat: add space after specific keywords in completion

roife · roife · commit ff669f121d70 · 2024-06-16T17:28:53.000+08:00
diff --git a/crates/ide-completion/src/completions/field.rs b/crates/ide-completion/src/completions/field.rs
@@ -20,9 +20,9 @@ pub(crate) fn complete_field_list_tuple_variant(
     } = path_ctx
     {
         let mut add_keyword = |kw, snippet| acc.add_keyword_snippet(ctx, kw, snippet);
-        add_keyword("pub(crate)", "pub(crate)");
-        add_keyword("pub(super)", "pub(super)");
-        add_keyword("pub", "pub");
+        add_keyword("pub(crate)", "pub(crate) $0");
+        add_keyword("pub(super)", "pub(super) $0");
+        add_keyword("pub", "pub $0");
     }
 }
 
@@ -32,8 +32,8 @@ pub(crate) fn complete_field_list_record_variant(
 ) {
     if ctx.qualifier_ctx.vis_node.is_none() {
         let mut add_keyword = |kw, snippet| acc.add_keyword_snippet(ctx, kw, snippet);
-        add_keyword("pub(crate)", "pub(crate)");
-        add_keyword("pub(super)", "pub(super)");
-        add_keyword("pub", "pub");
+        add_keyword("pub(crate)", "pub(crate) $0");
+        add_keyword("pub(super)", "pub(super) $0");
+        add_keyword("pub", "pub $0");
     }
 }
diff --git a/crates/ide-completion/src/completions/item_list.rs b/crates/ide-completion/src/completions/item_list.rs
@@ -79,7 +79,7 @@ fn add_keywords(acc: &mut Completions, ctx: &CompletionContext<'_>, kind: Option
     let in_trait = matches!(kind, Some(ItemListKind::Trait));
     let in_trait_impl = matches!(kind, Some(ItemListKind::TraitImpl(_)));
     let in_inherent_impl = matches!(kind, Some(ItemListKind::Impl));
-    let no_qualifiers = ctx.qualifier_ctx.vis_node.is_none();
+    let no_vis_qualifiers = ctx.qualifier_ctx.vis_node.is_none();
     let in_block = kind.is_none();
 
     if !in_trait_impl {
@@ -89,7 +89,7 @@ fn add_keywords(acc: &mut Completions, ctx: &CompletionContext<'_>, kind: Option
             }
             if in_item_list {
                 add_keyword("trait", "trait $1 {\n    $0\n}");
-                if no_qualifiers {
+                if no_vis_qualifiers {
                     add_keyword("impl", "impl $1 {\n    $0\n}");
                 }
             }
@@ -104,15 +104,15 @@ fn add_keywords(acc: &mut Completions, ctx: &CompletionContext<'_>, kind: Option
             add_keyword("trait", "trait $1 {\n    $0\n}");
             add_keyword("union", "union $1 {\n    $0\n}");
             add_keyword("use", "use $0");
-            if no_qualifiers {
+            if no_vis_qualifiers {
                 add_keyword("impl", "impl $1 {\n    $0\n}");
             }
         }
 
-        if !in_trait && !in_block && no_qualifiers {
-            add_keyword("pub(crate)", "pub(crate)");
-            add_keyword("pub(super)", "pub(super)");
-            add_keyword("pub", "pub");
+        if !in_trait && !in_block && no_vis_qualifiers {
+            add_keyword("pub(crate)", "pub(crate) $0");
+            add_keyword("pub(super)", "pub(super) $0");
+            add_keyword("pub", "pub $0");
         }
 
         if in_extern_block {
@@ -126,7 +126,7 @@ fn add_keywords(acc: &mut Completions, ctx: &CompletionContext<'_>, kind: Option
             }
 
             add_keyword("fn", "fn $1($2) {\n    $0\n}");
-            add_keyword("unsafe", "unsafe");
+            add_keyword("unsafe", "unsafe $0");
             add_keyword("const", "const $0");
         }
     }
diff --git a/crates/ide-completion/src/completions/keyword.rs b/crates/ide-completion/src/completions/keyword.rs
@@ -14,17 +14,17 @@ pub(crate) fn complete_for_and_where(
     match keyword_item {
         Item::Impl(it) => {
             if it.for_token().is_none() && it.trait_().is_none() && it.self_ty().is_some() {
-                add_keyword("for", "for");
+                add_keyword("for", "for $0");
             }
-            add_keyword("where", "where");
+            add_keyword("where", "where $0");
         }
         Item::Enum(_)
         | Item::Fn(_)
         | Item::Struct(_)
         | Item::Trait(_)
         | Item::TypeAlias(_)
         | Item::Union(_) => {
-            add_keyword("where", "where");
+            add_keyword("where", "where $0");
         }
         _ => (),
     }
diff --git a/crates/ide-completion/src/completions/pattern.rs b/crates/ide-completion/src/completions/pattern.rs
@@ -14,25 +14,27 @@ pub(crate) fn complete_pattern(
     ctx: &CompletionContext<'_>,
     pattern_ctx: &PatternContext,
 ) {
+    let mut add_keyword = |kw, snippet| acc.add_keyword_snippet(ctx, kw, snippet);
+
     match pattern_ctx.parent_pat.as_ref() {
         Some(Pat::RangePat(_) | Pat::BoxPat(_)) => (),
         Some(Pat::RefPat(r)) => {
             if r.mut_token().is_none() {
-                acc.add_keyword(ctx, "mut");
+                add_keyword("mut", "mut $0");
             }
         }
         _ => {
             let tok = ctx.token.text_range().start();
             match (pattern_ctx.ref_token.as_ref(), pattern_ctx.mut_token.as_ref()) {
                 (None, None) => {
-                    acc.add_keyword(ctx, "ref");
-                    acc.add_keyword(ctx, "mut");
+                    add_keyword("ref", "ref $0");
+                    add_keyword("mut", "mut $0");
                 }
                 (None, Some(m)) if tok < m.text_range().start() => {
-                    acc.add_keyword(ctx, "ref");
+                    add_keyword("ref", "ref $0");
                 }
                 (Some(r), None) if tok > r.text_range().end() => {
-                    acc.add_keyword(ctx, "mut");
+                    add_keyword("mut", "mut $0");
                 }
                 _ => (),
             }
diff --git a/crates/ide-completion/src/completions/postfix.rs b/crates/ide-completion/src/completions/postfix.rs
@@ -668,7 +668,7 @@ fn main() {
         check_edit(
             "unsafe",
             r#"fn main() { let x = true else {panic!()}.$0}"#,
-            r#"fn main() { let x = true else {panic!()}.unsafe}"#,
+            r#"fn main() { let x = true else {panic!()}.unsafe $0}"#,
         );
     }
 
diff --git a/crates/ide-completion/src/completions/vis.rs b/crates/ide-completion/src/completions/vis.rs
@@ -33,7 +33,7 @@ pub(crate) fn complete_vis_path(
         Qualified::No => {
             if !has_in_token {
                 cov_mark::hit!(kw_completion_in);
-                acc.add_keyword(ctx, "in");
+                acc.add_keyword_snippet(ctx, "in", "in $0");
             }
             acc.add_nameref_keywords(ctx);
         }
diff --git a/crates/ide-completion/src/tests/item.rs b/crates/ide-completion/src/tests/item.rs
@@ -6,6 +6,8 @@ use expect_test::{expect, Expect};
 
 use crate::tests::{completion_list, BASE_ITEMS_FIXTURE};
 
+use super::check_edit;
+
 fn check(ra_fixture: &str, expect: Expect) {
     let actual = completion_list(&format!("{BASE_ITEMS_FIXTURE}{ra_fixture}"));
     expect.assert_eq(&actual)
@@ -152,3 +154,90 @@ struct Foo {
         "#]],
     )
 }
+
+#[test]
+fn add_space_after_vis_kw() {
+    check_edit(
+        "pub(crate)",
+        r"
+$0
+",
+        r#"
+pub(crate) $0
+"#,
+    );
+
+    check_edit(
+        "pub",
+        r"
+$0
+",
+        r#"
+pub $0
+"#,
+    );
+
+    check_edit(
+        "pub(super)",
+        r"
+$0
+",
+        r#"
+pub(super) $0
+"#,
+    );
+
+    check_edit(
+        "in",
+        r"
+pub($0)
+",
+        r#"
+pub(in $0)
+"#,
+    );
+}
+
+#[test]
+fn add_space_after_unsafe_kw() {
+    check_edit(
+        "unsafe",
+        r"
+$0
+",
+        r#"
+unsafe $0
+"#,
+    );
+}
+
+#[test]
+fn add_space_after_for_where_kw() {
+    check_edit(
+        "for",
+        r#"
+struct S {}
+
+impl Copy $0
+"#,
+        r#"
+struct S {}
+
+impl Copy for $0
+"#,
+    );
+
+    check_edit(
+        "where",
+        r#"
+struct S {}
+
+impl Copy for S $0
+"#,
+        r#"
+struct S {}
+
+impl Copy for S where $0
+"#,
+    );
+}
diff --git a/crates/ide-completion/src/tests/pattern.rs b/crates/ide-completion/src/tests/pattern.rs
@@ -819,3 +819,34 @@ pub enum Enum {
         "#]],
     );
 }
+
+#[test]
+fn add_space_after_mut_ref_kw() {
+    check_edit(
+        "mut",
+        r#"
+fn foo() {
+    let $0
+}
+"#,
+        r#"
+fn foo() {
+    let mut $0
+}
+"#,
+    );
+
+    check_edit(
+        "ref",
+        r#"
+fn foo() {
+    let $0
+}
+"#,
+        r#"
+fn foo() {
+    let ref $0
+}
+"#,
+    );
+}
diff --git a/crates/ide-completion/src/tests/record.rs b/crates/ide-completion/src/tests/record.rs
@@ -2,6 +2,8 @@ use expect_test::{expect, Expect};
 
 use crate::tests::completion_list;
 
+use super::check_edit;
+
 fn check(ra_fixture: &str, expect: Expect) {
     let actual = completion_list(ra_fixture);
     expect.assert_eq(&actual);
@@ -301,3 +303,48 @@ fn foo() {
         expect![[r#""#]],
     )
 }
+
+#[test]
+fn add_space_after_vis_kw() {
+    check_edit(
+        "pub(crate)",
+        r"
+pub(crate) struct S {
+    $0
+}
+",
+        r#"
+pub(crate) struct S {
+    pub(crate) $0
+}
+"#,
+    );
+
+    check_edit(
+        "pub",
+        r"
+pub struct S {
+    $0
+}
+",
+        r#"
+pub struct S {
+    pub $0
+}
+"#,
+    );
+
+    check_edit(
+        "pub(super)",
+        r"
+pub(super) struct S {
+    $0
+}
+",
+        r#"
+pub(super) struct S {
+    pub(super) $0
+}
+"#,
+    );
+}

Original file line number	Diff line number	Diff line change
`@@ -20,9 +20,9 @@ pub(crate) fn complete_field_list_tuple_variant(`
`20`	`20`	`} = path_ctx`
`21`	`21`	`{`
`22`	`22`	`let mut add_keyword = \|kw, snippet\| acc.add_keyword_snippet(ctx, kw, snippet);`
`23`		`- add_keyword("pub(crate)", "pub(crate)");`
`24`		`- add_keyword("pub(super)", "pub(super)");`
`25`		`- add_keyword("pub", "pub");`
	`23`	`+ add_keyword("pub(crate)", "pub(crate) $0");`
	`24`	`+ add_keyword("pub(super)", "pub(super) $0");`
	`25`	`+ add_keyword("pub", "pub $0");`
`26`	`26`	`}`
`27`	`27`	`}`
`28`	`28`
`@@ -32,8 +32,8 @@ pub(crate) fn complete_field_list_record_variant(`
`32`	`32`	`) {`
`33`	`33`	`if ctx.qualifier_ctx.vis_node.is_none() {`
`34`	`34`	`let mut add_keyword = \|kw, snippet\| acc.add_keyword_snippet(ctx, kw, snippet);`
`35`		`- add_keyword("pub(crate)", "pub(crate)");`
`36`		`- add_keyword("pub(super)", "pub(super)");`
`37`		`- add_keyword("pub", "pub");`
	`35`	`+ add_keyword("pub(crate)", "pub(crate) $0");`
	`36`	`+ add_keyword("pub(super)", "pub(super) $0");`
	`37`	`+ add_keyword("pub", "pub $0");`
`38`	`38`	`}`
`39`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,7 @@ fn add_keywords(acc: &mut Completions, ctx: &CompletionContext<'_>, kind: Option`
`79`	`79`	`let in_trait = matches!(kind, Some(ItemListKind::Trait));`
`80`	`80`	`let in_trait_impl = matches!(kind, Some(ItemListKind::TraitImpl(_)));`
`81`	`81`	`let in_inherent_impl = matches!(kind, Some(ItemListKind::Impl));`
`82`		`- let no_qualifiers = ctx.qualifier_ctx.vis_node.is_none();`
	`82`	`+ let no_vis_qualifiers = ctx.qualifier_ctx.vis_node.is_none();`
`83`	`83`	`let in_block = kind.is_none();`
`84`	`84`
`85`	`85`	`if !in_trait_impl {`
`@@ -89,7 +89,7 @@ fn add_keywords(acc: &mut Completions, ctx: &CompletionContext<'_>, kind: Option`
`89`	`89`	`}`
`90`	`90`	`if in_item_list {`
`91`	`91`	`add_keyword("trait", "trait $1 {\n $0\n}");`
`92`		`- if no_qualifiers {`
	`92`	`+ if no_vis_qualifiers {`
`93`	`93`	`add_keyword("impl", "impl $1 {\n $0\n}");`
`94`	`94`	`}`
`95`	`95`	`}`
`@@ -104,15 +104,15 @@ fn add_keywords(acc: &mut Completions, ctx: &CompletionContext<'_>, kind: Option`
`104`	`104`	`add_keyword("trait", "trait $1 {\n $0\n}");`
`105`	`105`	`add_keyword("union", "union $1 {\n $0\n}");`
`106`	`106`	`add_keyword("use", "use $0");`
`107`		`- if no_qualifiers {`
	`107`	`+ if no_vis_qualifiers {`
`108`	`108`	`add_keyword("impl", "impl $1 {\n $0\n}");`
`109`	`109`	`}`
`110`	`110`	`}`
`111`	`111`
`112`		`- if !in_trait && !in_block && no_qualifiers {`
`113`		`- add_keyword("pub(crate)", "pub(crate)");`
`114`		`- add_keyword("pub(super)", "pub(super)");`
`115`		`- add_keyword("pub", "pub");`
	`112`	`+ if !in_trait && !in_block && no_vis_qualifiers {`
	`113`	`+ add_keyword("pub(crate)", "pub(crate) $0");`
	`114`	`+ add_keyword("pub(super)", "pub(super) $0");`
	`115`	`+ add_keyword("pub", "pub $0");`
`116`	`116`	`}`
`117`	`117`
`118`	`118`	`if in_extern_block {`
`@@ -126,7 +126,7 @@ fn add_keywords(acc: &mut Completions, ctx: &CompletionContext<'_>, kind: Option`
`126`	`126`	`}`
`127`	`127`
`128`	`128`	`add_keyword("fn", "fn $1($2) {\n $0\n}");`
`129`		`- add_keyword("unsafe", "unsafe");`
	`129`	`+ add_keyword("unsafe", "unsafe $0");`
`130`	`130`	`add_keyword("const", "const $0");`
`131`	`131`	`}`
`132`	`132`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,17 +14,17 @@ pub(crate) fn complete_for_and_where(`
`14`	`14`	`match keyword_item {`
`15`	`15`	`Item::Impl(it) => {`
`16`	`16`	`if it.for_token().is_none() && it.trait_().is_none() && it.self_ty().is_some() {`
`17`		`- add_keyword("for", "for");`
	`17`	`+ add_keyword("for", "for $0");`
`18`	`18`	`}`
`19`		`- add_keyword("where", "where");`
	`19`	`+ add_keyword("where", "where $0");`
`20`	`20`	`}`
`21`	`21`	`Item::Enum(_)`
`22`	`22`	`\| Item::Fn(_)`
`23`	`23`	`\| Item::Struct(_)`
`24`	`24`	`\| Item::Trait(_)`
`25`	`25`	`\| Item::TypeAlias(_)`
`26`	`26`	`\| Item::Union(_) => {`
`27`		`- add_keyword("where", "where");`
	`27`	`+ add_keyword("where", "where $0");`
`28`	`28`	`}`
`29`	`29`	`_ => (),`
`30`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,25 +14,27 @@ pub(crate) fn complete_pattern(`
`14`	`14`	`ctx: &CompletionContext<'_>,`
`15`	`15`	`pattern_ctx: &PatternContext,`
`16`	`16`	`) {`
	`17`	`+ let mut add_keyword = \|kw, snippet\| acc.add_keyword_snippet(ctx, kw, snippet);`
	`18`	`+`
`17`	`19`	`match pattern_ctx.parent_pat.as_ref() {`
`18`	`20`	`Some(Pat::RangePat(_) \| Pat::BoxPat(_)) => (),`
`19`	`21`	`Some(Pat::RefPat(r)) => {`
`20`	`22`	`if r.mut_token().is_none() {`
`21`		`- acc.add_keyword(ctx, "mut");`
	`23`	`+ add_keyword("mut", "mut $0");`
`22`	`24`	`}`
`23`	`25`	`}`
`24`	`26`	`_ => {`
`25`	`27`	`let tok = ctx.token.text_range().start();`
`26`	`28`	`match (pattern_ctx.ref_token.as_ref(), pattern_ctx.mut_token.as_ref()) {`
`27`	`29`	`(None, None) => {`
`28`		`- acc.add_keyword(ctx, "ref");`
`29`		`- acc.add_keyword(ctx, "mut");`
	`30`	`+ add_keyword("ref", "ref $0");`
	`31`	`+ add_keyword("mut", "mut $0");`
`30`	`32`	`}`
`31`	`33`	`(None, Some(m)) if tok < m.text_range().start() => {`
`32`		`- acc.add_keyword(ctx, "ref");`
	`34`	`+ add_keyword("ref", "ref $0");`
`33`	`35`	`}`
`34`	`36`	`(Some(r), None) if tok > r.text_range().end() => {`
`35`		`- acc.add_keyword(ctx, "mut");`
	`37`	`+ add_keyword("mut", "mut $0");`
`36`	`38`	`}`
`37`	`39`	`_ => (),`
`38`	`40`	`}`
Original file line number	Diff line number	Diff line change
`@@ -668,7 +668,7 @@ fn main() {`
`668`	`668`	`check_edit(`
`669`	`669`	`"unsafe",`
`670`	`670`	`r#"fn main() { let x = true else {panic!()}.$0}"#,`
`671`		`- r#"fn main() { let x = true else {panic!()}.unsafe}"#,`
	`671`	`+ r#"fn main() { let x = true else {panic!()}.unsafe $0}"#,`
`672`	`672`	`);`
`673`	`673`	`}`
`674`	`674`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ pub(crate) fn complete_vis_path(`
`33`	`33`	`Qualified::No => {`
`34`	`34`	`if !has_in_token {`
`35`	`35`	`cov_mark::hit!(kw_completion_in);`
`36`		`- acc.add_keyword(ctx, "in");`
	`36`	`+ acc.add_keyword_snippet(ctx, "in", "in $0");`
`37`	`37`	`}`
`38`	`38`	`acc.add_nameref_keywords(ctx);`
`39`	`39`	`}`