shell linter

شل لينتر

إجراء github الذي يؤدي تحليلًا ثابتًا لنصوص الصدفة باستخدام shellcheck.

الاستخدام

يمكن أن تقوم شل لينتر بإجراء تحليل ثابت بطرق مختلفة. بشكل افتراضي ، يقوم بمسح جميع البرامج النصية Shellcheck المدعومة من shellcheck (SH/Bash/Dash/KSH) في مشروعك. ومع ذلك ، يمكنك استخدام معلمة path لمسح ملف أو مجلد معين أو استخدام معلمة exclude-paths لاستبعاد الملفات أو المجلدات من الفحص. باستخدام شل Linter ، يمكنك أيضًا تحديد الحد الأدنى من شدة الأخطاء للنظر في استخدام معلمة severity . ويرد أدناه حالات استخدام محددة مع أمثلة:

قم بتشغيل تحليل ثابت لجميع البرامج النصية المدعومة من الصدفة في مستودعك:

 jobs :
  lint :
    runs-on : ubuntu-latest
    steps :
      - name : Checkout code
        uses : actions/checkout@v1
      - name : Run ShellCheck
        uses : azohra/shell-linter@latest 

قم بتشغيل تحليل ثابت لنص shell واحد:

      - name : Run ShellCheck
        uses : azohra/shell-linter@latest
        with :
          path : " setup.sh " 

قم بتشغيل تحليل ثابت لبرامج النصوص المتعددة مع أو بدون تمديد:

      - name : Run ShellCheck
        uses : azohra/shell-linter@latest
        with :
          path : " setup,deploy.sh " 

قم بتشغيل تحليل ثابت لجميع البرامج النصية للقذيفة في مجلد:

      - name : Run ShellCheck
        uses : azohra/shell-linter@latest
        with :
          path : " src " 

قم بتشغيل تحليل ثابت باستخدام مسار البطاقة البرية :

      - name : Run ShellCheck
        uses : azohra/shell-linter@latest
        with :
          path : " src/*.sh " 

استبعاد الملفات والمجلدات من التحليل الثابت:

      - name : Run ShellCheck
        uses : azohra/shell-linter@latest
        with :
          exclude-paths : " src/setup.sh,tests/unit_tests " 

لاحظ أن exclude-paths يقبل فقط المسارات المتعلقة بالدليل الجذر لمشروعك. ومع ذلك ، لا تشمل ./ في بداية المسارات.

لاستبعاد المجلد والمحتوى بشكل متكرر فقط توفير مسار المجلد بدون A / في النهاية. في المثال أعلاه ، سيتم استبعاد المجلد بأكمله في tests/unit_tests من Linting.

قم بتشغيل تحليل ثابت لجميع البرامج النصية Shell ومرضًا فقط مع شدة الخطأ:

      - name : Run ShellCheck
        uses : azohra/shell-linter@latest
        with :
          path : " src/*.sh "
          severity : " error " 

تشغيل التحليل باستخدام نسخة محددة من شل Linter:

      - name : Run ShellCheck
        uses : azohra/[email protected]

مدخل

path

خياري. تنفيذ LINT تحقق على ملف أو مجلد معين. تقصير: .

exclude-paths

خياري. استبعاد الملفات والمجلدات من SHELLCHECK SCAN.

severity

خياري. حدد الحد الأدنى من شدة الأخطاء التي يجب مراعاتها [النمط ، المعلومات ، التحذير ، الخطأ]. الافتراضي: style

رخصة

هذا البرنامج متاح كمصدر مفتوح بموجب شروط ترخيص معهد ماساتشوستس للتكنولوجيا.