ja/users/yaml-editor/UsersManual/YAMLValidation

Error: Failed to load processor TOC
No macro or processor named 'TOC' found

YAMLファイルの妥当性を検証する

YAML Editorはスキーマファイルを設定することで、保存時に妥当性を検証することができます。

YAMLファイルの妥当性を検証する

YAML Editorで妥当性を検証するためには、YAMLファイルに対してスキーマファイルを設定する 必要があります。
Piece Frameworkでは、以下のスキーマファイルを提供しています。

piece-unity-configy.yamlpiece-unity.yaml
フロー定義ファイルpiece-flow.yaml
バリデーション定義ファイルpiece-right.yaml

これらのファイルをダウンロードして、プロジェクト内にスキーマファイルを格納するフォルダ(以下、スキーマフォルダー)を任意の場所に作成します。

スキーマフォルダー作成

次にYAMLファイルを開きます。するとエディター上部に「スキーマフォルダーを選択して下さい。」というメッセージが表示されます。

スキーマフォルダー選択

「変更」をクリックすると、スキーマフォルダー選択ダイアログが表示されるので、先ほど作成したスキーマフォルダーを選択します。

スキーマフォルダー選択ダイアログ

編集しているYAMLファイルに対して、どのスキーマファイルを設定するかを決定します。

スキーマファイル選択

これで保存時に指定したスキーマファイルを使用した妥当性の検証が行われます。
問題が発生した場合は、該当の行にアイコンが表示され、問題ビューに表示されます。

エディターのエラー表示 問題ビュー

YAMLファイルとスキーマファイルは対で保存され、次回YAMLファイルを開くときには前回設定したスキーマファイルが適用されます。

Attachments

  • 1.png (3.5 KB) - added by matsufuji 3 years ago. スキーマフォルダー作成
  • 2.png (5.3 KB) - added by matsufuji 3 years ago. スキーマフォルダー選択
  • 3.png (7.9 KB) - added by matsufuji 3 years ago. スキーマフォルダー選択ダイアログ
  • 4.png (6.6 KB) - added by matsufuji 3 years ago. スキーマファイル選択
  • 5.png (12.5 KB) - added by matsufuji 3 years ago. エディターのエラー表示
  • 6.png (7.4 KB) - added by matsufuji 3 years ago. 問題ビュー
  • piece-unity.yaml (0.6 KB) - added by matsufuji 3 years ago. Piece_Unityスキーマファイル
  • piece-flow.yaml (1.9 KB) - added by matsufuji 3 years ago. Piece_Flowスキーマファイル
  • piece-right.yaml (2.3 KB) - added by matsufuji 3 years ago. Piece_Rightスキーマファイル