GraphQLフォーマッター

ドキュメントをGraphQLの構文木に解析し、標準的なレイアウトで出力し直します。ドキュメントを解析するため、無効なGraphQLは誤った形式に整形されず、エラーになります。

クエリ、ミューテーション、サブスクリプション、フラグメントに加え、type、input、enum、interface、union、schemaブロックなどのSDLスキーマ定義をフォーマットできます。1つのドキュメントに複数の定義を含めることもできます。

各選択セットは2つのスペースでインデントされ、フィールドごとに1行で表示されます。フィールド間のカンマは削除されます。引数と変数定義では、各コロンの後にスペースが入ります。例：user(id: $id)。

ツールは処理を停止し、「Syntax Error: Expected Name, found }」のようなパーサーのメッセージを表示します。報告された箇所を修正して、もう一度フォーマットしてください。

フォーマッターは、閉じ波括弧の後など、パーサーが関連付けられる位置にハッシュコメント（#）を保持します。スキーマの型やフィールドに付けられた引用符付きの説明はドキュメントの一部であり、常に保持されます。

いいえ。このツールが確認するのは構文だけです。フィールドや引数が存在するかどうかはサーバーのスキーマで決まるため、検証にはGraphQLクライアントまたはサーバーを使用してください。

周囲の引用符、バッククォート、gqlタグを含めず、GraphQLドキュメントだけを貼り付けてください。JSONペイロード内のエスケープ文字は、先にエスケープを解除してください。

いいえ。フォーマッターは常に2つのスペースを使用し、オプションはありません。これは、多くのGraphQLツールやドキュメントで使われているレイアウトに合わせたものです。

出力はgraphqlと指定されたMarkdownコードブロックとして返されるため、Markdownでシンタックスハイライトされます。.graphqlファイルには、フェンスの間にある行をコピーしてください。

1回につき最大5 MBです。それより大きい入力はメッセージとともに拒否されます。出力はCode FormatterのGraphQLオプションと同じです。