GoLand 2019.3ヘルプ

ライブテンプレート変数

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

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

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

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

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

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

  • 可能な引数を持つ事前定義された関数

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

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

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

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

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

    • 変数名を変更する

    • 定義済みの関数を使用して式を定義する

    • 式の評価に失敗した場合のデフォルト値を指定する

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

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

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

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

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

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

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

関数

説明

blockCommentEnd

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

blockCommentStart

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

camelCase(String)

文字列をcamelCaseに変換します。例: camelCase(my-text-file) , camelCase(my text file)camelCase(my_text_file) はすべて myTextFileを返します。

capitalize(String)

パラメータの最初の文字を大文字にします。

capitalizeAndUnderscore(String)

パラメータとして渡されたCamelCase名のすべての文字を大文字にし、部分の間にアンダースコアを挿入します。例: capitalizeAndUnderscore(FooBar)FOO_BARを返します。

classNameComplete()

この式は、変数名の補完を変数の位置に置き換えます。

clipboard()

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

commentEnd()

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

commentStart()

現在の言語のコンテキストでコメントの始まりを示す文字を返します。行コメントが現在の言語で定義されている場合は、それらの開始標識が望ましいです。

complete()

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

completeSmart()

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

concat(expressions...)

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

date(sDate)

現在のシステム日付を指定された形式で返します。

パラメータを指定しないと、現在の日付がデフォルトのシステムフォーマットで返されます。

date_format

別のフォーマットを使用するには、SimpleDateFormat仕様に従ってパラメータを指定してください。例:関数 date("Y-MM-d, E, H:m") は、2019 - 07 - 5, Fri, 12:56としてフォーマットされた日付を返します。

decapitalize(sName)

パラメータの最初の文字を対応する小文字に置き換えます。

defaultReturnValues

式がreturn文で使用されている場合は、デフォルト値を返します。式がエラー・タイプである場合は、errorVariableName パラメーターを使用します。

enum(sCompletionString1,sCompletionString2,...)

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

errorVariable()

現在のコンテキストの最初のエラー変数を返します。現在のコンテキスト内のすべてのエラー変数を自動補完します。

errorVariableDefinition(expressionWithErrorResult)

式がエラータイプを返す場合は、式を変数定義に変換します。例: a() 関数が (int, error)を返した場合、errorVariableDefinition("a()") 式は _, errを返します。

escapeString(sEscapeString)

パラメータとして指定された文字列をエスケープします。

fieldName()

現在のコンテキストの最初のフィールド名を返します。現在のコンテキスト内のすべてのフィールド名を自動補完します。

fileName()

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

fileNameWithoutExtension()

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

filePath()

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

fileRelativePath()

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

firstWord(sFirstWord)

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

groovyScript("groovy code", arg1)

指定されたコードを持つGroovyスクリプトを返します。

groovyScript() 関数は複数の引数で使用できます。最初の引数は、実行されるスクリプトのテキスト、またはそのスクリプトを含むファイルへのパスです。次の引数は、スクリプト内で使用可能な _1 , _2 , _3、... _n 変数にバインドされています。また、_editor 変数はスクリプト内で利用可能です。この変数は現在のエディターにバインドされています。

JsArrayVariable()

現在のJavaScript配列の名前を返します。

jsClassName()

現在のJavaScriptクラスの名前を返します。

jsComponentTypeOf()

現在のJavaScriptコンポーネントの型を返します。

jsDefineParameter

モジュールの名前に基づいて、define(["module"], function (<parameter_in_question>>) {})からパラメータを返します。

jsMethodName()

現在のJavaScriptメソッドの名前を返します。

jsQualifiedClassName()

現在のJavaScriptクラスの完全な名前を返します。

jsSuggestIndexName()

最も一般的に使用されているもの( i , j , k以降)から、インデックス変数の推奨名を返します。現在のスコープでまだ使用されていない名前が最初に表示されます。

jsSuggestVariableName()

変数の命名規則を参照するコードスタイル設定に従って、変数のタイプと初期化式に基づいて、変数の推奨名を返します。
例:反復内の要素を保持する変数の場合、GoLandは、反復されるコンテナーの名前を考慮して、最も妥当な名前を推測します。

jsSuggestDefaultVariableKind(Boolean)

Booleanパラメータは、現在のコンテキストで定数が許可されるかどうかを決定します。パラメータが指定されていない場合は、定数が許可されます。テンプレートが展開されると、TypeScriptおよびES6の場合は var , let , const オプション、それ以前のバージョンのJavaScriptの場合は var オプションが1つだけのリストが表示されます。

jsSuggestImportedEntityName()

ファイル名に基づいて、タイプ `import * as $ITEM$ from "$MODULE$"` または `import $ITEM$ from "$MODULE$"` のインポートステートメントの名前を提案します。

lineCommentStart

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

lineNumber()

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

lowercaseAndDash(String)

camelCase文字列を小文字に変換し、区切り記号としてnダッシュを挿入します。例: lowercaseAndDash(MyExampleName)my-example-nameを返します。

nonBlankVariable

式のリストを入力として受け取り、空でない最初の式 _を返します。例: _,_,a,baを返します。

regularExpression(String, Pattern, Replacement)

String 内のすべての Pattern を見つけて、それを Replacementに置き換えます。パターンを正規表現として指定して、ストリング内で一致するものすべてを見つけることができます。

snakeCase(String)

文字列をsnake_caseに変換します。例: snakeCase(fooBar)foo_barを返します。

spaceSeparated(String)

文字列を小文字に変換し、区切り文字としてスペースを挿入します。例: spaceSeparated(fooBar)foo barを返します。

substringBefore(String,Delimiter)

指定された区切り文字の後の拡張子を削除し、ファイル名のみを返します。これはテストファイル名に役立ちます(たとえば、substringBefore($FileName$,".")component-test.jscomponent-test を返します)。

time(sSystemTime)

現在のシステム時刻を指定の形式で返します。

パラメータを指定しないと、現在の時刻がデフォルトのシステムフォーマットで返されます。

別のフォーマットを使用するには、SimpleDateFormat仕様に従ってパラメータを指定してください。例:関数 time("H:m z")13:10 UTCとしてフォーマットされたタイムスタンプを返します。

underscoresToCamelCase(String)

パラメータとして渡された文字列内のアンダースコアをキャメルケース文字に置き換えます。例: underscoresToCamelCase(foo_bar)fooBarを返します。

underscoresToSpaces(sParameterWithUnderscores)

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

user()

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

最終更新日: 2020年2月20日