[مهمل] إضافة التحليل الثابت لـ Gradle

⚠️ يتم صيانة نسخة متفرعة من هذا المشروع على https://github.com/GradleUp/static-analysis-plugin/ يرجى الترحيل باستخدام معرف الإضافة com.gradleup.static-analysis بدلاً من ذلك.

إضافة Gradel لتطبيق نفس إعدادات أدوات التحليل الثابت بسهولة عبر مشاريع Android أو Java أو Kotlin المختلفة.

تدعم تجنب تكوين المهام بحيث لا يكون لديك أي حمل زائد في سرعة البناء عند استخدام هذه الإضافة!

الوصف

يدعم Gradel العديد من أدوات التحليل الثابت الشائعة (Checkstyle، PMD، FindBugs، إلخ) عبر مجموعة من الإضافات المدمجة. يتطلب استخدام هذه الإضافات في وحدة Android إعدادًا إضافيًا للتعويض عن الاختلافات بين النموذج الذي تتبعه إضافة Android مقارنةً بنموذج Java.

تهدف إضافة gradle-static-analysis-plugin إلى توفير:

• استراتيجية عقوبات مرنة وقابلة للتكوين للبناء
• تكامل سهل وصديق لـ Android لجميع التحليلات الثابتة
• طريقة مناسبة لمشاركة نفس الإعداد عبر مشاريع مختلفة
• إعدادات افتراضية جيدة، قابلة للإصدار والتكوين

الأدوات المدعومة

تدعم الإضافة أدوات تحليل ثابت متنوعة لمشاريع Java وKotlin وAndroid:

• Checkstyle
• PMD
• FindBugs [مهمل] [تمت إزالته في Gradle 6.0]
• SpotBugs
• Detekt
• Android Lint
• KtLint

يرجى ملاحظة أن توفر الأدوات يعتمد على المشروع الذي تُطبق عليه الإضافة. لمزيد من التفاصيل، يُرجى الرجوع إلى صفحة الأدوات المدعومة.

الأدوات قيد الدراسة

• CPD (Duplicate Code Detection) #150
• error-prone #151
• Jetbrains IDEA Inspections #152

لجميع الأدوات قيد الدراسة، يُرجى الرجوع إلى المشكلات.

دعم جاهز لمشاريع Android

تستخدم مشاريع Android نموذج Gradel غير متوافق مع نموذج Java الذي تدعمه إضافات أدوات التحليل الثابت المدمجة. سيؤدي تطبيق gradle-static-analysis-plugin على مشروع Android الخاص بك إلى ضمان إنشاء جميع المهام الضرورية وتكوينها بشكل صحيح دون أي متاعب إضافية.

إضافة الإضافة إلى مشروعك

قم بتطبيق الإضافة من jCenter كتبعية classpath

buildscript {
    repositories {
       jcenter()
    }
    dependencies {
        classpath 'com.novoda:gradle-static-analysis-plugin:1.2'
    }
}

apply plugin: 'com.novoda.static-analysis'

أو من مستودع إضافات Gradle:

plugins {
    id 'com.novoda.static-analysis' version '1.2'
}

استخدام بسيط

سيبدو التكوين النموذجي للإضافة كما يلي:

staticAnalysis {
    penalty {
        maxErrors = 0
        maxWarnings = 0
    }
    checkstyle { }
    pmd { }
    findbugs { }
    spotbugs { }
    detekt { }
    lintOptions { }
}

سيؤدي ذلك إلى تمكين جميع الأدوات بإعداداتها الافتراضية وإنشاء مهمة evaluateViolations. سيؤدي تشغيل مهمة ./gradlew evaluateViolations إلى تشغيل جميع الأدوات المكونة وطباعة التقارير إلى وحدة التحكم. لمزيد من التكوينات المتقدمة، يُرجى الرجوع إلى صفحات الاستخدام المتقدم والأدوات المدعومة.

تطبيق نموذجي

يتوفر مشروعان نموذجيان لـ Android، أحدهما يتكون من تطبيق عادي - متاح هنا - والآخر يتضمن إعدادًا متعدد الوحدات متاح هنا. يعرض كلا المشروعين النموذجيين إعدادًا يضم Checkstyle وFindBugs وSpotBugs وPMD وLint وKtlint وDetekt.

اللقطات

يتم نشر إصدارات اللقطات من develop تلقائيًا إلى مستودع غير متزامن مع JCenter. لاستهلاك إصدار لقطة، أضف مستودع maven إضافي كالتالي:

repositories {
    maven {
        url 'https://dl.bintray.com/novoda-oss/snapshots/'
    }
}

يمكنك العثور على أحدث إصدار لقطة باتباع هذا الرابط.

خريطة الطريق

يستخدم هذا المشروع بشكل روتيني من قبل العديد من مشاريع Novoda ومن قبل مشاريع خارجية أخرى دون مشكلات حرجة معروفة.

يمكن العثور على التحسينات المستقبلية وتكاملات الأدوات الجديدة في متتبع المشكلات الخاص بالمستودع.