Live template variables
When you expand a live template abbreviation, its variables either appear as input fields where you can type values or are replaced with values. These may be default values that you can modify or values calculated using functions.
To declare variables within templates, use the following format: $<variable_name>$
.
Define each variable using an expression and provide a default value for cases when the expression fails to evaluate.
This expression may contain the following constructs:
String constants in double quotes
Names of other variables defined in a live template
Predefined functions with possible arguments
Configure template variables
Select a template where you want to configure variables.
Specify variables in the template text and click Edit variables.
-
In the Edit Template Variables dialog, you can do the following for each variable:
Change the variable name
Define the expression using predefined functions
Specify the default value for cases when the expression fails to evaluate
Specify whether you want to skip the variable when prompting the user for input if the expression evaluated successfully
Predefined template variables
WebStorm supports the following predefined live template variables that cannot be modified:
$END$
indicates the position of the cursor when the code snippet is complete, and you can no longer press Tab to jump to the next variable.$SELECTION$
is used in surround templates and denotes the code fragment to be wrapped. After the template expands, it wraps the selected text as specified in the template. For example, if you selectEXAMPLE
in 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:"EXAMPLE"
.
Predefined functions used in live template variables
The following functions can be used to define live template variables:
Function | Description |
---|---|
blockCommentEnd | Returns the characters that indicate the end of a block comment in the current language context. |
blockCommentStart | Returns the characters that indicate the start of a block comment in the current language context. |
camelCase(String) | Converts a string into camelCase. For example, |
capitalize(String) | Capitalizes the first letter of the parameter. |
capitalizeAndUnderscore(String) | Capitalizes all the letters of a CamelCase name passed as the parameter, and inserts an underscore between the parts. For example, |
classNameComplete() | This expression substitutes for the class name completion at the variable position. |
clipboard() | Returns the contents of the system clipboard. |
commentEnd() | 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. |
commentStart() | 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. |
complete() | Invokes code completion at the position of the variable. |
completeSmart() | Invokes smart type completion at the position of the variable. |
concat(expressions...) | Returns a concatenation of all the strings passed to the function as parameters. |
dartIterableVariable() | Returns the name of a variable that can be iterated. |
dartListVariable() | Returns a list of elements of an array. |
dartSuggestIndexName() | Returns a suggested name for an index variable from most commonly used ones: |
dartSuggestVariableName() | Returns the suggested name for a variable based on its variable type and initializer expression, according to your code style settings that refer to the variable naming rules. |
date(sDate) | Returns the current system date in the specified format. Without a parameter, the current date is returned in the default system format. To use a different format, provide a parameter according to the SimpleDateFormat specification. For example, the function |
decapitalize(sName) | Replaces the first letter of the parameter with the corresponding lowercase letter. |
defaultReturnValues | Returns the default value if the expression is used in the return statement. Uses the |
enum(sCompletionString1,sCompletionString2,...) | Returns a list of comma-separated strings suggested for completion when the template is expanded. |
escapeString(sEscapeString) | Escapes the string specified as the parameter. |
expectedType() | Returns the expected type of the expression into which the template expands. Makes sense if the template expands in the right part of an assignment, after |
fileName() | Returns the name of the current file with its extension. |
fileNameWithoutExtension() | Returns the name of the current file without its extension. |
filePath() | Returns the absolute path to the current file. |
fileRelativePath() | Returns the current file path relative to the current project. To check what the relative path is for a given file, right-click it and select Copy Reference, or pressCtrl+Shift+Alt+C. |
firstWord(sFirstWord) | Returns the first word of the string passed as the parameter. |
groovyScript("groovy code", arg1) | Returns a Groovy script with the specified code. You can use the |
JsArrayVariable() | Returns the name of the current JavaScript array. |
jsClassName() | Returns the name of the current JavaScript class. |
jsComponentTypeOf() | Returns the type of the current JavaScript component. |
jsDefineParameter | Based on the name of the module, returns the parameter from |
jsMethodName() | Returns the name of the current JavaScript method. |
jsQualifiedClassName() | Returns the complete name of the current JavaScript class. |
jsSuggestIndexName() | Returns a suggested name for an index variable from most commonly used ones: |
jsSuggestVariableName() | Returns the suggested name for a variable based on its variable type and initializer expression, according to your code style settings that refer to the variable naming rules. |
jsSuggestDefaultVariableKind(Boolean) | The Boolean parameter determines whether constants are allowed or not in the current context. If no parameter is specified, constants are allowed. When the templates expands, a list is shown with |
jsSuggestImportedEntityName() | Suggests the name for import statements of the type |
lineCommentStart | Returns the characters that indicate the start of a line comment in the current language context. |
lineNumber() | Returns the current line number. |
lowercaseAndDash(String) | Converts a camelCase string into lower case and inserts n-dashes as separators. For example, |
regularExpression(String, Pattern, Replacement) | Find all occurrences of |
snakeCase(String) | Converts a string into snake_case. For example, |
spaceSeparated(String) | Converts a string into lowercase and inserts spaces as separators. For example, |
spacesToUnderscores(sParameterWithSpaces) | Replaces spaces with underscores in the string passed as the parameter. For example, |
substringBefore(String,Delimiter) | Removes the extension after the specified delimiter and returns only the filename. This is helpful for test file names (for example, |
time(sSystemTime) | Returns the current system time in the specified format. Without a parameter, the current time is returned in the default system format. To use a different format, provide a parameter according to the SimpleDateFormat specification. For example, the function |
underscoresToCamelCase(String) | Replaces underscores with camelCase letters in the string passed as the parameter. For example, |
underscoresToSpaces(sParameterWithUnderscores) | Replaces underscores with spaces in the string passed as the parameter. For example, |
user() | Returns the name of the current user. |