🚂

超速習 YAML記法

2022/03/08に公開

開発を行う上でyamlファイルを使う場面は多々あると思いますが,ここでは自分用のメモとして記法を簡潔にまとめました.

ハッシュ

キーバリューの組み合わせのこと
キーとバリューを「":"(コロン)」でつなぎ,キーとバリューの間には半角スペースを1つ以上入れる必要があります.

 key1: value
 key2: value

ハッシュのネスト

 parent_key:
   child_key1: child_value1
   child_key2: child_value2

配列

配列は「"-"(ハイフン)」で表現します
また,「"-"(ハイフン)」1つが1要素になります

 key:
   - value1
   - value2
   - value3
   - value4

 #使用する場面は少ないですがこのようにも表せます
 key: [value1, value2, value3]

配列のネスト

 key:
   -
     - value1
     - value2
   -
     - valueA
     - valueB

配列内のハッシュ

配列の要素がハッシュを持つ場合です

 parent_key:
   - child_key1: child_value1
     child_key2: child_value2

長文(コードのような改行付きの長い文字列を入れたい場合)

バリューに改行ありの長文を入れたいケース(コマンド群やソースコードなどを入れるような―ケース)の場合,「"|"(パイプ)」に続けてデータを記載します.

 key: |
   hoge
     foo
         bar

#このまま(↑)出力される
   hobe
     goo
         bar

複数YAMLの結合(1ファイルに複数のYAMLを含めたい場合)

YAMLは1ファイルに複数定義を入れることができます.複数の定義を行いたい場合,その境界は「"---"(ハイフン3つ)」で仕切ります.

 key1: value1
 ---
 key2: value2 
GitHubで編集を提案

Discussion

ログインするとコメントできます