Creating Source Code Using Live Templates
Live templates are JetBrains Rider's far more intelligent version of Visual Studio's code snippets. Unlike code snippets, JetBrains Rider's templates can predict from the context, which variables, fields, and types can be used. In most cases you do not need to type anything yourself — just choose from a list of suggested values.
JetBrains Rider provides plenty of predefined live templates for all supported languages. The list of predefined templates includes templates for iterating through collections, writing assertion methods, creating new arrays, outputting values, coding LINQ queries, generating auto-properties, and more.
To create a code fragment using live template
In the text editor, set the caret where you want to insert a code fragment from a live template.
- Do one of the following:
Type a template shortcut or its initial letters. E.g., in a C# method, type
itarto invoke the iterate an array template.
- If the template has editable parameters (that is, requires user input), JetBrains Rider deploys a hot spot session in the editor and sets the input position at the first parameter. Then you can do the following:
If JetBrains Rider suggests some values for the current parameter, use Up and Down arrow keys to navigate through the list of suggested values, or just type in a desired value.
Press Tab or Enter to accept the value and move to the input position of the next parameter. If this is the last parameter, the hot spot session completes and the caret moves to the end position defined for the session.
Press Shift+Tab to move the input focus to the input position of the previous parameter.
Press Esc to exit the hot spot session. In this case, all session parameters will be initialized with default values.
Below are several examples that show how live templates are commonly applied.
- Applying a template with a shortcut
- Selecting a template from the suggestion list
- Reducing the suggestion list
- Applying a template with editable parameters
Applying a template with a shortcut
psvm (the shortcut for the public static void Main template) where you want to place the
Press Tab to expand the template:
Selecting a template from the suggestion list
Set the caret in a position where inserting an assertion method is appropriate and press Ctrl+E, L:
After selecting asrt in the suggestion list, press Enter or Tab:
Reducing the suggestion list
Press Ctrl+E, L, and then type
it and select the desired template whose shortcut starts with 'it':
Applying a template with editable parameters
itar (Iterate an array) is the shortcut for a template that contains code for iterating over an array. Type this shortcut where such iteration is appropriate:
When you press Tab (the template invocation key), the template expands replacing
itar with the template code. Note that JetBrains Rider calculates suggested values based on the context and inserts them in the corresponding template parameters:
Keep in mind that
itar has editable parameters so JetBrains Rider deploys a Hot Spot Session in the editor to guide you through them. You can recognize it by the presence of the red border around the index parameter, which is the first input position in this template. JetBrains Rider automatically suggested
i as the name for the index variable. If you want to change the suggested value, just type a new name. All references to the variable within the expanded template will change simultaneously as you type the new name. In the following figure,
i has been changed to
Regardless of whether you have changed the suggestion at the current input position, pressing Tab or Enter moves the caret to the input position of the next editable parameter of the template:
JetBrains Rider has automatically detected all array variables in the scope, and suggested selecting one of them (namely, the last declared one). Had there been only one array element in the scope, JetBrains Rider would have inserted its name automatically (without popping up a list). You can control pop-up suggestion lists using the following keys:
Use Up and Down arrow keys to navigate through the list.
Use Esc to close the list and enter, for example, your own
getArray()method call into this position.
Press Tab or Enter to apply the selected/specified option and move to the input position of the next parameter.
JetBrains Rider detects changes to the type of the array elements. It automatically updates the type of the variable holding the current array element, and suggests a suitable name for it:
After filling up the last input parameter, press Tab or Enter to get the caret moved to the specified end position of the template:
In many cases, default values suggested by JetBrains Rider may be accepted, thus you can immediately proceed to writing the loop body after very few keystrokes.