YAML フォーマッター
Prettier で YAML を整形：インデントとスペースを統一しつつ、コメントと複数のドキュメントは保持します。構文エラーは行と列付きで表示されます。
出力
すべてブラウザ内で実行されます。データがアップロードされることはありません。
関連ツール
すべて表示YAML フォーマッターとは？
YAML フォーマッターは、Kubernetes のマニフェスト、GitHub Actions のワークフロー、Docker Compose ファイルなどの YAML ファイルのインデントとスペースを正規化します。データを読み込んで書き出すコンバーターとは違い、コメント、ドキュメントの区切り（---）、キーの順序を保持します。
YAML フォーマッターの使い方
- YAML を入力欄に貼り付けるか、サンプルを読み込む をクリックします。
- インデント を選びます（YAML ではスペース 2 つが一般的です）。
- 整形 をクリックします（入力中も出力は更新されます）。
- 整形された YAML をコピーまたはダウンロードします。
例
入力
a: 1
b:
- x # note
出力
a: 1 b: - x # note
YAML フォーマッターを使うべき場面
インデントの不統一の修正、CI/CD や Kubernetes のファイルの整理、コミット前の YAML の確認に使います。YAML のインデントにタブは使えないため、タブのオプションは推奨しません。構文だけをチェックするには、YAML バリデーターを使ってください。
YAML フォーマッターの仕組み
入力はまず js-yaml で読み込まれ、重複キーを含むエラーが正確な行と列で検出されます。その後、Prettier の YAML プラグインで出力されます。これは具象構文木で動作するため、インデントとスペースが正規化される一方で、コメント、アンカー、複数行の文字列、フローコレクションは保持されます。
一般的な使用例
- Kubernetes や Helm の values ファイルを正規化する
- GitHub Actions のワークフローを整える
- docker-compose.yml の混在したインデントを直す
- ドキュメント用に YAML の例を整形する
セキュリティ注意事項
すべてブラウザ内でローカルに処理され、貼り付けたコードがアップロードされることはありません。
よくある質問
コメントは保持されますか？
はい、コメントは保持されます。
キーの順序は変わりますか？
いいえ。
重複キーが拒否されるのはなぜですか？
YAML 1.2 ではマッピング内のキーが一意である必要があるため、js-yaml がそれらをエラーとして報告します。