YAML
WebStorm を使用すると、YAML ファイル( .yml 、 .yaml )を扱え、以下の機能がサポートされます:
構文ハイライト
カラー設定は、 設定 ダイアログ (Ctrl+Alt+S) の エディター | カラースキーム | YAML ページで変更できます。
YAML に関連するコードスタイル設定には、 設定 ダイアログ (Ctrl+Alt+S) の エディター | コードスタイル | YAML ページでアクセスできます。
WebStorm は、重複したキーや、YAML ドキュメント内で未使用の アンカーなどを検出します。
例えば、 JSON スキーマを持つ YAML ドキュメントでコード補完を利用したり、アンカーエイリアスを補完することができます。
例えば、 アンカーとエイリアス間を移動できます。
名前変更リファクタリング (例えば アンカーとエイリアスの場合)
WebStorm は入力時に、インデント、シーケンスマーカー、角括弧、引用符を維持します。
エディターで使用できる YAML 固有の機能をいくつか見てみましょう。
アンカーとエイリアス
WebStorm はアンカーとエイリアスの操作をサポートします。 YAML ファイルで新しいアンカーを指定すると、エディターはこのアンカーがどのノードでも使用されていないという警告を表示します。

エディターを使用すると、このアンカーのエイリアスを 完成させることができます。

アンカーの使用箇所をすばやく見つけるには、アンカー上にキャレットを置き、 Ctrl+B を押します。

WebStorm はアンカーやエイリアスに対する 名前変更リファクタリングもサポートしています。キャレットをアンカーの上に置き、 Shift+F6 を押してください。 または、アンカーを右クリックして を選択します。

構造 ツールウィンドウ (Alt+7) を使用して、YAML ファイル内をすばやく移動します。 構造 ツールウィンドウで再利用されたアンカーの要素を表示または非表示にするには、 use エイリアスされたサブツリー をクリックします。

JSON スキーマ
WebStorm は、JSON スキーマを使った YAML ファイルのコード補完やインスペクションに対応しています。 WebStorm はファイルの場所や構造に基づいてスキーマを自動的に推測できるほか、 手動で選択することも可能です。 例えば、 .github/workflows ディレクトリに GitHub Actions ワークフローファイルがある場合、WebStorm は schemastore.org から自動的に読み込んだ github-workflow.json スキーマに基づいてオプション補完を提案します:

設定 ダイアログ (Ctrl+Alt+S) の 言語 & フレームワーク | スキーマと DTD | リモート JSON スキーマ ページを使用して、JSON スキーマのロードを管理できます。
必要に応じて、 言語 & フレームワーク | スキーマと DTD | JSON スキーママッピング で必要なスキーマファイルへのパスを指定できます。
ファイルの JSON スキーマを選択する
特定のファイルにカスタムスキーマを指定できます。
ステータスバーのスキーマスイッチャーをクリックします。

表示されたリストで、提案されたスキーマのいずれかを選択するか、 新規スキーママッピング… をクリックします。 これにより、ファイルのローカルスキーマまたはリモートスキーマを指定できる JSON スキーママッピング 設定が開きます。
スキーマからプロパティを取得する
WebStorm が YAML ファイルのスキーマを検出すると、専用のアクションでそのファイルにすべてのプロパティを素早く挿入でき、手入力の手間が省けます。
スキーマに必須のプロパティが含まれており、これらの特定のプロパティのみを挿入したい場合は、ファイル内の任意の場所で Alt+Enter (コンテキストアクションの表示) を押し、 欠落しているプロパティの追加 を選択します。
スキーマで使用可能なすべてのプロパティを挿入する場合は、ファイル内の任意の場所で Alt+Enter (コンテキストアクションの表示) を押し、 JSON スキーマからすべてのプロパティを入力する を選択します。
$schema キーワードを使用する
ファイル内で直接スキーマを参照することもできます。
ファイルの先頭に
# $schema:と入力します。スキーマファイルの名前の入力を開始します。 schemastore.org から読み込まれたスキーマ名の補完が表示されます。
ローカルスキーマファイルを使用する場合は、スキーマを使用するファイルに対する相対パスを指定します (例:
# $schema: ./my-schema.json)。 これにより、インスペクション、補完、プロパティ入力アクションなど、リモートスキーマを使用する場合と同じコーディング支援が可能になります。
キーのコピー
WebStorm は、YAML ファイル内で指定された特定のオプションへのフルパスをコピーする機能を提供します。 これは 2 つの方法で実行できます。
必要なキーにキャレットを置き、 Ctrl+Alt+Shift+C を押します。
必要なキーにカーソルを合わせ、右クリックして 参照をコピー を選択します。

例: 上のイメージでは、 default.server.port がコピーされます。
入力ハンドラー
YAML ファイルの編集時に、WebStorm はインデント、シーケンスマーカー、角括弧、引用符を維持します。 次の例では、 <caret> はキャレット位置を示します。
シーケンスマーカー
シーケンス項目の後で Enter を押すと、WebStorm は新しい項目を開始し、 - マーカーを自動的に挿入します:
空の項目で Enter をもう一度押すと、WebStorm はマーカーを削除し、ネストされたシーケンスも含めて、キャレットを親のインデントレベルに移動します。
シーケンス項目にマッピングが含まれている場合、 Enter を押すと、マーカー挿入がオンの場合でも、別のマーカーを追加せずに新しいインデント行でマッピングを続行します:
空の項目を削除するには、 Backspace を、 - マーカーに続くスペースの後で押します。 WebStorm は - とその後のスペースを 1 回のアクションで削除します。 同じ行でマーカーの後に値が続く場合でも、WebStorm はマーカーをスペースと一緒に削除し、値はそのまま保持します:
インデント
Enter を押すと、WebStorm は現在の構造に一致するインデントレベルで新しい行を保持します:
値のないキーの後では、新しい行は一段深くインデントされます。
キーと値のペアの後では、新しい行は同じレベルに留まります。
ブロックスカラーインジケーター (
|) の後では、新しい行は一段深くインデントされ、後続の行もそのレベルに留まります。
ブロックスカラー内では、新しい行はキーの一段下にある標準のブロックインデントに配置されます。 現在の行が手動で過剰にインデントされている場合でも、新しい行は過剰にインデントされたテキストに揃えるのではなく、標準のブロックインデントを使用します。
完了したエントリの下にある空白のみを含む行で Enter を押すと、WebStorm は新しい行を再配置せず、手動で設定したインデントを維持します。
まだ項目のないシーケンス内の空行で - に続けてスペースを入力すると、WebStorm はマーカーのインデントを修正します。 インデントシーケンス値 オプションがオンの場合、マーカーは親キーより一段深い位置に配置されます。オプションがオフの場合、マーカーは親キーに揃えられます。 シーケンスにすでに項目が含まれている場合、マーカーは現在のインデントを維持します。 このオプションは、 設定 ダイアログ (Ctrl+Alt+S) の エディター | コードスタイル | YAML ページにあります。
角括弧と引用符
キーまたは値の位置では、WebStorm はフローコレクションと引用符付きスカラーを自動的に閉じます。 [、 {、 " 、または ' を入力すると、WebStorm は対応する文字を挿入し、ペアの間にキャレットを配置します:
自動クローズは、新しいキーや値の位置、または既存のフローコレクション内の位置など、その文字が YAML の構造トークンを開始する場所にのみ適用されます。 キャレットがプレーンスカラーテキスト内またはその直後にある場合、WebStorm はその文字を通常のテキストとして挿入し、何も閉じません。
閉じる ]、 } 、または引用符を同じ文字の直前で入力すると、WebStorm は重複を挿入する代わりに、その文字を越えてキャレットを移動します。 ただし、次の文字がペアになっていない引用符の場合、同じ引用符文字を入力すると、既存の引用符を越えて移動するのではなく、新しいペアが作成されます。
空のペアを削除するには、両方の文字の間で Backspace を押すと、WebStorm が両方を削除します。
キーと項目の移動
キー、ネストされたブロック、またはシーケンス項目を移動するには、その上にキャレットを置き、 Ctrl+Shift+Up または Ctrl+Shift+Down を押します。 WebStorm はネストされた内容を含むエントリ全体を移動し、インデントを正しく保ちます:
複数のエントリを選択した場合、WebStorm は選択範囲をエントリ全体に拡張し、グループとして移動します。
貼り付け
YAML ファイルに内容を貼り付けると、WebStorm はターゲット構造に合わせて調整します:
シーケンスに貼り付けられたプレーン行は個別の項目になり、それぞれ独自の
-マーカーを持ちます。貼り付けた行が
-で始まる場合、または接頭辞付きの行と接頭辞なしの行が混在する場合、WebStorm は各行にマーカーが一つだけ含まれるようにマーカーを正規化します。spring.datasource.urlなどのドット区切りのパスは、ネストされたキーに展開されます。複数行ブロックは、最初の行がキャレットのインデントに一致するように再インデントされ、内部の行は相対インデントを維持します。 空白行は空のままになります。
既存のキーの直前に貼り付けると、WebStorm は貼り付けたブロックを再インデントし、既存のキーを元の列に保持します。
たとえば、マッピング位置に spring.datasource.url を貼り付けます:
ドット区切りキーの展開をオンまたはオフにするには、 貼り付け時にキーシーケンスを自動展開する オプションを 設定 ダイアログ (Ctrl+Alt+S) の エディター | 一般 | スマートキー | YAML ページで使用します。