Live Template Variables
Template variables in live templates enable user input. After a template is expanded, variables appear in the editor as input fields.
Variables within templates are declared in the following format:
Variables are defined by expressions, and can accept some default values.
This expression may contain constructs of the following basic types:
- String constants in double quotes.
- The name of another variable defined in a live template.
- Predefined functions with possible arguments.
Predefined template variables
WebStorm supports two predefined live template variables
$SELECTION$, both of them are read-only.
$END$indicates the position of the cursor after the template is expanded. For example, the template
return $END$;will be expanded into
return ;with the cursor positioned right before the semicolon.
$SELECTION$is used in surround templates and stands for the code fragment to be wrapped. After the template is expanded, the selected text is wrapped as specified in the template. For example, if you select
EXAMPLEin your code and invoke the
"$SELECTION$"template via the assigned abbreviation or by pressing Ctrl+Alt+T and selecting the desired template from the list, WebStorm will wrap the selection in double quotes as follows:
Predefined functions used in live template variables
| ||Returns the characters that indicate the end of a block comment in the the current language context.|
| ||Returns the characters that indicate the start of a block comment in the the current language context.|
|Converts a string into cameCase. For example, |
|Capitalizes all the letters of a CamelCase name passed as parameter, and inserts an underscore between the parts. For example, |
|Capitalizes the first letter of the parameter.|
|This expression substitutes for the class name completion at the variable position.|
|Returns the contents of the system clipboard.|
| ||Returns the characters that indicate the end of a comment in the current language context. The return value is empty if line comments are defined in the current language.|
| ||Returns the characters that indicate the start of a comment in the current language context. If line comments are defined in the current language, their start indicator is preferable.|
|Invokes code completion at the position of the variable.|
|Invokes smart type completion at the position of the variable.|
| Shows the current system in the specified format. |
By default, the current date is returned in the default system format. However, if you specify date format in double quotes, the date will be presented in this format:
|Replaces the first letter of a name parameter with the corresponding lowercase letter.|
|Shows a list of comma-separated strings suggested for completion at the template invocation.|
|Escapes a string.|
|Returns the expected type of the expression into which the current template expands. Makes sense if the template expands in the right part of an assignment, after |
|Returns the name of a file with its extension.|
|Returns the name of a file without its.|
|Returns the first word of a string.|
|Returns Groovy script with the specified code.|
You can use
|Returns a suggested name for an index.|
|Returns the suggested name for a variable.|
| ||Returns the characters that indicate the start of a line comment in the current language context.|
|Returns the current line number.|
| Converts a capitalized camelCase string into lower case and inserts n-dashes as separators. For example, |
|Converts a string into snake_case, for example, |
| Converts a CamelCase string into lower case and inserts spaces as separators. For example, |
| Removes the extension after the specified delimiter and returns only the file name. This is helpful for test file names, for example, |
|Returns the current system time.|
|Replaces underscores with CamelHump letters. For example, |
|Replaces underscores with spaces.|
|Returns the name of the current user.|