DataGrip 2026.1 Help

ライブテンプレート変数

ライブテンプレートの省略形を展開すると、その変数は値を入力できる入力フィールドとして表示されるか、値に置き換えられます。 これらは、変更可能なデフォルト値、または 関数を使用して計算された値である場合があります。

テンプレート内で変数を宣言するには、次の形式を使用します: $VAR$

式では、ドル文字 $ を開閉せずに変数名を使用します(例: lowercaseAndDash(ComponentName))。

式を使用して各変数を定義し、式の評価に失敗した場合はデフォルト値を指定します。

この式には、次の構成要素が含まれる場合があります:

  • 二重引用符で囲まれた文字列定数

  • ライブテンプレートで定義されている他の変数の名前

  • 可能な引数を持つ 定義済み関数

テンプレート変数を設定する

  1. 設定 ダイアログ(Ctrl+Alt+S )で、 エディター | ライブテンプレート に移動します。

  2. 変数を設定するテンプレートを選択します。

  3. テンプレートテキストで変数を指定し、 変数の編集… をクリックします。

  4. テンプレート変数の編集 ダイアログでは、各変数に対して以下の操作を実行できます。

    • 変数名を変更します。

    • 定義済み関数を使用して式を定義します。

    • 式の評価が失敗した場合のデフォルト値を指定します。 デフォルト値は二重引用符で囲む必要があります。

    • 式が正常に評価された場合にユーザーに入力を求めるときに変数をスキップするかどうかを指定します。

    ライブテンプレート変数

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

DataGrip は、変更できない次の定義済みライブテンプレート変数をサポートしています:

  • $END$ はコードスニペットが完了したときのキャレットの位置を示し、 Tab を押して次の変数にジャンプすることはできなくなります。

  • $SELECTION$ は囲みテンプレートで使用され、ラップされるコードフラグメントを示します。 テンプレートが展開されると、テンプレートで指定されたとおりに選択されたテキストがラップされます。 例: コードで を選択し、割り当てられた略語で "$SELECTION$" テンプレートを呼び出すか、 Ctrl+Alt+T を押してリストから目的のテンプレートを選択すると、DataGrip は選択を二重引用符で次のようにラップします: "例"

ライブテンプレート変数で使用される関数

ライブテンプレート変数を定義するには、次の関数を使用できます:

関数

説明

blockCommentEnd()

現在の言語コンテキストでブロックコメントの終わりを示す文字を返します。

blockCommentStart()

現在の言語コンテキストでブロックコメントの開始を示す文字を返します。

camelCase(<String>)

文字列を キャメルケースに変換します。

例: camelCase("my-text-file")camelCase("my text file")camelCase("my_text_file") はすべて myTextFile を返します。

capitalize(<String>)

文字列の最初の文字を大文字にします。

例: capitalize("name")名前 を返します。 または、 capitalize(camelCase("my awesome class")) と組み合わせて MyAwesomeClass を取得することもできます。

capitalizeAndUnderscore(<String>)

文字列のすべての文字を大文字にし、各部分の間にアンダースコアを挿入します。

例: capitalizeAndUnderscore("FooBar")capitalizeAndUnderscore("foo bar")capitalizeAndUnderscore("foo-bar") はすべて FOO_BAR を返します。

clipboard()

システムクリップボードの内容を返します。

commentEnd()

現在の言語コンテキストでコメントの終わりを示す文字を返します。 行コメントのある言語の場合、戻り値は空です。

commentStart()

現在の言語コンテキストでコメントの開始を示す文字を返します。 行コメントのある言語の場合、戻り値は lineCommentStart() と同じように行コメントの始まりです。

complete()

変数の位置で コード補完を呼び出します。

completeSmart()

変数の位置で スマート型補完を呼び出します。

concat(<String>, ...)

パラメーターとして関数に渡されたすべての文字列を連結して返します。

例: concat(date()," ",user()) は、スペースで区切られた現在のシステム日付とユーザー名を返します。

date([format])

現在のシステム日付を返します。

デフォルトでは、パラメーターなしで、現在のシステム形式で日付を返します。 別の形式を使用するには、 SimpleDateFormat(英語) 仕様に従ってパラメーターを指定します。 例: date("Y-MM-d, E, H:m") は、 2020-02-27, Thu, 16:11 としてフォーマットされた日付を返します。

dbColumns()

テーブルまたはビューの列のリストを返します。 dbColumns() はコンテキストライブテンプレート (たとえば、 ins) で使用されます。 オブジェクトを右クリックして SQL スクリプト を選択すると、コンテキストライブテンプレートにアクセスできます。 コンテキストライブテンプレートの詳細については、「コンテキストライブテンプレート 」を参照してください。

dbObjectName()

テーブルまたはビューの名前を返します。 dbObjectName() はコンテキストライブテンプレート (たとえば、 最上位) で使用されます。 オブジェクトを右クリックして SQL スクリプト を選択すると、コンテキストライブテンプレートにアクセスできます。 コンテキストライブテンプレートの詳細については、「コンテキストライブテンプレート 」を参照してください。

decapitalize(<String>)

文字列の最初の文字を対応する小文字に置き換えます。

例: decapitalize("Name")名前 を返します。

enum(<String>, ...)

テンプレートが展開されたときに補完として提案される文字列のリストを返します。

例: enum("Foo","Bar","Baz") は、指定された文字列の 1 つを選択できるリストを表示します。

escapeString(<String>)

結果を Java 文字列で使えるように、特殊文字をエスケープします。

例: タブ文字を \t で置き換え、改行文字を \n で置き換え、バックスラッシュを \\ としてエスケープし、引用符を \" としてエスケープします。

fileName()

現在のファイルの名前とその拡張子を返します。

fileNameWithoutExtension()

現在のファイルの名前を拡張子なしで返します。

filePath()

現在のファイルへの絶対パスを返します。

fileRelativePath()

現在のプロジェクトに相対的な現在のファイルパスを返します。 特定のファイルの相対パスを確認するには、ファイルを右クリックして 参照をコピー を選択するか、 Ctrl+Alt+Shift+C を押します。

firstWord(<String>)

パラメーターとして渡された文字列の最初の単語を返します。

例: firstWord("one two three")一つ を返します。

groovyScript(<String>, [arg, ...])

文字列として渡された Groovy スクリプトを実行します。

最初の引数は、スクリプトのテキストまたはスクリプトを含むファイルへのパスを含む文字列です。 この関数は、他のオプションの引数を _1_2_3、...、 _n 変数の値としてスクリプトに渡します。 また、 _editor 変数を使用して、スクリプト内から現在のエディターにアクセスできます。

次の例は、指定された文字列 (別の変数 $MyVar$ の値) を大文字に変換する groovyScript() 関数を示しています。

groovyScript("_1.toUpperCase()", MyVar)

次の例は、選択したテキストを単語に分割し、番号付きリストとして表示する groovyScript() 関数を示しています。

groovyScript("def result = ''; _1.split().eachWithIndex { item, index -> result = result + index.next() + '. ' + item + System.lineSeparator() }; return result;", SELECTION)

最後の例では、テキストを選択して Ctrl+Alt+T (囲む) を押して適用する必要があることを意味する 選択 定義済み変数を使用しています。

lineCommentStart()

現在の言語コンテキストでの行コメントの開始を示す文字を返します。

行番号

現在の行番号を返します。

lowercaseAndDash(<String>)

文字列を小文字に変換し、セパレータとして n ダッシュを挿入します。 例: lowercaseAndDash("MyExampleName")lowercaseAndDash("my example name") はどちらも my-example-name を返します。

regularExpression(<String>, <Pattern>, <Replacement>)

文字列 内のすべての パターン を検索し、 置換 に置き換えます。 パターンを正規表現として指定して、文字列内で一致するすべてのものを検索できます。

例えば、 regularExpression(NAME, "a", "b") 式は、 $NAME$ テンプレート変数内の任意の文字「a」を「b」に置き換えます。 パターン部分では正規表現の文字クラスを使用できます。例えば、 regularExpression(NAME, "[a-z]", "b") は変数内の任意の文字を置き換えます。 もし \d\w のようなパターンを正規表現の文字クラスとして扱いたい場合は、スラッシュをエスケープしてパターンを "\\d" のようにする必要があります。

showParameterInfo()

関数またはステートメントにパラメーターを追加するときに、パラメーターの詳細を返します。

snakeCase(<String>)

文字列を snake_case に変換します。 例えば、 snakeCase("fooBar")snakeCase("foo bar") はどちらも foo_bar を返します。

spaceSeparated(<String>)

区切り文字としてスペースを含む指定された文字列を返します。 例: spaceSeparated("fooBar")foo Bar を返し、 spaceSeparated("Foo_BAR")Foo BAR を返します。

spacesToUnderscores(<String>)

パラメーターとして渡された文字列内のスペースをアンダースコアに置き換えます。 例: spacesToUnderscores("foo bar BAZ")foo_bar_BAZ を返します。

substringBefore(<String>, <Delimeter>)

指定された区切り文字までの部分文字列を返します。 これは、テストファイル名の拡張子を削除できます。 例: component-test.js という名前のファイルで使用されている場合、 substringBefore(fileName(),".")component-test を返します。

time([format])

現在のシステム時刻を返します。

デフォルトでは、パラメーターなしで、現在のシステム形式で時刻を返します。 別の形式を使用するには、 SimpleDateFormat(英語) 仕様に従ってパラメーターを指定します。 例: time("H:m z") は、 13:10 UTC としてフォーマットされた時刻を返します。

underscoresToCamelCase(<String>)

下線付きの文字列(snake_case など )を camelCase に変換します。 例: underscoresToCamelCase(foo_bar_baz)underscoresToCamelCase(FOO_BaR_baZ) はどちらも fooBarBaz を返します。

underscoresToSpaces(<String>)

文字列のアンダースコアをスペースに変換します。 例: underscoresToSpaces(foo_bar_baz)foo bar baz を返し、 underscoresToSpaces(FOO_BaR_baZ)FOO BaR baZ を返します。

user()

現在のユーザーの名前を返します。

サンプル

変数と関数を含む単純なライブテンプレートの作成と使用の例については、 変数と関数を含むライブテンプレートを作成する チュートリアルを参照してください。

2026 年 5 月 22 日