مدقق YAML
تحقّق من YAML بحثًا عن أخطاء نحوية قبل أن يتسبب في تعطل عملية النشر أو مسار CI. يحلل المدقق كل مستند في الإدخال باستخدام محلل YAML 1.2، ويرفض المفاتيح المكررة وعلامات الجدولة المستخدمة للمسافات البادئة والتوسع الجامح للأسماء المستعارة، ويعرض أول خطأ مع المستند والسطر والعمود. تعرض المدخلات الصحيحة عدد المستندات والنوع الأعلى مستوى لكل منها وأي تحذيرات. أُعدّ لأجل Kubernetes وDocker Compose ومؤلفي ملفات الإعداد.
الأسئلة الشائعة
ما الذي يتحقق منه مدقق YAML؟
يحلل صياغة YAML كاملة: المسافات البادئة، والمجموعات الكتلية والتدفقية، والقيم العددية المقتبسة والعادية، والمراسي، والأسماء المستعارة، والوسوم والتوجيهات. كما يعدّ المفاتيح المكررة في التعيين خطأً. إما أن تؤكد النتيجة صحة الملف مع ملخص موجز، أو تعرض أول خطأ مع موضعه وشرح له.
ما إصدار YAML الذي يتبعه؟
يستخدم المدقق المخطط الأساسي لـ YAML 1.2، وهو الإصدار الحالي من المواصفات. في الإصدار 1.2، تُعد كلمات مثل yes وno وon وoff سلاسل نصية عادية وليست قيمًا منطقية، لذا لا تسبب أخطاءً أبدًا. وتظل المستندات المكتوبة لأدوات YAML 1.1 مقبولة ما دامت صياغتها صحيحة.
لماذا تُبلّغ المفاتيح المكررة بوصفها أخطاء؟
تتطلب مواصفات YAML أن تكون المفاتيح في التعيين فريدة. تحتفظ كثير من المحللات بالقيمة الأخيرة بصمت، ما يخفي أخطاء الإعداد مثل تعريف إعداد مرتين. يعرض المدقق السطر والعمود للمفتاح المكرر لتقرر القيمة التي تريد الإبقاء عليها.
كيف يُحتسب رقم السطر والعمود والمستند؟
يبدأ ترقيم الأسطر والأعمدة من 1 عند بداية الإدخال الذي تلصقه. تُعدّ المستندات حسب ترتيب ظهورها، ويفصل بينها أسطر ---، لذا يكون المستند الأول هو المستند 1. يشير الموضع إلى المكان الذي اكتشف فيه المحلل المشكلة، وقد يكون مباشرة بعد الخطأ الفعلي.
هل يمكنني التحقق من عدة مستندات YAML دفعة واحدة؟
نعم. افصل المستندات باستخدام --- كما في بيان Kubernetes متعدد المستندات، وسيُحلل كل مستند. تعرض النتيجة الصحيحة عدد المستندات والنوع الأعلى مستوى لكل منها.
ما المقصود بالنوع الأعلى مستوى؟
يخبرك بما يحتويه كل مستند عند جذره: تعيينًا من المفاتيح والقيم، أو تسلسلًا من العناصر، أو قيمة مفردة، أو لا شيء على الإطلاق. معظم ملفات الإعداد تعيينات، بينما تكون قوائم الموارد غالبًا تسلسلات. ويعني النوع غير الصحيح هنا عادةً وجود شرطة أو مسافة بادئة في غير موضعها.
ما التحذيرات؟
التحذيرات مشكلات لا توقف التحليل، مثل وسم لا يعرفه المحلل فيُقرأ عندئذٍ كقيمة عادية. يُعرض كل تحذير مع السطر والعمود، بحد أقصى 20 تحذيرًا. ويظل المستند الذي يحتوي على تحذيرات صحيحًا.
لماذا تُرفض علامات الجدولة؟
تحظر YAML أحرف الجدولة للمسافات البادئة لأن عرضها ملتبس. استبدل علامات الجدولة في بداية السطر المشار إليه بمسافات، وحافظ على اتساق المسافات البادئة مع الأسطر المحيطة. يُسمح بعلامات الجدولة داخل القيم والسلاسل المقتبسة.
هل هو محمي من هجمات القنابل بالاسم المستعار؟
نعم. يمكن توسيع الأسماء المستعارة بحد أقصى 100 مرة، لذا يُبلّغ عن المستند المصمم لتكرار الأسماء المستعارة حتى تستهلك غيغابايت من البيانات، والذي يُعرف غالبًا بهجوم مليار ضحكة، على أنه غير صالح بدلًا من استنفاد الذاكرة. يظل الاستخدام العادي للمراسي والأسماء المستعارة لمشاركة الإعدادات أقل بكثير من هذا الحد.
هل يتحقق من مطابقة مخطط مثل Kubernetes أو OpenAPI؟
لا، فهو يتحقق من الصياغة والبنية فقط، وليس من مطابقة المفاتيح والقيم لمخطط معين. يمكن أن يصل حجم المدخلات إلى 5 MiB. لتحويل YAML صالح إلى JSON أو TOML أو تنسيق آخر، استخدم محول تنسيقات البيانات.