// formatters

YAML Key Sorter.

Recursively sort YAML keys alphabetically while preserving arrays and scalars. Useful for diff-friendly files.

Client-sideRecursiveNo upload

YAML input

Sorted output

よくある質問

ソートでアンカーが壊れますか?

いいえ、ソートはアンカーと参照を正しく保持します。

コメントを保持しますか?

はい、コメントは元の位置に保たれます。

ソートを元に戻せますか?

はい、元の順序に戻すことができます。

YAMLキーをソートする理由

YAMLファイルのキーをソートすると、可読性が向上し、変更内容の比較が容易になります。特に大きな設定ファイルでは、キーがアルファベット順に並んでいると、特定の設定を探すのが楽になります。

バージョン管理システム(Gitなど)で、ソートされていないYAMLファイルの差分は読みにくい場合があります。ソートすることで、意図的な変更と順序の変更を区別しやすくなります。

チーム開発では、共通のソート規則があることで、 CONTRIBUTORS間のファイル形式のばらつきを防ぎ、保守性を高めます。

ソートの仕組み

このツールは、YAMLファイルのキーをアルファベット順(A→Z)にソートします。ネストされたオブジェクトのキーも再帰的にソートされます。

配列(list)の要素はソートされません。YAMLのコメントや構造(インデントスタイル)は保持されます。

デフォルトでは昇順(A→Z)でソートされ、オプションで降順(Z→A)も選択できます。

キーをソートするタイミング

設定ファイル(docker-compose.yml、.github/workflows/*.ymlなど)を整理する際、キーの順序を統一するためにソートします。

KubernetesのマニフェストやHelmチャートのテンプレートを整理する際、キーの管理が容易になります。

CI/CDパイプラインの設定ファイルで、変更の追跡を容易にするためにソートが役立ちます。