Edit Template Variables dialog
If a live template contains user-defined variables, you can use the Edit Template Variables dialog to configure expressions that define those variables.
Controls
Item | Description |
---|---|
Name | In this field, view or edit the variable name in the format $<variable_name>$ . |
Expression | In this field, specify the expression to have the value of the corresponding template input field calculated automatically. This expression may contain the following constructs:
Type an expression manually or select a predefined function from the list. The list shows also the number and type of parameters, if any, for the selected function. The available functions are listed alphabetically in the Functions table. |
Default value | In this field, specify the default string to be entered in the corresponding input field of the expanded template, if the expression does not give any result after calculation. Note that a default value of a variable is an expression that can refer to other live template variables. To define the default value as a literal, enclose it in quotation marks. |
Skip if defined | Select this checkbox to have JetBrains Rider proceed with the next input field, if the value of the current input field is defined. |
Move Up / Move Down | Use these buttons to change the order of variables in the list. The order of variables in the table determines the order in which JetBrains Rider will switch between the corresponding input fields when the template is expanded. |
Functions used in live template variables
Function | Description |
---|---|
camelCase(<String>) | Converts a string into camelCase. For example, |
capitalize(<String>) | Capitalizes the first letter of a string. For example, |
capitalizeAndUnderscore(<String>) | Capitalizes all the letters of a string, and inserts an underscore between the parts. For example, |
complete() | Invokes code completion at the position of the variable. |
completeSmart() | Invokes smart type completion at the position of the variable. |
concat(<String>, ...) | Returns a concatenation of all the strings passed to the function as parameters. For example, |
date([format]) | Returns the current system date. By default, without a parameter, it returns the date in the current system format. To use a different format, provide a parameter according to the SimpleDateFormat specification. For example, the |
dbColumns() | Returns a list of columns for a table or a view. The |
dbObjectName() | Returns a name of a table or a view. The |
decapitalize(<String>) | Replaces the first letter of a string with the corresponding lowercase letter. For example, |
defaultReturnValues | Returns the default value if the expression is used in the return statement. Uses the errorVariableName parameter if the expression is of the error type. |
enum(<String>, ...) | Returns a list of strings suggested for completion when the template expands. For example, |
escapeString(<String>) | Escapes special characters so that the result can be used in a Java string. For example, it replaces the tab character with |
expectedType() | Returns the expected type of the expression where the template expands (in the right part of an assignment, after return , as a method parameter, and so on). |
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 press Ctrl+Alt+Shift+C. |
firstWord(<String>) | Returns the first word of the string passed as the parameter. For example, |
lineNumber() | Returns the current line number. |
lowercaseAndDash(<String>) | Converts a string into lower case and inserts n-dashes as separators. For example, lowercaseAndDash("MyExampleName") and lowercaseAndDash("my example name") both return my-example-name . |
regularExpression(<String>, <Pattern>, <Replacement>) | Finds all occurrences of Pattern in a String and replaces them with Replacement . You can specify the pattern as a regular expression to find everything that matches it in the string. |
snakeCase(<String>) | Converts a string into snake_case. For example, snakeCase("fooBar") and snakeCase("foo bar") both return foo_bar . |
spaceSeparated(<String>) | Returns the specified string with spaces as separators. For example, spaceSeparated("fooBar") returns foo Bar and spaceSeparated("Foo_BAR") returns Foo BAR . |
spacesToUnderscores(<String>) | Replaces spaces with underscores in the string passed as the parameter. For example, spacesToUnderscores("foo bar BAZ") returns foo_bar_BAZ . |
substringBefore(<String>, <Delimeter>) | Returns the substring up to the specified delimiter. This is helpful for removing the extensions in test file names. For example, substringBefore(fileName(),".") returns component-test if used in a file named component-test.js. |
time([format]) | Returns the current system time. By default, without a parameter, it returns the time in the current system format. To use a different format, provide a parameter according to the SimpleDateFormat specification. For example, the |
underscoresToCamelCase(<String>) | Transforms a string with underscores (like snake_case) into camelCase. For example, underscoresToCamelCase(foo_bar_baz) and underscoresToCamelCase(FOO_BaR_baZ) both return fooBarBaz . |
underscoresToSpaces(<String>) | Transforms underscores in a string to spaces. For example, underscoresToSpaces(foo_bar_baz) returns foo bar baz and underscoresToSpaces(FOO_BaR_baZ) returns FOO BaR baZ . |
user() | Returns the name of the current user. |