mirror of
https://github.com/rust-lang/rust-analyzer
synced 2025-01-12 21:28:51 +00:00
Add a few default snippets for VSCode
This commit is contained in:
parent
f79f3db7b7
commit
9fe0f0d1d9
5 changed files with 175 additions and 9 deletions
|
@ -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);
|
||||
|
|
|
@ -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 {
|
||||
|
|
|
@ -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.
|
||||
|
|
|
@ -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.
|
||||
|
|
|
@ -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": {
|
||||
|
|
Loading…
Reference in a new issue