Skip to content

Commit 50ba0c0

Browse files
borsbors
committed
Auto merge of #17431 - roife:fix-issue-17428, r=Veykril
feat: add space after specific keywords in completion fix #17428. When completing some specific keywords, it would be convenient if r-a could automatically add a space afterwards. This PR implements this feature for the following keywords: - Visibility: `pub`, `pub(crate)`, `pub(super)`, `pub(in xxx)` - Pattern: `ref` / `mut` - Others: `unsafe` / `for` / `where`
2 parents cbbdf1e + a8ca5d0 commit 50ba0c0

File tree

9 files changed

+193
-24
lines changed

9 files changed

+193
-24
lines changed

‎src/tools/rust-analyzer/crates/ide-completion/src/completions/field.rs

+6-6
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ pub(crate) fn complete_field_list_tuple_variant(
2020
} = path_ctx
2121
{
2222
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");
2626
}
2727
}
2828

@@ -32,8 +32,8 @@ pub(crate) fn complete_field_list_record_variant(
3232
) {
3333
if ctx.qualifier_ctx.vis_node.is_none() {
3434
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");
3838
}
3939
}

‎src/tools/rust-analyzer/crates/ide-completion/src/completions/item_list.rs

+8-8
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ fn add_keywords(acc: &mut Completions, ctx: &CompletionContext<'_>, kind: Option
7979
let in_trait = matches!(kind, Some(ItemListKind::Trait));
8080
let in_trait_impl = matches!(kind, Some(ItemListKind::TraitImpl(_)));
8181
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();
8383
let in_block = kind.is_none();
8484

8585
if !in_trait_impl {
@@ -89,7 +89,7 @@ fn add_keywords(acc: &mut Completions, ctx: &CompletionContext<'_>, kind: Option
8989
}
9090
if in_item_list {
9191
add_keyword("trait", "trait $1 {\n $0\n}");
92-
if no_qualifiers {
92+
if no_vis_qualifiers {
9393
add_keyword("impl", "impl $1 {\n $0\n}");
9494
}
9595
}
@@ -104,15 +104,15 @@ fn add_keywords(acc: &mut Completions, ctx: &CompletionContext<'_>, kind: Option
104104
add_keyword("trait", "trait $1 {\n $0\n}");
105105
add_keyword("union", "union $1 {\n $0\n}");
106106
add_keyword("use", "use $0");
107-
if no_qualifiers {
107+
if no_vis_qualifiers {
108108
add_keyword("impl", "impl $1 {\n $0\n}");
109109
}
110110
}
111111

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");
116116
}
117117

118118
if in_extern_block {
@@ -126,7 +126,7 @@ fn add_keywords(acc: &mut Completions, ctx: &CompletionContext<'_>, kind: Option
126126
}
127127

128128
add_keyword("fn", "fn $1($2) {\n $0\n}");
129-
add_keyword("unsafe", "unsafe");
129+
add_keyword("unsafe", "unsafe $0");
130130
add_keyword("const", "const $0");
131131
}
132132
}

‎src/tools/rust-analyzer/crates/ide-completion/src/completions/keyword.rs

+3-3
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,17 @@ pub(crate) fn complete_for_and_where(
1414
match keyword_item {
1515
Item::Impl(it) => {
1616
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");
1818
}
19-
add_keyword("where", "where");
19+
add_keyword("where", "where $0");
2020
}
2121
Item::Enum(_)
2222
| Item::Fn(_)
2323
| Item::Struct(_)
2424
| Item::Trait(_)
2525
| Item::TypeAlias(_)
2626
| Item::Union(_) => {
27-
add_keyword("where", "where");
27+
add_keyword("where", "where $0");
2828
}
2929
_ => (),
3030
}

‎src/tools/rust-analyzer/crates/ide-completion/src/completions/pattern.rs

+7-5
Original file line numberDiff line numberDiff line change
@@ -14,25 +14,27 @@ pub(crate) fn complete_pattern(
1414
ctx: &CompletionContext<'_>,
1515
pattern_ctx: &PatternContext,
1616
) {
17+
let mut add_keyword = |kw, snippet| acc.add_keyword_snippet(ctx, kw, snippet);
18+
1719
match pattern_ctx.parent_pat.as_ref() {
1820
Some(Pat::RangePat(_) | Pat::BoxPat(_)) => (),
1921
Some(Pat::RefPat(r)) => {
2022
if r.mut_token().is_none() {
21-
acc.add_keyword(ctx, "mut");
23+
add_keyword("mut", "mut $0");
2224
}
2325
}
2426
_ => {
2527
let tok = ctx.token.text_range().start();
2628
match (pattern_ctx.ref_token.as_ref(), pattern_ctx.mut_token.as_ref()) {
2729
(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");
3032
}
3133
(None, Some(m)) if tok < m.text_range().start() => {
32-
acc.add_keyword(ctx, "ref");
34+
add_keyword("ref", "ref $0");
3335
}
3436
(Some(r), None) if tok > r.text_range().end() => {
35-
acc.add_keyword(ctx, "mut");
37+
add_keyword("mut", "mut $0");
3638
}
3739
_ => (),
3840
}

‎src/tools/rust-analyzer/crates/ide-completion/src/completions/postfix.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -668,7 +668,7 @@ fn main() {
668668
check_edit(
669669
"unsafe",
670670
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}"#,
672672
);
673673
}
674674

‎src/tools/rust-analyzer/crates/ide-completion/src/completions/vis.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ pub(crate) fn complete_vis_path(
3333
Qualified::No => {
3434
if !has_in_token {
3535
cov_mark::hit!(kw_completion_in);
36-
acc.add_keyword(ctx, "in");
36+
acc.add_keyword_snippet(ctx, "in", "in $0");
3737
}
3838
acc.add_nameref_keywords(ctx);
3939
}

‎src/tools/rust-analyzer/crates/ide-completion/src/tests/item.rs

+89
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ use expect_test::{expect, Expect};
66

77
use crate::tests::{completion_list, BASE_ITEMS_FIXTURE};
88

9+
use super::check_edit;
10+
911
fn check(ra_fixture: &str, expect: Expect) {
1012
let actual = completion_list(&format!("{BASE_ITEMS_FIXTURE}{ra_fixture}"));
1113
expect.assert_eq(&actual)
@@ -152,3 +154,90 @@ struct Foo {
152154
"#]],
153155
)
154156
}
157+
158+
#[test]
159+
fn add_space_after_vis_kw() {
160+
check_edit(
161+
"pub(crate)",
162+
r"
163+
$0
164+
",
165+
r#"
166+
pub(crate) $0
167+
"#,
168+
);
169+
170+
check_edit(
171+
"pub",
172+
r"
173+
$0
174+
",
175+
r#"
176+
pub $0
177+
"#,
178+
);
179+
180+
check_edit(
181+
"pub(super)",
182+
r"
183+
$0
184+
",
185+
r#"
186+
pub(super) $0
187+
"#,
188+
);
189+
190+
check_edit(
191+
"in",
192+
r"
193+
pub($0)
194+
",
195+
r#"
196+
pub(in $0)
197+
"#,
198+
);
199+
}
200+
201+
#[test]
202+
fn add_space_after_unsafe_kw() {
203+
check_edit(
204+
"unsafe",
205+
r"
206+
$0
207+
",
208+
r#"
209+
unsafe $0
210+
"#,
211+
);
212+
}
213+
214+
#[test]
215+
fn add_space_after_for_where_kw() {
216+
check_edit(
217+
"for",
218+
r#"
219+
struct S {}
220+
221+
impl Copy $0
222+
"#,
223+
r#"
224+
struct S {}
225+
226+
impl Copy for $0
227+
"#,
228+
);
229+
230+
check_edit(
231+
"where",
232+
r#"
233+
struct S {}
234+
235+
impl Copy for S $0
236+
"#,
237+
r#"
238+
struct S {}
239+
240+
impl Copy for S where $0
241+
"#,
242+
);
243+
}

‎src/tools/rust-analyzer/crates/ide-completion/src/tests/pattern.rs

+31
Original file line numberDiff line numberDiff line change
@@ -819,3 +819,34 @@ pub enum Enum {
819819
"#]],
820820
);
821821
}
822+
823+
#[test]
824+
fn add_space_after_mut_ref_kw() {
825+
check_edit(
826+
"mut",
827+
r#"
828+
fn foo() {
829+
let $0
830+
}
831+
"#,
832+
r#"
833+
fn foo() {
834+
let mut $0
835+
}
836+
"#,
837+
);
838+
839+
check_edit(
840+
"ref",
841+
r#"
842+
fn foo() {
843+
let $0
844+
}
845+
"#,
846+
r#"
847+
fn foo() {
848+
let ref $0
849+
}
850+
"#,
851+
);
852+
}

‎src/tools/rust-analyzer/crates/ide-completion/src/tests/record.rs

+47
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@ use expect_test::{expect, Expect};
22

33
use crate::tests::completion_list;
44

5+
use super::check_edit;
6+
57
fn check(ra_fixture: &str, expect: Expect) {
68
let actual = completion_list(ra_fixture);
79
expect.assert_eq(&actual);
@@ -301,3 +303,48 @@ fn foo() {
301303
expect![[r#""#]],
302304
)
303305
}
306+
307+
#[test]
308+
fn add_space_after_vis_kw() {
309+
check_edit(
310+
"pub(crate)",
311+
r"
312+
pub(crate) struct S {
313+
$0
314+
}
315+
",
316+
r#"
317+
pub(crate) struct S {
318+
pub(crate) $0
319+
}
320+
"#,
321+
);
322+
323+
check_edit(
324+
"pub",
325+
r"
326+
pub struct S {
327+
$0
328+
}
329+
",
330+
r#"
331+
pub struct S {
332+
pub $0
333+
}
334+
"#,
335+
);
336+
337+
check_edit(
338+
"pub(super)",
339+
r"
340+
pub(super) struct S {
341+
$0
342+
}
343+
",
344+
r#"
345+
pub(super) struct S {
346+
pub(super) $0
347+
}
348+
"#,
349+
);
350+
}

0 commit comments

Comments
 (0)