ヘルプ

YAMLチェック:入力しながら構文エラーを確認

YAMLを貼り付けると、入力しながらYAMLチェックが実行され、構文エラーが行と列つきで分かりやすい言葉で説明されます。タブによるインデント、重複したキー、閉じていない引用符や括弧、インデントに見えるだけの見えないノーブレークスペースも見つけます。YAMLはお使いのブラウザー内で確認され、アップロードされることはありません。


YAML構文チェックの使い方

YAMLの入力欄にYAMLを貼り付けるか入力してください。確認ボタンはありません。テキストはリアルタイムで確認されます。

  1. 貼り付けたテキストはすぐに確認されます。入力中は、最後のキー入力から約0.25秒後に確認が走り、とても大きなテキストでは少し長くかかります。新しい結果が出るまで、前の結果は薄く表示されたままです。
  2. エディターの下のボックスを読んでください。緑色の有効なYAMLのボックスは、構文が正しいことを表します。赤色の「無効なYAML」のボックス(または「無効なYAML:N件の問題」)には、問題点が一覧で表示されます。
  3. 各問題には、説明の文、「N行目、M列目」、行番号つきの該当行の抜粋が表示されます。抜粋には上2行と下1行が含まれ、列の下に^が付きます。
  4. エディターで表示を押すと、その行が入力欄で選択されます。直すと、ボックスが緑色に変わります。

報告されるのは、各ドキュメントの最初の構文エラーだけです。その後のエラーは、引用符の閉じ忘れが下の行を巻き込むなど、副次的なものであることが多いためです。重複したキーと未定義のエイリアスは、常にすべて一覧表示されます。表示されるのは最大20件です。

YAMLエラーのよくある原因と直し方

エラーは、パーサーの生のメッセージではなく、1つの文で説明されます。特によく出会うものは次のとおりです。

他のツールのエラーメッセージの意味

ターミナルやCIのログのエラーから来た方へ。よくある表現が、このチェッカーの報告とどう対応するかを示します。同じファイルを貼り付ければ、該当行が表示されます。

表現はパーサー(PyYAML、js-yaml、Ruby、Go、Home AssistantやESPHomeのローダー)によって異なり、パーサーは本当の間違いより下の行を報告することがよくあります。このチェッカーは、表示できる行を指し示します。

タブと見えない文字のチェック

YAMLで最も見つけにくい2つの間違いは、目に見えないものです。このチェッカーはそれを見えるようにします。

例:server:の下にport: 8080があるファイルで、最後の行host: example.comが、2つのスペースではなく2つのノーブレークスペースで始まっているとします。YAMLはこれを別のトップレベルのキーとして読み、hostはserverの子になりません。黄色のボックスが、その文字と行を示します。

YAMLを整形してコピーする

入力欄の上にあるスイッチYAMLを整形をオンにしてください。初期状態ではオフです。テキストが有効なとき、整形したYAMLのブロックが現れ、その上にコピーボタンが付きます。コピーするとコピー完了に変わります。整形の結果は予測しやすいものです。

整形できるのは有効なYAMLだけなので、壊れたファイルを直すことはできません。先にエラーを直してください。とても長い出力は60万文字で切って表示されますが、コピーはそれでも全体をコピーします。

YAMLフォーマットの対象と上限

YAMLが何のためのものでも、確認の内容は同じです。GitHub Actionsのワークフロー、docker-compose.yml、KubernetesのマニフェストやHelmの値、OpenAPIファイル、Ansibleのプレイブック、Home Assistantの設定、CloudFormationのテンプレート、mkdocsの設定に使えます。コミットやプッシュの前にファイルを貼り付ければ、CIの実行を待たずに構文エラーが分かります。---で区切られた複数のドキュメントを含むファイルは、ドキュメントごとに確認され、緑のボックスに見つかった数が表示されます。アンカー(&名前)とエイリアス(*名前)も確認され、前にアンカーがないエイリアスは報告されます。CloudFormationの!Ref、!Sub、!GetAttやGitLabの!referenceのようなカスタムタグは、有効として受け付けられます。

確認はブラウザー内のWeb Workerで動きます。一般的な設定ファイル、CIファイル、Kubernetesのファイルは一瞬で確認できます。上限は500万文字で、それに近いテキストは数秒かかり、多くのメモリを使います。上限を超えると、より小さい部分を貼り付けるよう求められます。

確認するのはYAMLの構文だけです。特定のツールが何を求めるかは分からないため、Kubernetesのフィールド、GitHub ActionsやDocker Composeのキー、JSON Schemaのルールは確認されず、キー名のつづり間違いも通ります。YAML 1.2に従うので、YAML 1.1の単語yes、no、on、offは通常のテキストで、判定されません。何かを実行したり、取得したり、読み込んだりはせず、単独の古いMacの復帰文字は改行として扱われません。

他の形式を扱うなら、JSONの整形と確認はJSON整形ツール、スキーマとの照合はJSON Schema バリデーター、マークアップの確認はXMLチェッカーを使ってください。設定の中のパターンを調べたいときは、正規表現テスターで試せます。


よくある質問

YAMLチェックはどうやってしますか?

「YAML」の入力欄にYAMLを貼り付けてください。貼り付けや入力のたびに確認されるので、押すボタンはありません。緑色の「有効なYAML」のボックスは、構文が正しいことを表します。赤色の「無効なYAML」のボックスには、各問題が分かりやすい言葉と「N行目、M列目」、該当行の抜粋つきで表示されます。

YAMLでタブをインデントに使えないと言われるのはなぜですか?

YAMLのインデントにはスペースしか使えず、行頭のタブは構文エラーです。エディターはTabキーを押すとタブを入れることが多く、貼り付けたテキストにタブが含まれることもあります。チェッカーは、その行がタブでインデントされていると示します。タブをスペースに置き換えてください。

YAMLの「mapping values are not allowed here」とは何ですか?

多くの場合、「a: b: c」のように1行に2つ目のコロンがあるか、引用符のない値にコロンが含まれています。すでに値があるキーの下に行がインデントされている場合もあります。値を引用符で囲むか、内側のペアをインデントした別の行に書いてください。

YAMLの「did not find expected key」とは何ですか?

ある行が、同じマッピングの他のキーと揃っていません。多くは、キーのスペースが隣のキーより1つ多いか少ない状態です。同じ階層のすべてのキーを同じインデントにしてください。チェッカーは、その行が他のキーと揃っていないと報告します。

YAMLの重複キーを見つけるにはどうしますか?

テキストを貼り付けてください。同じマッピング内の重複したキーは、常にすべて、行と列つきで一覧表示されます。コピーしたブロックにキーが重複して残ることが多いです。統合するか、重複を削除してください。

有効なYAMLなのに「有効ですが、確認したい行があります」と出るのはなぜですか?

行が、ノーブレークスペースなどの見えないスペースで始まっています。YAMLはそれをキーの一部として読むため、ファイルが有効でも、その行は実際にはインデントされていません。黄色のボックスが、その文字と行を示します。削除して、通常のスペースを入力してください。

GitHub ActionsやDocker Compose、KubernetesのYAMLもここで確認できますか?

はい。構文の確認は、どのYAMLでも同じです。ワークフロー、docker-compose.yml、Kubernetesのマニフェストなど多くのファイルに使えます。確認するのは構文だけで、各ツールがどのキーを求めるかは分からないため、キー名のつづり間違いは通ります。

確認できるYAMLファイルの大きさはどれくらいですか?

上限は500万文字です。一般的な設定ファイルは一瞬で確認でき、上限に近いテキストは数秒かかり、多くのメモリを使います。上限を超えると、より小さい部分を貼り付けるよう求められます。

おすすめ

無料でツールを続ける支えになります。✨

画像はイメージです。 Amazonのアソシエイトとして、Capsule Toolsは適格販売により収入を得ています。