הנקודות החשובות
- 01עורך קוד לqueries, mutations, subscriptions, וSDL schemas תוך שימוש בprecision parser graphql.js.
- 02אמת syntax ודוח מדויק שורה וcolumn עבור שגיאות — אין schema נדרש.
- 03GraphQL הערות (#) מקלקלות על פורמט; השתמש בתיאור strings עבור תיעוד אתה רוצה משמור.
- 04פועל לגמרי בדפדפן שלך — internal API queries וproprietary schemas נשארים פרטי.
למה לפורמט GraphQL Documents?
GraphQL queries יכול לקבל מסובך במהירות — nested fragments, inline variables, מרובות operation definitions, וSDL type definitions עם interfaces וdirectives. עקביתה פורמט עושה peer review מהיר וגורם זה יותר קל לתופס missing closing braces או argument mismatches בהצצה.
הפורמטר משתמשת בprecision parser graphql.js — אותו parser specification GraphQL משלוח עם. זה אומר את canonical formatting אתה מקבל כאן תואמים מה Prettier's GraphQL plugin וmost GraphQL tooling מייצרים. כל זה parse נקי כאן parse בprecision באפולו, Relay, וgraphql-request.
כיצד לפורמט GraphQL Document
- 01
הדבק את GraphQL שלך
הדבק query, mutation, subscription, fragment, או SDL schema הגדרה לתוך input panel.
- 02
לחץ על פורמט
ה-parser משדרת את המסמך עם canonical indentation — שתיים-space indent, שדה אחד לכל שורה, aligned argument עקביתה. התוצאה מופיע בפלט panel.
- 03
אמת בעצל
לחץ על אמת כדי להשיג את המסמך parse ללא מייצר פלט בפורמט. התוצאה היא אישור או רשימת syntax שגיאות עם שורה וcolumn מספרים.
- 04
העתק את התוצאה
לחץ על העתק כדי להשיג את המסמך בפורמט. הדבק אותו לתוך codebase שלך, PR תיאור, או תיעוד קובץ.
בטוח עבור Internal Schemas וAPI Queries
ה-parser graphql.js פועל לגמרי בדפדפן שלך. אין operation טקסט או schema הגדרה משודר לשום שרת. זה עושה את בטוח לפורמט queries שמתייחסות לprivate שדה names או internal סוג מערכות אתה לא רוצה exposed לthird-party כלים.
אמת כאן היא syntactic בלבד — הכלי בודק שהמסמך הוא תקף GraphQL מסמך, אבל זה לא בודק אם שדה names קיימות בreal schema, אם variables התאם argument סוגים, או אם directives מיושמות בתקן. Schema-aware validation דורש ה-schema לטעון לצד המסמך.
GraphQL Formatter FAQ
האם GraphQL formatting אמת נגד schema?
לא — רק syntax אמת. בדיקה אם fields וarguments קיימות דורש ה-schema. כלי זה משיגה המסמך הוא תקף GraphQL מסמך, כל זה.
האם הערות בGraphQL שלי משמורות?
לא. שורות התחלה עם # מקלקלות על ידי ה-parser. השתמש בtriple-quoted תיאור strings עבור תיעוד שצריך לשרוד פורמט.
איזה GraphQL spec גרסה נתמך?
ה-October 2021 specification, כולל OneOf input objects וה-@specifiedBy directive.
האם אני יכול לפורמט SDL schema הגדרות, לא רק operation מסמכים?
כן. Type הגדרות, interface הצהרות, union types, enums, directives, ותיאורים כל סיבוב-trip בתקן דרך הפורמטר.
האם ה-query או schema מועלה איפה שהוא?
לא. ה-parser graphql.js פועל לגמרי בדפדפן שלך — כל זה עוזב את התקן שלך.