ファイルテンプレート変数

ファイルテンプレートには変数を含めることができ、テンプレートの適用時にそれぞれの値へ置き換えられます。変数は、ドル記号 $ で始まり、その後に変数名が続く文字列です。変数名はオプションで波括弧で囲むことができます。例えば、 $MyVariable と ${MyVariable} は同じ変数の異なる表記法です。

事前定義された変数とカスタム変数は、テンプレート本体とファイル名で使用できます。例: テンプレートのファイル名フィールドに MyFile_${MONTH_NAME_FULL} と入力した場合、4 月に作成すると、結果のファイルの名前は MyFile_April になります。ここで、 ${MONTH_NAME_FULL} は事前定義された変数です。代わりにカスタム変数を使用する場合、WebStorm はこのテンプレートでファイルを作成する際に変数の値を入力するよう求めます。

定義済みのテンプレート変数

次の事前定義された変数をファイルテンプレートで使用できます：

変数	説明
`${DATE}`	現在のシステム日付
`${DAY}`	現在の月の日
`${DIR_PATH}`	新しいファイルのディレクトリへのパス (プロジェクトルートを基準に)
`${DS}`	ドル記号 `$`。この変数はドル記号をエスケープし、テンプレート変数の接頭辞とみなされないようにします。
`${HOUR}`	現在の時間
`${MINUTE}`	現在の分
`${SECOND}`	現在の秒
`${MONTH}`	現在の月
`${MONTH_NAME_FULL}`	現在の月のフルネーム（January、February など）
`${MONTH_NAME_SHORT}`	現在の月名の最初の三文字（Jan、Feb など）
`${NAME}`	新しいエンティティの名前 (ファイル、クラス、インターフェースなど)
`${PRODUCT_NAME}`	IDE の名前（たとえば、WebStorm）
`${PROJECT_NAME}`	現在のプロジェクトの名前
`${TIME}`	現在のシステム時刻
`${USER}`	現在のユーザーのログイン名
`${YEAR}`	現在の年

変数メソッド

WebStorm はファイルテンプレートのテンプレートエンジンとして Velocityを使用するため、ファイルテンプレート内の変数は Java の文字列メソッドを使用できます。例: 次のことが可能です。

${NAME.toUpperCase()}: 新しいエンティティ (ファイル) の名前を大文字に変換します。
${PROJECT_NAME.length()}: プロジェクト名の長さを出力します。
${PRODUCT_NAME.substring(0,5)}: 使用している IDE の名前の最初の 5 文字を出力します。

カスタムテンプレート変数

事前定義されたテンプレート変数に加えて、カスタム変数を指定することができます。必要に応じて、 #set ディレクティブを使用して、テンプレート内でカスタム変数の値を定義できます。対応する変数が使用される前にディレクティブを記述します。

例: 事前定義された変数 ${USER} で定義されたログイン名の代わりにフルネームを使用する場合は、カスタム変数の前に次の構成を追加します。

            #set( $MyName = "John Smith" )
            Created by: $MyName

クラスを作成するためのテンプレートでは、値なしでカスタム変数を残すことができます。 WebStorm はテンプレート適用時にこれらの値を指定するよう求めます。

次の例は、TypeScript クラスを作成するためのカスタムテンプレートを示しています。テンプレートには、 ${MyName} と ${class_name} の 2 つのカスタム変数があります。

このテンプレートでクラスを作成すると、WebStorm は ${MyName} および ${class_name} の値を指定するよう求めるダイアログを表示します。

Create a TypeScript class via a custom template: specify the values for custom variables

2026 年 6 月 8 日