YAML フォーマッター

整形前と整形後

乱れた入力:

server:
  port:   8080
  hosts: ["api.example.com",  "api2.example.com"]
  timeout:  30
  debug: true

整形後(スペース2つ、ブロックスタイル):

server:
  port: 8080
  hosts:
    - api.example.com
    - api2.example.com
  timeout: 30
  debug: true

整形オプション

クォートのルール

たいていは最小限のクォートで十分です。裸のままでは危険な場合を除き、文字列は引用符なしのままになります。次のケースではフォーマッターが自動的にクォートを付けます:

• 文字列としてのレガシーなブール値: yes、no、on、off、y、n。YAML 1.2 はこれらを文字列として読みますが、多くのパーサーはいまだに YAML 1.1 に従い、クォートなしの no は false になります。フォーマッターは出力で必ずクォートを付けるため、有名なノルウェー問題(国リストの NO が false と読まれる)がファイルの利用者を噛むことはありません。
• 文字列としての数値: '007'、'3.14'。クォートがなければ整数や浮動小数点数として解析されてしまいます。
• :、#、[、{ などの文字を含む、または先頭が空白の文字列。裸で出力すると構造が変わってしまいます。

毎回の整形で行われるクリーンアップ

• 行末の空白。 削除されます。
• 混在した、または不揃いなインデント。 選んだインデント幅に正規化されます。
• コレクション内の空行。 削除されます。
• インデント内のタブ。 YAML では禁止です。パーサーは行番号を示す明確なエラーで入力を拒否するので、他のパーサーに拒否されるファイルを出荷する前に修正できます。

コメント、アンカー、マージキー

整形はドキュメントモデルを正規化するため、コミット前に知っておきたい制限があります:

• コメントは削除されます。 パーサーはドキュメントをデータに解決するので、# コメントは整形後に残りません。コメントが大事な場合はコピーを取っておいてください。
• アンカーとエイリアスは解決されます。 エイリアスで共有されたノードは共有されたままですが、&ref_0 のような生成名で出力し直され、元のアンカー名は保持されません。
• マージキー(<<:)は解決され、マージ済みの値を持つ通常のマッピングになります。

複数ドキュメントのストリーム

複数ドキュメントのストリームに対応しています。各ドキュメントは独立して整形され、--- 区切りで再連結されます。1 回の実行で最大100ドキュメントまでです。