استخدم لينتر Bicep

يقوم لينتر Bicep بفحص ملفات Bicep من أجل الأخطاء في بناء الجملة وانتهاكات أفضل ممارسة. يساعد الوبر في فرض مقاييس التعليمة البرمجية من خلال توفير التوجيه أثناء التطوير. يمكنك تخصيص أفضل الممارسات لاستخدامها لفحص الملف.

المتطلبات الخاصة بلينتر

يتم دمج لينتر في CLI Bicep وملحق Bicep للتعليمة البرمجية الخاصة بـVisual Studio. يتوجب عليك، حتى تتمكن من استخدامها أن يكون لديك الإصدار 4. 0 أو أحدث.

قواعد افتراضية

تمثل المجموعة الافتراضية لقواعد لينتر، الحد الأدنى، والتي اتخذت منحالات اختبار arm-ttk. يفحص الملحق وBicep CLI القواعد التالية، والتي تم تعيينها من أجل مستوى التحذير.

• لا ينبغي أن يكوناسم المستخدم المسؤول ذي قيمة حرفية
• معلمات البيانات الاصطناعية
• إلغاء التحويل البرمجي للتنظيف
• قيم صريحة ل loc-params
• الحد الأقصى للتأكيدات
• الحد الأقصى من المخرجات
• الحد الأقصى من المعلمات
• الحد الأقصى من الموارد
• الحد الأقصى من المتغيرات
• نطاق قالب التوزيع المتداخل
• بيانات التعريف غير المتعارضة
• عدم التوزيع-الموارد
• no-hardcoded-env-urls
• موقع بدون ترميز ثابت
• no-loc-expr-outside-params
• no-unnecessary-dependson
• no-unused-existing-resources
• no-unused-params
• لا توجد متغيرات غير مُستخدمة
• يجب ألا تحتوي المخرجات على بيانات سرية
• تفضيل الاستنتاج
• prefer-unquoted-property-names
• محددات افتراضية آمنة
• secure-params-in-nested-deploy
• secure-secrets-in-params
• تبسيط الاستنتاج
• تبسيط-json-null
• خاصية استخدام الأصل
• استخدام protectedSettings لأسرار commandtoexecute
• استخدام أحدث إصدارات واجهة برمجة التطبيقات
• استخدام أحدث إصدارات الوحدة النمطية
• use-resource-id-functions
• use-resource-symbol-reference
• استخدام الوصول الآمن
• استخدام-تأمين القيمة مقابل المدخلات الآمنة
• use-stable-resource-identifiers
• استخدام نُسخ جهاز ظاهري مستقرة
• دائرة ماذا لو قصيرة

يمكنك تخصيص كيفية تطبيق قواعد لينتر. للكتابة فوق الإعدادات الافتراضية، قم بإضافة ملفbicepconfig.jsonوتطبيق إعدادات مخصصة. للمزيد من المعلومات حول تطبيق هذه الإعدادات، يرجى مراجعةإضافة إعدادات مخصصة في ملف تكوينBicep.

قم باستخدام التعليمات البرمجية الخاصة بـVisual Studio

تُظهر لقطة الشاشة التالية لينتر في التعليمة البرمجية الخاصة بـVisual Studio:

في جزءالمشاكل،يوجد أربعة أخطاء وتحذير واحد ورسالة معلومات واحدة والموضحين في لقطة الشاشة. تُظهر رسالة المعلومات ملف تكوين Bicep المستخدم. تُظهر هذا الجزء من المعلومات فقط عند تعيينمطوللـصحيحفي ملف التكوين.

مرر ”مؤشر الماوس“ إلى إحدى مساحات المشكلة. يعطي لينتر التفاصيل حول الخطأ أو التحذير. حدد ”المساحة“، كما يُظهر مصباح أزرق:

حدد إما «المصباح الأزرق» أو ارتباط «التصحيح السريع»لمعرفة الحل:

حدد الحل لإصلاح المشكلة تلقائيا.

استخدام ”Bicep CLI“

تظهر لقطة الشاشة التالية لينتر في سطر الأوامر. يظهر الإخراج من الأمر lint وأمر الإنشاء أي انتهاكات للقاعدة.

يمكنك دمج هذه الفحوصات كجزء من النية الأساسية لبرنامج ربط العمليات التجارية CI/CD. يمكنك استخدام إجراء GitHub لمحاولة تحديث إصدار bicep. تقوم الأخطاء بإفشال البنية الأساسية لبرنامج ربط العمليات التجارية.

قمع النتائج الإيجابية الكاذبة

في بعض الأحيان يمكن أن يكون للقاعدة إيجابيات خاطئة. على سبيل المثال، قد تحتاج إلى تضمين ارتباط إلى تخزين كائن ثنائي كبير الحجم مباشرة دون استخدام الدالة environment(). في هذه الحالة، يمكنك تعطيل التحذير لخط واحد فقط، وليس المستند بأكمله، عن طريق إضافة #disable-next-line <rule name> قبل السطر مع التحذير.

#disable-next-line no-hardcoded-env-urls //Direct download link to my toolset
scriptDownloadUrl: 'https://mytools.blob.core.windows.net/...'

يُفضل إضافة تعليق يوضح سبب عدم تطبيق القاعدة على هذا السطر.

إذا كنت ترغب في منع قاعدة linter، يمكنك تغيير مستوى القاعدة إلى Off في bicepconfig.json. على سبيل المثال، في المثال التالي، no-deployments-reesources يتم منع القاعدة:

{
  "analyzers": {
    "core": {
      "rules": {
        "no-deployments-resources": {
          "level": "off"
        }
      }
    }
  }
}

الخطوات التالية

• للمزيد من المعلومات حول تخصيص قواعد لينتر، يرجى مراجعةإضافة إعدادات مخصصة في ملف تكوين Bicep.
• للحصول على مزيدٍ من المعلومات حول استخدام Visual Studio Code وامتداد Bicep، راجع التشغيل السريع: إنشاء ملفات Bicep باستخدام Visual Studio Code.