מעצב YAML

איך זה עובד

כל העיצוב של YAML נשען על הזחה, מה שהופך אותו לנעים לקריאה וקל במיוחד לשבירה. רווח תועה אחד מייצר הודעת שגיאה מצינור CI עשרים דקות מאוחר יותר. כאן הוא מנותח במקום ומקבלים הודעה מיד.

אימות עם מספר שורה

אם המסמך אינו מתנתח, מקבלים את השורה והעמודה שבהן נכשל ואת הסיבה של המנתח עצמו. זה כמעט תמיד מועיל יותר מהפלט המעוצב, וזו הסיבה שרוב האנשים פותחים כלי כזה.

עיצוב מחדש

YAML תקין מנותח למבנה נתונים ונכתב מחדש מאפס, כך שההזחה אחידה, הציטוט מנורמל ורווחים עודפים בסוף שורות נעלמים. מכיוון שהתהליך עובר דרך נתונים ולא עריכת טקסט, התוצאה תקינה בהכרח.

מה המחיר של המרה הלוך ושוב

הערות אובדות. הן אינן חלק מהנתונים ולכן המנתח משליך אותן. עוגנים וכינויים (anchors ו-aliases) מורחבים לערכים המלאים שלהם ולא נשמרים. אם ההערות בקובץ חשובות, כדאי לעצב עותק וליישם את תיקוני ההזחה ידנית.

מיון מפתחות

סדר אלפביתי הופך שני קובצי הגדרות לברי השוואה באמת ב-diff. אבל זו גם בחירה שגויה לקובץ שבו הסדר נושא משמעות לקורא אנושי — צינור CI נקרא טוב יותר בסדר ההרצה מאשר בסדר אלפביתי.

כמה מסמכים

קובץ שמכיל כמה מסמכים המופרדים ב-‎---‎ מטופל, וכל מסמך מעוצב בתורו.