WebStorm 2022.1 Help

File template variables

A file template can contain variables, which are replaced by their values when the template is applied. A variable is a string that starts with a dollar sign $ followed by the variable name. The variable name may optionally be enclosed in curly braces. For example: $MyVariable and ${MyVariable} are different notations of the same variable.

Predefined template variables

The following predefined variables can be used in file templates:

Variable

Description

${DATE}

Current system date

${DAY}

Current day of the month

${DIR_PATH}

Path to the directory of the new file (relative to the project root)

${DS}

Dollar sign $. This variable is used to escape the dollar character, so that it is not treated as a prefix of a template variable.

${HOUR}

Current hour

${MINUTE}

Current minute

${SECOND}

Current second

${MONTH}

Current month

${MONTH_NAME_FULL}

Full name of the current month (January, February, and so on)

${MONTH_NAME_SHORT}

First three letters of the current month name (Jan, Feb, and so on)

${NAME}

Name of the new entity (file, %class%, interface, and so on)

${PRODUCT_NAME}

Name of the IDE (for example, WebStorm)

${PROJECT_NAME}

Name of the current project

${TIME}

Current system time

${USER}

Login name of the current user

${YEAR}

Current year

Custom template variables

Besides predefined template variables, it is possible to specify custom variables. If necessary, you can define the values of custom variables right in the template using the #set directive. Write the directive before the corresponding variable is used.

For example, if you want to use your full name instead of your login name defined through the predefined variable ${USER}, add the following construct before your custom variable:

#set( $MyName = "John Smith" )
Custom file template variable

In templates for creating classes, you can leave custom variables without values. WebStorm will ask you to specify these values when the template is applied.

The example below shows a custom template for creating a TypeScript class. The template has two custom variables: ${MyName} and ${class_name}.

A custom template for creating a TypeScript class

When you create a class via this template, WebStorm shows a dialog where you are asked to specify the values for ${MyName} and ${class_name}.

Create a TypeScript class via a custom template: specify the values for custom variables
Last modified: 11 April 2022