ファイルテンプレート
ファイルテンプレートは、プロジェクトツリーのコンテキストメニューの メニューまたは 新規 セクションを使用して作成する新しいファイルの既定の内容の仕様です。
作成するファイルの種類に応じて、テンプレートは、その種類のすべてのファイルに期待される初期コードとフォーマットを提供します (業界または言語の標準、企業ポリシー、その他の理由に従って)。
WebStorm は、新しいファイルを作成する際に提案される、サポートされているすべてのファイルタイプ向けの定義済みテンプレートを提供します。
ファイルテンプレートの管理と構成
Ctrl+Alt+S を押して設定を開き、 を選択します。
詳細は、 ファイルおよびコードテンプレート を参照してください。
デフォルトでは、テンプレートリストには WebStorm が提供する定義済みテンプレートのみが含まれます。 それらの一部は内部テンプレートであり、削除や名前の変更はできません。 WebStorm は内部テンプレートの名前を太字で表示します。 ユーザーが変更したテンプレートや手動で作成したカスタムテンプレートの名前は青色で表示されます。
次の手順では、ファイルテンプレートを作成する方法について説明します。 インクルードテンプレートの作成にも同様の手順を使用できます。
新しいファイルテンプレートを作成する
Ctrl+Alt+S を押して設定を開き、 を選択します。
スキーム, リストを使用して、ファイルテンプレートが適用されるスコープを選択します。
デフォルト: IDE レベルで作成されたファイルテンプレート。 これらのテンプレートは、現在の IDE インスタンスで開くすべてのプロジェクトで使用できます。 特定のプロジェクトに関係なく、好みの個人用テンプレートとして使用します。 WebStorm は、グローバルテンプレートを IDE 構成ディレクトリ の fileTemplates に保存します。
プロジェクト: 現在のプロジェクトに固有のファイルテンプレート。 これらのテンプレートは、このプロジェクトで作業するすべてのユーザーが利用できます。 WebStorm は、 .idea/fileTemplates のプロジェクトフォルダーに保存します。
ファイル タブで、
をクリックし、テンプレート名、ファイル拡張子、結果のファイルの名前、テンプレートの本体を指定します。変更を適用し、ダイアログを閉じます。
既存のファイルテンプレートをコピーする
Ctrl+Alt+S を押して設定を開き、 を選択します。
ファイル タブで、
をクリックし、必要に応じてテンプレートの名前、ファイル拡張子、本文を変更します。変更を適用し、ダイアログを閉じます。
ファイルをテンプレートとして保存する
エディターでファイルを開きます。
メインメニューで へ移動します。
ファイルをテンプレートとして保存 ダイアログで、新しいテンプレート名と拡張子を指定し、必要に応じて本文を編集します。 ファイルテンプレートで使用される構文の詳細については、「構文 」を参照してください。
ファイル名: 必要に応じて、このテンプレートから作成されるファイルの名前を指定します。 デフォルトでは、WebStorm はファイルを追加する際にユーザーに名前の入力を求めます。 特定の名前をハードコードしてプロンプトを完全に回避したり、使用可能な変数からテンプレートを作成したりできます。 例えば、指定した名前を使い、ファイル作成時に選択したディレクトリの上位のディレクトリに配置する方法は次のとおりです:
../${NAME}スタイルに従って整形: このファイルタイプに定義された コードスタイルに従って、このテンプレートに基づいて生成されたコンテンツを再フォーマットします。
ライブテンプレートを有効化: ライブテンプレートをファイルテンプレート内に挿入します。 Velocity エスケープ構文を使用して、 ライブテンプレート変数をファイルテンプレートに含めます。例えば:
#[[ $MY_VARIABLE$ $END$ ]]#
変更を適用し、ダイアログを閉じます。
構文
ファイルテンプレートは Velocity Template Language （VTL）を使っており、以下の構文要素が含まれます：
プレーンテキストはそのままレンダリングされます。
値に置き換えられる 変数。 例:
${NAME}は、ファイルを追加するときにユーザーが指定した名前を挿入します。#parse、
#set、#ifなどを含むさまざまなディレクティブ。
$ または # の入力を開始して、使用可能な変数およびディレクティブの 補完候補を参照します。
詳細については、 VTL リファレンスガイド(英語)を参照してください。
次の例は、WebStorm で JavaScript クラスを作成するデフォルトテンプレートを示しています：
このテンプレートでは、 ${USER} と ${DATE} はテンプレート変数です。
新しい JavaScript ファイルを作成すると、このテンプレートは次のような内容のファイルを生成します。
次の例は、WebStorm で Gherkin フィーチャーファイルを作成するデフォルトテンプレートを示しています：
このテンプレートでは、 ${USER} と ${DATE} はテンプレート変数です。 新しい Gherkin ファイルを作成すると、このテンプレートは次のような内容のフィーチャファイルを生成します。