DataGrip 2023.2 Help

File templates

File templates are specifications of the default contents for new files that you create. Depending on the type of file you are creating, templates provide initial code and formatting expected in all files of that type (according to industry or language standards, your corporate policy, or for other reasons).

DataGrip provides predefined templates for all supported file types suggested when you create a new file.

Manage and configure file templates

  • Press Control+Alt+S to open the IDE settings and then select Editor | File and Code Templates.

For more information, refer to File and Code Templates.

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. DataGrip shows the names of internal templates in bold. The names of templates that you modified, as well as custom templates that you created manually, are shown in blue.

The following procedures describe how to create file templates. Similar procedures can be used for creating include templates.

Create a new file template

  1. Press Control+Alt+S to open the IDE settings and then select Editor | File and Code Templates.

  2. Using the Scheme list, select the scope to which the file template apply:

    • Default: configure file templates for the entire application. These templates are available in all projects that you open with the current IDE instance. Use them as your personal templates that you prefer regardless of the specific project. DataGrip stores global templates in the IDE configuration directory under fileTemplates.

    • Project: configure file templates specific for the current project. These templates are available to everyone who works on this project. DataGrip stores them in the project folder under .idea/fileTemplates.

  3. On the Files tab, click the Create Template button and specify the template name, file extension, name of the resulting file, and body of the template.

  4. Click Apply to save the changes and close the dialog.

Copy an existing file template

  1. Press Control+Alt+S to open the IDE settings and then select Editor | File and Code Templates.

  2. On the Files tab, click the Copy Template button and modify the name, file extension, and body of the template as necessary.

  3. Click Apply to save the changes and close the dialog.

Save a file as a template

  1. Open a file in the editor.

  2. Go to File | Save File as Template.

  3. In the Save File as Template dialog, specify the new template name and edit the body, if necessary.

  4. Click Apply to save the changes and close the dialog.

Syntax

File templates use the Velocity Template Language (VTL), which includes the following constructs:

  • Plain text rendered as is.

  • Variables that are replaced by their values. For example, ${NAME} inserts the name provided by the user when adding the file.

  • Various directives, including #parse, #set, #if, and others.

Start typing $ or # to refer to completion suggestions for available variables and directives.

For more information, refer to the VTL reference guide.

The following example shows a template for creating a user-defined function in DataGrip:

CREATE FUNCTION `${FUNCTION_NAME}`(`$arg1`, `$arg2`, `$arg3`) RETURNS BEGIN RETURN END #parse("Copyright.sql")

When you create a new custom SQL file, this template generates a file with contents similar to the following:

CREATE FUNCTION `functionName`(`arg1`, `arg2`, `arg3`) RETURNS BEGIN RETURN END /** * Copyright. Created by User on 10.08.2018 */
Last modified: 07 September 2023
Indexing File template variables