I have the following user snippet:
{
/*
// Place your snippets for JavaScript React here. Each snippet is defined under a snippet name and has a prefix, body and
// description. The prefix is what is used to trigger the snippet and the body will be expanded and inserted. Possible variables are:
// $1, $2 for tab stops, $0 for the final cursor position, and ${1:label}, ${2:another} for placeholders. Placeholders with the
// same ids are connected.
// Example:
"Print to console": {
"prefix": "log",
"body": [
"console.log('$1');",
"$2"
],
"description": "Log output to console"
}
*/
"Small comment": {
"prefix": "//=",
"body": [
"// ===================================",
"// ${1:COMMENT}",
"// ==================================="
],
"description": "Small comment"
}
}
I get the following error on the second body line:
Invalid characters in string. Control characters must be escaped.
I thought that ${1:somestring} was a valid placeholder. What am I doing wrong in constructing this snippet?
I just found this question when looking for an answer, I used snippet generator so assumed the format for each would be the same but without thinking I pasted in code that had tabs in it.
Removing the tabs and used spaces instead for the formatting fixed it for me.
Hope this helps. :)
Related
I'm using a VScode extension called "Surround"
In the docs for this extension it shows how to define a custom snippet. What I want is really simple. I would like to add the ability to surround selected text with tags, ie <> </> while placing the cursors in the middle where I define what type of tag that is (html, img, button, etc)
The docs show this example:
{
"surround.custom": {
// command name must be unique
"yourCommandName": {
// label must be unique
"label": "Your Snippet Label",
"description": "Your Snippet Description",
"snippet": "burrito { $TM_SELECTED_TEXT }$0", // <-- snippet goes here.
"languageIds": ["html", "javascript", "typescript", "markdown"]
},
// You can add more ...
}
}
I can almost parse it, except I don't know what the placeholders are representing. I assume { $TM_SELECTED_TEXT } is the text I've selected but what is the trailing $0 used for? Also, how can I place 2 cursors in between the opening and closing tags?
Thanks in advance.
If I'm already in a snippet and I press tab, I'll proceed to the next placeholder. However, if I'm already in a placeholder and I've typed a prefix that should trigger another snippet, if I press tab, I proceed to the next placeholder instead of expanding the prefix I just typed. Is there a way to expand the prefix I just typed within a snippet?
Here's an example:
"test": {
"prefix": "t",
"body": "|${1}|${2}",
},
"text": {
"prefix": "a",
"body": "asdfghjkl",
}
If I type t I'll get to: ||
If I type a in the first placeholder and press tab I'll get: |a| where my cursor is at the ${2} placeholder
I would like to get: |asdfghjkl| instead
The main problem is that after you type a you have |a| and vscode will not recognize that a as a snippet prefix. It looks like |a to vscode. So if you actually made your second prefix to be | that would be recognized as the prefix, like:
"text": {
"prefix": "|a",
"body": "asdfghjkl",
}
You still have to Ctrl+Space to show suggestions and Enter to accept the suggestion. A Tab there would just go to the next tabstop
Alternatively, if you could insert a space like
"test4": {
"prefix": "t",
"body": "| ${1}|${2}", // space added here
},
then you wouldn't have to modify the second snippet.
Also, make sure that you have
Editor > Suggest: Snippets Prevent Quick Suggestions
disabled (enabled is the default) so you can trigger the suggestions within the first snippet - but you have to manually trigger them yourself with Ctrl+Space as mentioned above.
After changeing an user snippet I,d like to use it.
Is there any other way to update the snippets besides restarting VSCode?
Simply save the snippet file.
If still doesn't works, do Ctrl +Shift + P, type reload window and press enter.
I had this problem when I put my snippet in the wrong Snippet file. For example, I wanted to write a new snippet for creating a React Funcition Component like so:
{
// Place your snippets for typescriptreact here. Each snippet is defined under a snippet name and has a prefix, body and
// description. The prefix is what is used to trigger the snippet and the body will be expanded and inserted. Possible variables are:
// $1, $2 for tab stops, $0 for the final cursor position, and ${1:label}, ${2:another} for placeholders. Placeholders with the
// same ids are connected.
// Example:
// "Print to console": {
// "prefix": "log",
// "body": [
// "console.log('$1');",
// "$2"
// ],
// "description": "Log output to console"
// }
"React Function Component": {
"prefix": "reactfc",
"body": [
"export type ${2:Props} = {",
"};",
"",
"export const ${1:Component}: React.FC<${2:Props}> = props => {",
" return (",
" <>$0</>",
" );",
"};"
],
"description": "Create a new React Function Component with types"
}
}
But I accidentally put it in the typescript.json snippets file instead of the typescriptreact.json snippets file. Moving it into the right snippets file made it be picked up correctly. That could be the problem here.
At any rate, I'm writing this answer here because this is the search that came up when trying to find a solution to this problem.
I'm currently facing an issue where my snippet is not correctly rendered when used.
Snippet
"Import": {
"prefix": "import",
"body": ["import ${1: { ${2:module} } } from \"${0:library}\";"],
"description": "Import module (es6)"
},
The problem
This is the first tab, as you can see it does not select the } for some reason. The other tabs are working fine. I've tried a couple of possibilities but they are not resolving the issue.
You need to escape the second '}' with '\'. The following works.
"body": ["import ${1:{ ${2:module} \\}} from \"${0:library}\";"],
I want to create an snippet when triggered it will surround the given text. Currently my snippet is:
{
"Function Creator Helper": {
"prefix": "_w",
"body": [
"public function $TM_SELECTED_TEXT () {",
" $1",
"}",
],
"description": "Creates a function given the text selection"
}
}
This results on:
What I do is:
Select the text.
Write the prefix (_w)
Press Tab
This results on:
public function () {
}
But I was expecting
public function person () {
}
Any ideas on how can I make this snippet or how can I triggered it correctly?
See https://stackoverflow.com/a/48676522/836330 Your example will work, as of vscode v1.49, as you have it. Vscode snippets have been updated to "remember" your selected text even though you seemingly overwrite it with your snippet prefix.
Older answer:
You can use $TM_SELECTED_TEXT if you trigger it with a hotkey:
{
"key": "cmd+k 1",
"command": "editor.action.insertSnippet",
"when": "editorTextFocus",
"args": {
// "langId": "csharp",
"name": "Function Creator Helper"
}
}
The currently selected text is exposed as ${TM_SELECTED_TEXT}, not $TM_SELECTED_TEXT.
edit: As commented below, this is not the case for this particular use-case
I was just struggling with this myself. In order to get this to work, the only thing you have to do is press F1, run the Insert Snippet command and then select your snippet from the list.
${TM_SELECTED_TEXT} does not work for me either.
${selectedText} has been added as a Snippet Editor Variable:
https://github.com/Microsoft/vscode/pull/39483#issuecomment-383552677
Example:
"JS Block Quote": {
"prefix": "c2",
"body": [
"/* ${selectedText} */",
],
"description": "JS Block Quote"
}
At this time it is not correctly documented:
https://code.visualstudio.com/docs/editor/userdefinedsnippets#_variables
NOTE: In a multi-line selection, ${selectedText} is truncated to the first line. An alternative is to use the the clipboard and the ${CLIPBOARD} variable.
An extra step :(
from Mitches example:
"JS Block Quote": {
"prefix": "c2",
"body": [
"/* $TM_SELECTED_TEXT */",
],
"description": "JS Block Quote" }
from the article: https://code.visualstudio.com/docs/editor/userdefinedsnippets#_variables
the docs must have been ahead of the release.
This works fine in vscode v1.30.2
If somebody wants to know, it works like that for me :
I created two same snippet which only matches when I'm in html or php file (just create two snippets files in your snippets folder "php.json" and "html.json" it works for any languages) and added this code inside :
"unicommentary": {
"prefix": "unicommentary",
"body": "<?php /* ${TM_SELECTED_TEXT} */ ?> ${0}",
"description": "Creates a universal comment to disable both html and php."
}
The ${TM_SELECTED_TEXT} tag works when you select some text and trigger your snippet by the Insert Snippet command, you can't just write on selected text.
When you want to use this, select the text you want in your snippet, press Ctrl + Shift + P and select Insert snippet then, type the name of your snippet, press enter and there you go !