ממיר JSON ל-YAML

למה להמיר JSON ל-YAML?

JSON אידיאלי למכונות ול-API, אבל YAML קל יותר לבני אדם לקריאה ולעריכה: בלי סוגריים מסולסלים, בלי מירכאות חובה, ועם תמיכה בהערות. רוב כלי התשתית, כולל Kubernetes,‏ Helm,‏ Docker Compose,‏ GitHub Actions,‏ GitLab CI ו-Ansible, מוגדרים ב-YAML, בעוד שהנתונים שמהם מתחילים (פלט API,‏ kubectl get -o json, ‏Terraform state) הם לרוב JSON.

סגנון block לעומת flow

סגנון block שם כל מפתח ופריט רשימה בשורה משלו, וזו הבחירה המקובלת לקובצי תצורה. סגנון flow משתמש ב-{} וב-[] בתוך השורה, כמו JSON, ושומר על מבנים קצרים בקצוות העץ קומפקטיים. „Flow מרמה 2” משאיר את שתי הרמות העליונות בסגנון block ומכניס לשורה אחת את כל מה שעמוק יותר, וזה עובד טוב לרשימות ארוכות של אובייקטים קטנים, כמו פורטים או משתני סביבה.

מירכאות בטוחות

מחרוזות שמפענח YAML עלול לפרש לא נכון מוקפות במירכאות אוטומטית: ערכים כמו 'no', 'on', '1.0', 'null', מחרוזות שמתחילות ב-* או ב-&, ומחרוזות שמכילות : . בחרו תמיד בודדות או תמיד כפולות אם מדריך הסגנון שלכם דורש שכל מחרוזת תהיה במירכאות.

מלכודות של YAML 1.1 לעומת 1.2

הממיר הזה פועל לפי YAML 1.2, המפרט הנוכחי. כלים ישנים רבים (PyYAML, ‏Psych של Ruby, וחלק מגרסאות Kubernetes ו-Ansible) עדיין קוראים YAML 1.1, שבו הכללים שונים:

• בעיית נורווגיה: ב-YAML 1.1, ‏country: no פירושו false, ולכן קוד המדינה של נורווגיה NO נעלם. אותו דבר נכון ל-yes, on, off, y ו-n. ‏YAML 1.2 מתייחס רק ל-true ול-false כערכים בוליאניים.
• מספרים אוקטליים: 0755 הוא אוקטלי ב-1.1 אבל עשרוני רגיל ב-1.2, שמשתמש ב-0o755. הקיפו הרשאות קבצים במירכאות ליתר ביטחון.
• מספרים בבסיס 60: ב-1.1, ‏22:30 עלול להתפרש כמספר 1350. הקיפו במירכאות שעות ומיפויי פורטים כמו "8080:80".

בכיוון JSON → YAML מחרוזות דו-משמעיות ('no', 'on', 'y') מוקפות במירכאות אוטומטית, כך שה-YAML שנוצר נקרא אותו דבר בשתי הגרסאות.