Unnamed repository; edit this file 'description' to name the repository.
Add a few default snippets for VSCode
| -rw-r--r-- | crates/ide_completion/src/completions/postfix.rs | 3 | ||||
| -rw-r--r-- | crates/ide_completion/src/snippet.rs | 54 | ||||
| -rw-r--r-- | crates/rust-analyzer/src/config.rs | 43 | ||||
| -rw-r--r-- | docs/user/generated_config.adoc | 42 | ||||
| -rw-r--r-- | editors/code/package.json | 42 |
5 files changed, 175 insertions, 9 deletions
diff --git a/crates/ide_completion/src/completions/postfix.rs b/crates/ide_completion/src/completions/postfix.rs index c239401e48..d455976b03 100644 --- a/crates/ide_completion/src/completions/postfix.rs +++ b/crates/ide_completion/src/completions/postfix.rs @@ -163,9 +163,6 @@ pub(crate) fn complete_postfix(acc: &mut Completions, ctx: &CompletionContext) { } postfix_snippet("box", "Box::new(expr)", &format!("Box::new({})", receiver_text)).add_to(acc); - postfix_snippet("ok", "Ok(expr)", &format!("Ok({})", receiver_text)).add_to(acc); - postfix_snippet("err", "Err(expr)", &format!("Err({})", receiver_text)).add_to(acc); - postfix_snippet("some", "Some(expr)", &format!("Some({})", receiver_text)).add_to(acc); postfix_snippet("dbg", "dbg!(expr)", &format!("dbg!({})", receiver_text)).add_to(acc); postfix_snippet("dbgr", "dbg!(&expr)", &format!("dbg!(&{})", receiver_text)).add_to(acc); postfix_snippet("call", "function(expr)", &format!("${{1}}({})", receiver_text)).add_to(acc); diff --git a/crates/ide_completion/src/snippet.rs b/crates/ide_completion/src/snippet.rs index 1a3f42b839..c5e2b009c7 100644 --- a/crates/ide_completion/src/snippet.rs +++ b/crates/ide_completion/src/snippet.rs @@ -52,8 +52,56 @@ use std::ops::Deref; // These placeholders take the form of `$number` or `${number:placeholder_text}` which can be traversed as tabstop in ascending order starting from 1, // with `$0` being a special case that always comes last. // -// There is also a special placeholder, `${receiver}`, which will be replaced by the receiver expression for postfix snippets, or nothing in case of normal snippets. -// It does not act as a tabstop. +// There is also a special placeholder, `${receiver}`, which will be replaced by the receiver expression for postfix snippets, or a `$0` tabstop in case of normal snippets. +// This replacement for normal snippets allows you to reuse a snippet for both post- and prefix in a single definition. +// +// For the VSCode editor, rust-analyzer also ships with a small set of defaults which can be removed +// by overwriting the settings object mentioned above, the defaults are: +// [source,json] +// ---- +// { +// "Arc::new": { +// "postfix": "arc", +// "body": "Arc::new(${receiver})", +// "requires": "std::sync::Arc", +// "description": "Put the expression into an `Arc`", +// "scope": "expr" +// }, +// "Rc::new": { +// "postfix": "rc", +// "body": "Rc::new(${receiver})", +// "requires": "std::rc::Rc", +// "description": "Put the expression into an `Rc`", +// "scope": "expr" +// }, +// "Box::pin": { +// "postfix": "pinbox", +// "body": "Box::pin(${receiver})", +// "requires": "std::boxed::Box", +// "description": "Put the expression into a pinned `Box`", +// "scope": "expr" +// }, +// "Ok": { +// "postfix": "ok", +// "body": "Ok(${receiver})", +// "description": "Wrap the expression in a `Result::Ok`", +// "scope": "expr" +// }, +// "Err": { +// "postfix": "err", +// "body": "Err(${receiver})", +// "description": "Wrap the expression in a `Result::Err`", +// "scope": "expr" +// }, +// "Some": { +// "postfix": "some", +// "body": "Some(${receiver})", +// "description": "Wrap the expression in an `Option::Some`", +// "scope": "expr" +// } +// } +// ---- + use ide_db::helpers::{import_assets::LocatedImport, insert_use::ImportScope}; use itertools::Itertools; use syntax::{ast, AstNode, GreenNode, SyntaxNode}; @@ -117,7 +165,7 @@ impl Snippet { } pub fn snippet(&self) -> String { - self.snippet.replace("${receiver}", "") + self.snippet.replace("${receiver}", "$0") } pub fn postfix_snippet(&self, receiver: &str) -> String { diff --git a/crates/rust-analyzer/src/config.rs b/crates/rust-analyzer/src/config.rs index 5826b6b114..867f2bd1f0 100644 --- a/crates/rust-analyzer/src/config.rs +++ b/crates/rust-analyzer/src/config.rs @@ -116,7 +116,48 @@ config_data! { /// Whether to add parenthesis when completing functions. completion_addCallParenthesis: bool = "true", /// Custom completion snippets. - completion_snippets: FxHashMap<String, SnippetDef> = "{}", + // NOTE: Keep this list in sync with the feature docs of user snippets. + completion_snippets: FxHashMap<String, SnippetDef> = r#"{ + "Arc::new": { + "postfix": "arc", + "body": "Arc::new(${receiver})", + "requires": "std::sync::Arc", + "description": "Put the expression into an `Arc`", + "scope": "expr" + }, + "Rc::new": { + "postfix": "rc", + "body": "Rc::new(${receiver})", + "requires": "std::rc::Rc", + "description": "Put the expression into an `Rc`", + "scope": "expr" + }, + "Box::pin": { + "postfix": "pinbox", + "body": "Box::pin(${receiver})", + "requires": "std::boxed::Box", + "description": "Put the expression into a pinned `Box`", + "scope": "expr" + }, + "Ok": { + "postfix": "ok", + "body": "Ok(${receiver})", + "description": "Wrap the expression in a `Result::Ok`", + "scope": "expr" + }, + "Err": { + "postfix": "err", + "body": "Err(${receiver})", + "description": "Wrap the expression in a `Result::Err`", + "scope": "expr" + }, + "Some": { + "postfix": "some", + "body": "Some(${receiver})", + "description": "Wrap the expression in an `Option::Some`", + "scope": "expr" + } + }"#, /// Whether to show postfix snippets like `dbg`, `if`, `not`, etc. completion_postfix_enable: bool = "true", /// Toggles the additional completions that automatically add imports when completed. diff --git a/docs/user/generated_config.adoc b/docs/user/generated_config.adoc index 9f6f046014..494051b306 100644 --- a/docs/user/generated_config.adoc +++ b/docs/user/generated_config.adoc @@ -141,7 +141,47 @@ Only applies when `#rust-analyzer.completion.addCallParenthesis#` is set. -- Whether to add parenthesis when completing functions. -- -[[rust-analyzer.completion.snippets]]rust-analyzer.completion.snippets (default: `{}`):: +[[rust-analyzer.completion.snippets]]rust-analyzer.completion.snippets (default: `{ + "Arc::new": { + "postfix": "arc", + "body": "Arc::new(${receiver})", + "requires": "std::sync::Arc", + "description": "Put the expression into an `Arc`", + "scope": "expr" + }, + "Rc::new": { + "postfix": "rc", + "body": "Rc::new(${receiver})", + "requires": "std::rc::Rc", + "description": "Put the expression into an `Rc`", + "scope": "expr" + }, + "Box::pin": { + "postfix": "pinbox", + "body": "Box::pin(${receiver})", + "requires": "std::boxed::Box", + "description": "Put the expression into a pinned `Box`", + "scope": "expr" + }, + "Ok": { + "postfix": "ok", + "body": "Ok(${receiver})", + "description": "Wrap the expression in a `Result::Ok`", + "scope": "expr" + }, + "Err": { + "postfix": "err", + "body": "Err(${receiver})", + "description": "Wrap the expression in a `Result::Err`", + "scope": "expr" + }, + "Some": { + "postfix": "some", + "body": "Some(${receiver})", + "description": "Wrap the expression in an `Option::Some`", + "scope": "expr" + } + }`):: + -- Custom completion snippets. diff --git a/editors/code/package.json b/editors/code/package.json index 2460308820..d70ac9aacb 100644 --- a/editors/code/package.json +++ b/editors/code/package.json @@ -592,7 +592,47 @@ }, "rust-analyzer.completion.snippets": { "markdownDescription": "Custom completion snippets.", - "default": {}, + "default": { + "Arc::new": { + "postfix": "arc", + "body": "Arc::new(${receiver})", + "requires": "std::sync::Arc", + "description": "Put the expression into an `Arc`", + "scope": "expr" + }, + "Rc::new": { + "postfix": "rc", + "body": "Rc::new(${receiver})", + "requires": "std::rc::Rc", + "description": "Put the expression into an `Rc`", + "scope": "expr" + }, + "Box::pin": { + "postfix": "pinbox", + "body": "Box::pin(${receiver})", + "requires": "std::boxed::Box", + "description": "Put the expression into a pinned `Box`", + "scope": "expr" + }, + "Ok": { + "postfix": "ok", + "body": "Ok(${receiver})", + "description": "Wrap the expression in a `Result::Ok`", + "scope": "expr" + }, + "Err": { + "postfix": "err", + "body": "Err(${receiver})", + "description": "Wrap the expression in a `Result::Err`", + "scope": "expr" + }, + "Some": { + "postfix": "some", + "body": "Some(${receiver})", + "description": "Wrap the expression in an `Option::Some`", + "scope": "expr" + } + }, "type": "object" }, "rust-analyzer.completion.postfix.enable": { |