YAMLバリデーターのチェック内容

YAMLは、多くの設定ファイルで使われる形式です。Docker Composeファイル、Kubernetesマニフェスト、GitHub ActionsやGitLab CIのワークフロー、Ansibleプレイブック、OpenAPI仕様、そして数え切れないほどのアプリの設定などに使われています。YAMLではインデントが意味を持つため、スペースの不足、不要なタブ、キーの重複によって、見つけにくい形でファイルが壊れることがあります。このバリデーターはパーサーと同じようにYAMLを読み取り、問題を行番号と列番号とともにすべて表示します。

使い方

  1. エディターにYAMLを貼り付けるか入力します。
  2. 入力するとすぐに結果が表示されます。YAMLが有効な場合は、含まれるドキュメントの数が表示されます。無効な場合は、テキスト内の順にすべての問題が表示されます。
  3. 各問題はエディター内にマークされます。エラーは赤、警告は黄色で表示されます。問題をクリックすると該当箇所までエディターがスクロールします。また、マークをクリックすると一覧内の該当項目を確認できます。

検出できる問題

  • 構文エラー: 閉じられていない引用符や角かっこ、インデントが浅すぎる項目や深すぎる項目、同じ階層に混在しているキーとリスト項目、a: b: cのように1行にネストされたマッピング。
  • キーの重複: 1つのマッピング内で同じキーが2回使われている状態。多くのパーサーは値の一方だけを黙って保持するため、もう一方の設定は失われます。
  • インデントへのタブの使用: YAMLではインデントにスペースのみ使用できます。
  • アンカーのないエイリアス: *nameエイリアスを使うには、同じドキュメント内のそれより前に&nameアンカーが必要です。
  • パースはできても意図どおりに動作しない可能性がある場合の警告。たとえば、パーサーが認識できないタグや、サポートされていない%YAMLバージョンなどです。

異なるマッピングで同じキーを使うことは問題ありません。また、---で区切られた複数のドキュメントを含むファイルも使用できます。行番号はファイル全体を通して数えられます。

チェック対象外の内容

このバリデーターがチェックするのは、テキストが有効なYAMLかどうかであり、特定のプログラムがその内容を受け入れるかどうかではありません。Docker Composeファイルが有効なYAMLでも、Docker Composeが認識しない設定名を含んでいる場合があります。メッセージはyamlライブラリからのもので、英語で表示されます。

仕組み

このツールはyamlライブラリを使ってテキストをパースします。このライブラリは、キーの重複を許可しないYAML 1.2仕様に準拠しています。すべての処理はブラウザー内で実行され、ファイルがアップロードされることはありません。

特長

  • 行番号と列番号付きの構文エラー
  • キーの重複、インデントへのタブの使用、アンカーのないエイリアスを検出
  • エラーと警告をエディター内にマークし、クリックすると該当箇所までスクロール
  • 複数のドキュメントを含むファイルに対応
  • ブラウザー内で実行