YAMLフォーマッター・検証

YAML Formatter & Validator

YAMLのインデントを揃えて検証し、パーサを壊すタブやアンカーの誤りに印を付けます。

YAMLファイルのインデントを一貫した形に直し、別のパーサなら違う読み方をする場所を教えます。コメント・アンカー・タグ・ブロックスカラーを保つYAML 1.2のリーダーなので、出力は体裁だけを直した元の文書です。コメントを捨ててしまうデータモデルを往復することはありません。

🔒 ブラウザの中だけで動きますyamlformatvalidateconfig

出力

インデント

リスト項目をキーと同じ桁に`key:` のすぐ下に `- 項目` を置きます。Kubernetesのマニフェストでよくある書き方で、どちらの形も正しいYAMLです。

[a, b]・{a: 1} をブロックに展開

不要な引用符を外す外しても文字列として読める値だけを外します。"true" と "012" は引用符を保ったままにします。

コメントを残す

空行を残す

文書ごとに --- を付ける

YAML入力

.yaml ファイルを置く

このタブの中だけで読みます。アップロードはしません。

整形されたYAML

# Deployment manifest — paste it with the indentation as mixed as you like
apiVersion: apps/v1
kind: Deployment
metadata:
  name: web
  labels: {app: web, tier: frontend}
spec:
  replicas: 3
  template:
    spec:
      containers:
        - name: web
          image: "ghcr.io/todododo/web:1.4.2"
          ports:
            - containerPort: 8080
          env:
            - {name: MODE, value: production}
            - name: DEBUG
              value: no # a boolean in YAML 1.1, a string in 1.2
          resources: &res
            limits: {cpu: 500m, memory: 256Mi}
      initContainers:
        - name: migrate
          image: ghcr.io/todododo/migrate
          resources: *res
          command:
            - /bin/sh
            - -c
            - |
              echo "migrating"
              ./migrate up

読めてはいますが、パーサによって解釈が分かれるところ

19:22 — `no` はYAML 1.2では文字列 "no" です。YAML 1.1のパーサはこれを真偽値として読みます。両者を一致させるには、引用符で囲むか true/false と書いてください。

文書

キー

リスト項目

アンカー / エイリアス

1 / 1

警告

この整形ツールがすること、しないこと

· YAML 1.2のコアスキーマで読みます。 yes・no・on・off は文字列で、 0755は8進数ではなく10進数の755です。1.1のパーサなら別に読む値は、上に警告として挙げます。
· コメント、アンカー（&）、エイリアス（*）、タグ、そして |・> のブロックスカラーはすべて保ちます。値の順序も変えません。
· タブによるインデント、キーの重複、定義前に使われたエイリアス、閉じていない引用符は、いずれも行と列を付けてエラーとして捕まえます。
· マージキー << はYAML 1.1の機能ですが、docker-composeやAnsibleのファイルであまりに広く使われているため、JSONへの変換時には適用したうえで、そう警告します。
· [a, b] のようなフローコレクションの中のコメントは、付く行がないので失われます。それ以外のコメントはすべて残ります。

JSONやTOMLに変換するなら JSON ⇄ YAML変換を、スキーマと突き合わせるなら JSON Schema検証をどうぞ。

使い方

マニフェストか設定を貼り付けます
Kubernetesのマニフェスト、CIの設定、docker-composeなどです。`---`で区切られた複数の文書はストリームとして読み、別々に数えます。
一覧の書き方を選びます
実際に議論になる唯一の設定です。`- 項目`をキーと同じ桁に置くか、1段下げるかです。どちらも正しいYAMLで、Kubernetesのマニフェストは慣例として同じ桁に置きます。
警告を読みます
読む側がどのYAMLのバージョンを実装しているかで意味の変わる値——`yes`、`no`、`0755`——を、行と列とともに並べます。別のツールに持っていったときにデプロイを壊すのは、これらです。
あるいは出力をJSONに切り替えます
同じパース結果をJSONとして表示します。ある値が実際に何として解決されたのか——マージキーが何に展開されたのかまで——をいちばん早く確かめる方法です。