☰ منسّق YAML

كيفية تنسيق YAML عبر الإنترنت

YAML (اختصار YAML Ain't Markup Language) هو معيار لتسلسل البيانات مصمم ليكون سهل القراءة للبشر، وقد أصبح صيغة الإعداد المفضلة للبنية التحتية والتطبيقات الحديثة. وعلى عكس JSON أو XML، يعتمد YAML على المسافات البادئة بدلاً من الأقواس أو الوسوم لتحديد البنية، ما يجعله واضحاً وسهل القراءة، لكنه في المقابل حساس تجاه أي تفاوت في المسافات. يحل منسّق YAML الخاص بنا هذه المشكلة عبر تطبيق مسافة بادئة موحدة بمقدار مسافتين في المستند كاملاً.

البدء أمر بسيط للغاية. الصق محتوى YAML الخاص بك في المحرر، ثم اضغط على زر تنسيق. تقوم الأداة بتحليل بنية YAML الخاصة بك، وتحديد كل المستويات المتداخلة من الكائنات والقوائم، ثم إعادة بناء المخرجات بمسافات بادئة متناسقة تماماً. تحافظ هذه العملية على جميع بياناتك مع ضمان وقوع كل مفتاح وقيمة وعنصر قائمة في المستوى الصحيح من العمق.

يدعم المنسّق جميع خصائص YAML المعتادة: التخطيطات (أزواج المفتاح والقيمة)، والتسلسلات (قوائم تبدأ بشرطة)، والسلاسل النصية المقتبسة وغير المقتبسة، والقيم الرقمية، والقيم المنطقية مثل true وfalse، والقيم الفارغة، وحتى السلاسل النصية متعددة الأسطر باستخدام رمز الأنبوب (|) ورمز الطي (>). يتم الحفاظ على التعليقات أثناء التنسيق، لذا لن تفقد أبداً الملاحظات المهمة في ملفات الإعداد الخاصة بك.

سواء كنت تنظّم ملف Kubernetes مبعثراً، أو ترتّب ملف Docker Compose، أو تجهّز ملف Ansible للمراجعة، فإن التنسيق المتسق يجعل YAML أسهل في القراءة، وأسهل في المقارنة عبر الفروقات، وأسهل في الصيانة مع مرور الوقت. يعمل المنسّق بالكامل داخل متصفحك، لذا تبقى بيانات الإعداد لديك خاصة وآمنة على جهازك.

YAML مقابل JSON: فهم الفروقات

يُعدّ كل من YAML وJSON من صيغ تسلسل البيانات الشائعة، إلا أنهما يخدمان أغراضاً وجمهوراً مختلفَين إلى حد ما. يُستخدم JSON على نطاق واسع لتبادل البيانات بين خدمات الويب وواجهات البرمجة بفضل صياغته الصارمة ودعمه الشامل من قبل المحلّلات. أما YAML فقد صُمم في المقام الأول من أجل سهولة القراءة للبشر، ما يجعله الخيار المفضل لملفات الإعداد في منظومة DevOps بأكملها.

من أبرز الفروقات ما يتعلق بالصياغة. يتطلب JSON مفاتيح محاطة بعلامات اقتباس مزدوجة، وأقواساً معقوفة للكائنات، وأقواساً مربعة للقوائم. بينما يستخدم YAML المسافات البادئة لتمثيل التسلسل الهرمي، والشرطات لعناصر القوائم، والنقطتين الرأسيتين لأزواج المفتاح والقيمة. لذلك غالباً ما تحتاج البنية نفسها من البيانات إلى أسطر وأحرف أقل عند كتابتها بصيغة YAML. فمثلاً، إعداد خادم بسيط يحتاج إلى ثماني أسطر في JSON قد يحتاج إلى خمسة أسطر فقط في YAML، دون الحاجة إلى أقواس أو فواصل.

يدعم YAML أيضاً خصائص لا يوفرها JSON، مثل التعليقات (باستخدام رمز #)، والسلاسل النصية متعددة الأسطر (باستخدام | للكتل الحرفية أو > للكتل المطوية)، إضافة إلى المراسي والأسماء المستعارة لإعادة استخدام البيانات ضمن المستند نفسه. تجعل هذه الخصائص YAML قوياً بشكل خاص في سيناريوهات الإعداد المعقّدة، حيث يكون للتوثيق ومبدأ DRY (اختصار Don't Repeat Yourself، أي لا تكرر نفسك) أهمية حقيقية.

مع ذلك، قد يكون اعتماد YAML على المسافات سلاحاً ذا حدّين. فمسافة واحدة أو علامة جدولة في مكان خاطئ قد تُفسد المستند بأكمله. لهذا السبب تُعدّ أدوات مثل منسّق ومدقق YAML لدينا ضرورية للغاية، إذ تكتشف أخطاء المسافات البادئة قبل أن تتسبب في فشل أثناء التشغيل ضمن خطوط النشر لديك. تتيح لك أزرار التحويل لدينا التنقل بحرية بين YAML وJSON، وفق ما يتطلبه سير عملك في كل لحظة.

YAML في DevOps: Kubernetes وDocker Compose وCI/CD

أصبح YAML المعيار الفعلي لإعداد البنية التحتية في عالم DevOps. فتقريباً كل منصة وأداة رئيسية في منظومة الحوسبة السحابية الحديثة تستخدم YAML لملفات الإعداد الخاصة بها. لذلك فإن فهم تنسيق YAML ليس مجرد راحة إضافية، بل ضرورة عملية لمهندسي البرمجيات ومختصي DevOps اليوم.

يستخدم Kubernetes صيغة YAML على نطاق واسع لتعريف عمليات النشر والخدمات وخرائط الإعداد والأسرار وقواعد Ingress وعشرات الأنواع الأخرى من الموارد. يحتوي ملف Kubernetes النموذجي على بنى متداخلة مثل spec.containers[].ports[] يجب أن تكون مسافاتها البادئة دقيقة تماماً. حتى مسافة واحدة زائدة قد تجعل أمر kubectl apply يرفض الملف بأكمله. يضمن منسّقنا أن تكون ملفاتك مهيكلة بشكل صحيح قبل إرسالها إلى العنقود الخاص بك.

تعرّف ملفات Docker Compose تطبيقات متعددة الحاويات تشمل الخدمات والشبكات ووحدات التخزين ومتغيرات البيئة. تتطلب صيغة docker-compose.yml تداخلاً دقيقاً لتعريفات الخدمات، وربط المنافذ، وإعلانات الاعتماديات. يسهّل تنسيق هذه الملفات بشكل متسق مراجعتها ضمن طلبات السحب ويقلل من احتمال حدوث أخطاء في النشر.

تعتمد سير عمل GitHub Actions، وخطوط GitLab CI، وإعدادات CircleCI، وغيرها من منصات CI/CD كلها على YAML لتعريف خطوات البناء، والمحفزات، ومصفوفات البيئات، ومراحل النشر. يمكن أن تصبح هذه الملفات معقدة بسرعة، مع تعبيرات شرطية واستراتيجيات مصفوفة ومراجع لسير عمل قابل لإعادة الاستخدام. يحافظ YAML المُنسّق جيداً على وضوح هذه الخطوط وسهولة صيانتها مع نمو مشاريعك.

يكتشف مدقق YAML لدينا الأخطاء الشائعة قبل وصولها إلى خط CI/CD لديك: مستويات المسافات البادئة الخاطئة، والنقطتين الرأسيتين المفقودتين بعد المفاتيح، وخلط علامات الجدولة مع المسافات، وعناصر القوائم المنسّقة بشكل خاطئ. ولأن التحقق يتم محلياً داخل متصفحك، فإنك تحصل على ملاحظات فورية دون انتظار فشل عملية بناء ليخبرك بوجود خطأ ما.

التحقق من صحة YAML والأخطاء الشائعة

تجعل صياغة YAML الحساسة للمسافات الأخطاء الدقيقة سهلة الحدوث وصعبة الملاحظة بالعين المجردة. يحلّل مدقق YAML لدينا مستندك ويُبلّغ عن موقع الخطأ بدقة، مما يساعدك على إصلاح المشكلات بسرعة. فيما يلي أكثر أخطاء YAML شيوعاً وكيفية تجنبها.

عدم اتساق المسافات البادئة هو الخطأ الأكثر شيوعاً في YAML. يتطلب YAML استخدام المسافات للمسافة البادئة (لا يُسمح باستخدام علامات الجدولة في YAML القياسي)، ويجب أن يستخدم كل مستوى من التداخل العدد نفسه من المسافات. فمزج مسافتين وأربع مسافات ضمن الكتلة نفسها، أو استخدام علامات الجدولة عن طريق الخطأ، سيؤدي إلى فشل التحليل. يوحّد منسّقنا كل شيء تلقائياً إلى مسافة بادئة بمقدار مسافتين.

غياب النقطتين الرأسيتين أو غياب المسافة بعدهما يوقع كثيراً من المستخدمين في الخطأ. في YAML، يتطلب زوج المفتاح والقيمة نقطتين رأسيتين متبوعتين بمسافة: key: value. وكتابة key:value بدون مسافة بعد النقطتين سيتم تفسيرها بشكل مختلف أو ستتسبب في خطأ. وبالمثل، فإن نسيان النقطتين تماماً يحوّل التخطيط إلى سلسلة نصية عادية.

تنسيق القوائم غير الصحيح مشكلة شائعة أخرى. يجب أن تبدأ عناصر القائمة بشرطة متبوعة بمسافة (- عنصر). ويجب أن تكون الشرطة في مستوى المسافة البادئة الصحيح بالنسبة إلى المفتاح الأعلى منها. تتطلب القوائم المتداخلة مسافة بادئة إضافية، كما أن مزج أنماط القوائم ضمن التسلسل نفسه يسبب أخطاء في التحليل.

الأحرف الخاصة في السلاسل النصية غير المقتبسة قد تتسبب في سلوك غير متوقع. فأحرف مثل : و# و[ و] و{ و} و, لها معنى خاص في YAML. فإذا كانت قيم السلاسل النصية لديك تحتوي على هذه الأحرف، ضعها بين علامتي اقتباس مفردتين أو مزدوجتين. يحدد مدققنا الأسطر التي قد تتسبب فيها الأحرف الخاصة بمشكلات في التحليل، ويُبلّغ عن رقم السطر الدقيق لتسهيل تصحيح الأخطاء.

بتشغيل YAML الخاص بك عبر المدقق قبل النشر، يمكنك اكتشاف هذه المشكلات محلياً وفوراً، مما يوفر عليك الوقت الذي كنت ستقضيه بخلاف ذلك في تصحيح عمليات نشر فاشلة، أو إعدادات معطلة، أو سلوك غامض للتطبيق ناتج عن بيانات مشوّهة.

الأسئلة الشائعة

أدوات ذات صلة

🔒 خصوصية وأمان 100%

تتم جميع عمليات معالجة YAML محلياً داخل متصفحك. لا تُرفع بيانات الإعداد الخاصة بك أبداً إلى أي خادم. آمن لأسرار Kubernetes، ومفاتيح واجهات البرمجة، وإعدادات البنية التحتية الحساسة.