yamlfmt
هي أداة أو مكتبة سطر أوامر قابلة للتوسيع لتنسيق ملفات yaml.
هذه الأداة غير مدعومة رسميًا من Google حتى الآن. تتم صيانته حاليًا بواسطة @braydonk فقط، وما لم يتغير شيء ما بشكل أساسي في أوقات الفراغ.
سأستخدم هذه الروابط لمناقشات GitHub كمدونة من نوع ما، حتى أتمكن من إعداد شيء أكثر ملاءمة:
لتنزيل الأمر yamlfmt
، يمكنك تنزيل الملف الثنائي المطلوب من الإصدارات أو تثبيت الوحدة مباشرةً:
go install github.com/google/yamlfmt/cmd/yamlfmt@latest
يتطلب هذا حاليًا إصدار Go 1.18 أو أحدث.
ملاحظة: الإعداد الموصى به إذا كانت هذه هي المرة الأولى التي تقوم فيها بتثبيت Go سيكون موجودًا في منشور مدونة DigitalOcean هذا.
يمكنك أيضًا تنزيل الملف الثنائي الذي تريده من الإصدارات. الثنائي مكتفي ذاتيًا دون أي تبعيات، ويمكن ببساطة وضعه في مكان ما على المسار الخاص بك وتشغيله باستخدام الأمر yamlfmt
. اقرأ المزيد حول التحقق من صحة القطع الأثرية التي تم إصدارها هنا.
يمكنك أيضًا تثبيت الأمر باعتباره خطافًا للالتزام المسبق. راجع مستندات الارتباط المسبق للحصول على الإرشادات.
راجع استخدام الأوامر للحصول على معلومات متعمقة والأعلام المتاحة.
لتشغيل الأداة بجميع الإعدادات الافتراضية، قم بتشغيل الأمر باستخدام وسيطة المسار:
yamlfmt x.yaml y.yaml < ... >
يمكنك تحديد العديد من المسارات كما تريد. يمكنك أيضًا تحديد الدليل الذي سيتم البحث فيه بشكل متكرر عن أي ملفات ذات الامتداد .yaml
أو .yml
.
yamlfmt .
يمكنك أيضًا استخدام وضع بديل يقوم بالبحث في المسارات ذات الكرات ذات النجمة المزدوجة عن طريق توفير العلامة -dstar
.
yamlfmt -dstar ** / * .{yaml,yml}
راجع حزمة doublestar لمزيد من المعلومات حول هذا التنسيق.
يمكن تكوين الأمر yamlfmt
من خلال ملف yaml يسمى .yamlfmt
. يمكن أن يعيش هذا الملف في دليل العمل الخاص بك، أو المسار المحدد من خلال علامة CLI، أو في مسار التكوين العام القياسي على نظامك (راجع المستندات للحصول على التفاصيل). للحصول على وثائق التكوين المتعمقة، راجع التكوين.
ملاحظة: يتوفر دعم التحقق باستخدام إشارة cosign بدءًا من الإصدار 0.14.0 وما بعده.
في حالة حصولك على ملف yamlfmt
الثنائي مباشرةً من أحد الإصدارات، فقد ترغب في التحقق من صحته. يتم تطبيق المجموع الاختباري على جميع العناصر التي تم إصدارها، ويتم توقيع ملف المجموع الاختباري الناتج باستخدام إشارة cosign.
خطوات التحقق (استبدل ABC
في الأوامر المذكورة أدناه بالإصدار الذي تريده):
قم بتحميل الملفات التالية من الإصدار:
curl -sfLO https://github.com/google/yamlfmt/releases/download/vA.B.C/checksums.txt
curl -sfLO https://github.com/google/yamlfmt/releases/download/vA.B.C/checksums.txt.pem
curl -sfLO https://github.com/google/yamlfmt/releases/download/vA.B.C/checksums.txt.sig
التحقق من التوقيع:
cosign verify-blob checksums.txt
--certificate checksums.txt.pem
--signature checksums.txt.sig
--certificate-identity-regexp ' https://github.com/google/yamlfmt/.github/workflows/.+ '
--certificate-oidc-issuer " https://token.actions.githubusercontent.com "
قم بتنزيل الأرشيف المضغوط الذي تريده، وتحقق من صحة المجموع الاختباري الخاص به:
curl -sfLO https://github.com/google/yamlfmt/releases/download/vA.B.C/yamlfmt_A.B.C_Linux_x86_64.tar.gz
sha256sum --ignore-missing -c checksums.txt
إذا تم التحقق من صحة المجموع الاختباري، قم بفك ضغط الأرشيف:
tar -xzf yamlfmt_A.B.C_Linux_x86_64.tar.gz
./yamlfmt