YAML Formatter

YAML Formatterとは？

YAML Formatterは、読みにくいYAMLを整形して見やすくするツールです。 インデントの統一やキーのアルファベット順ソートができ、構文チェックにも使えます。 Docker Compose・GitHub Actions・Kubernetes などの設定ファイルの整理に役立ちます。

こんな時に便利

• インデント幅がファイルによってバラバラで統一したい：2スペースと4スペースが混在したYAMLでも、指定したインデント幅に統一して出力し直せます。
• キーの並びを整理して見やすくしたい：「キーをソート」をオンにすると、各階層のキーがアルファベット順に並び替えられます。
• docker-compose.ymlや GitHub Actions のワークフローファイルの構文が正しいか確認したい：整形を実行するだけでパースエラーの有無が分かります。
• アンカー（&）・エイリアス（*）を使ったYAMLを、展開した状態で確認したい：共通設定を使い回すYAMLの実際の値を、参照をたどらずそのまま見たいときに便利です。

使用例

例1：インデントを2スペースで整形する

入力：

name: Torinoa Tools
version: "1.0.0"
features:
  - free
  - no-login
  - browser-only

整形後（インデント2スペース・ソートなし）：

name: Torinoa Tools
version: 1.0.0
features:
  - free
  - no-login
  - browser-only

例2：インデント4スペース＋キーをソートして整形する

同じ入力に対して、インデント幅を4スペース、「キーをソート」をオンにすると次のようになります。

features:
    - free
    - no-login
    - browser-only
name: Torinoa Tools
version: 1.0.0

features → name → version の順（アルファベット順）にキーが並び替えられ、配列の要素は4スペースでインデントされています。

例3：アンカー・エイリアスを展開する

入力：

defaults: &defaults
  adapter: postgres
  timeout: 30
production:
  <<: *defaults
  database: prod_db

整形後：

defaults:
  adapter: postgres
  timeout: 30
production:
  adapter: postgres
  timeout: 30
  database: prod_db

<<: *defaultsによる参照が解決され、productionの中にdefaultsの内容がそのまま展開されて出力されます。

例4：構文エラーがあるYAMLを入力した場合

入力：

name: Torinoa Tools
  version: 1.0.0

versionのインデントが不正なため、整形を実行すると次のエラーが表示されます。

YAMLパースエラー: bad indentation of a mapping entry (2:10)

インデントの深さがそろっているか確認してください。