Live templates

Use live templates to insert common constructs into your code, such as loops, conditions, declarations, or print statements.

To expand a code snippet, type the corresponding template abbreviation and press Tab. Keep pressing Tab to jump from one variable in the template to the next one. Press Shift+Tab to move to the previous variable.

Insert a live template

Place the caret at the place where you want the template to expand.
Type the template abbreviation and press the invocation key (usually Tab by default). Alternatively, on the Code menu, click Insert Live Template Ctrl+J to open the suggestion list and select the necessary template.
If the selected template requires user input, the corresponding field is highlighted. Type the necessary value and press Enter or Tab to complete input and move to the next input field. After completing all input fields, the caret moves to the end of the construct (or to the $END$ marker if the marker is defined in the template code), and the editor returns to the regular mode of operation.

Surround a block of code with a live template

Select a piece of code to be surrounded.
On the Code menu, click Surround With Ctrl+Alt+J to open the suggestion list and select the necessary template.

Consider the following example of the Hello World program that is coded with Live Templates.

Types of live templates

The following types of live templates are distinguished:

Simple templates contain only fixed plain text. When you expand a simple template, the text is automatically inserted into your source code, replacing the abbreviation.

Abbreviation	Expands to
`imp`	import ( )
`int`	func init() { }
`main`	func main() { }

Parameterized templates contain variables that enable user input. When you expand a parameterized template, variables are either replaced by input fields for the user to specify manually, or calculated by GoLand automatically.

Abbreviation	Expands to
`forr`	for key, value := range collection { }
`test`	func Test$NAME$(t *testing.T) { $END$ }

Surround templates wrap a block of the selected code with the text specified by the user.

Postfix code completion is similar to live templates. It transforms the current expression without selecting it. For example, you can type .if after an expression to invoke the corresponding postfix completion and wrap the expression with an if statement.

Configure live templates

To configure live templates, open the Editor | Live Templates page of settings Ctrl+Alt+S. On the Live Templates page, you can see all the available live templates, edit them and create new templates.

Templates are grouped according to the context where they can be used (usually, by the corresponding language). To move a template to another group, right-click the template, select Move, and then select the necessary group name.

Each live template is defined by an abbreviation containing alphanumeric characters, dots, and hyphens. The abbreviation must be unique within a group, but the same abbreviation may be used in different groups and expand to different constructs according to the context of the corresponding group . Abbreviations of modified default templates are shown in the list with blue font.

Restore a modified template to the default settings

On the Live Templates page of the Settings dialog, right-click the template which you want to restore and click Restore defaults.

Last modified: 22 October 2024