File and code templates
File templates are specifications of the default contents to be generated when creating a new file. Depending on the type of file you are creating, templates provide initial code and formatting that is expected to be in all files of that type (according to industry standards, your corporate policy, or for other reasons).
DataGrip provides predefined templates for all supported file types, which are suggested when you are creating a new file (Ctrl+Alt+Insert).
The Default scope controls templates that pertain to the entire workspace. They are stored in the IDE configuration directory under fileTemplates.
The Project scope controls templates on a per-project basis. They are stored in the project folder under .idea/fileTemplates. These templates can be shared among team members.
By default, the list of templates contains only predefined templates provided by DataGrip. Some of them are internal, which means they cannot be deleted or renamed. The names of internal templates are shown in bold. The names of templates that you modified, as well as custom templates that you created manually, are shown in blue.
DataGrip uses several types of templates, separated into the following tabs:
The Files tab contains file templates that can be used for creating new files.
The Includes tab contains templates of reusable content that can be inserted into file templates (for example, headers).
The Code tab contains internal templates for code fragments (snippets) used by DataGrip for generating various constructs. You can edit the available snippets on this tab, but you cannot create new ones.
To create custom code snippets, use Live templates.
The Other tab contains templates used by various application servers and frameworks. You can edit existing built-in templates on this tab, but not create new ones.
The following procedures describe how to create file templates. Similar procedures can be used for creating include templates.
To create a new file template
To copy an existing file template
To save a file as a template
Open a file in the editor.
Choose Tools | Save File as Template from the menu.
In the Save File as Template dialog that opens, specify the new template name and edit the body, if necessary.
Apply the changes and close the dialog.
File and code templates are written in the Velocity Template Language (VTL), which enables using the following constructs:
Fixed text (markup, code, comments, and so on), which is rendered as-is.
Variables, which are replaced by their values.
Various directives, including #parse,
#if, and others.
Fore more information, see the VTL reference guide.
The following example shows a template for creating a user-defined function in DataGrip:
When you create a new custom SQL file, this template generates a file with contents similar to the following: