service

لا يحق لك المرور

ما هذا؟

YouShallNotpass هو المحلل الثابت للرمز الأنيق الخاص بك.

كيف يعمل؟

فقط انظر ، ما يمكن أن يجده في الكود المعتاد على ما يبدو:

 package com . example ;

import java . util . Collection ;
import java . util . StringTokenizer ;

public class Words {
    public static final String DELIM = " ,." ;

    private Collection < String > words ;

    public Words () {
        this . words = null ;
    }

    public Words ( Collection < String > words ) {
        this . words = words ;
    }

    boolean containsIn ( String text ) {
        if ( words == null ) return false ;

        StringTokenizer tokenizer = new StringTokenizer ( text , DELIM );
        while ( tokenizer . hasMoreTokens ()) {
            String nextWord = tokenizer . nextToken ();
            if ( words . contains ( nextWord )) return true ;
        }

        return false ;
    }
}

انتهاكات تحليل youshallnotpass :

 nullfree
com.example.Words(Words.java:12) > null
com.example.Words.containsIn(Words.java:20) > null

staticfree
com.example.A.main(A.java:6) > static 
com.example.Words(Words.java:7) > static 

allfinal
com.example.A.main(A.java:6) > String[] args
com.example.A(A.java:5) > A
com.example.Words(Words.java:9) > words
com.example.Words.containsIn(Words.java:22) > StringTokenizer tokenizer = new StringTokenizer(text, DELIM)
com.example.Words.containsIn(Words.java:24) > String nextWord = tokenizer.nextToken()
com.example.Words(Words.java:15) > Collection<String> words
com.example.Words.containsIn(Words.java:19) > String text
com.example.Words(Words.java:6) > Words

allpublic
com.example.Words.containsIn(Words.java:19)

nomultiplereturn
com.example.Words.containsIn(Words.java:19)

ابدأ

Gradle

أضف البرنامج المساعد إلى Root build.gradle

plugins {
    id ' dev.youshallnotpass ' version ' x.y.z '
}

// then configure it, if you need:
youshallnotpass {
    offline = true // default false
    nullfree {
        disabled = true // default false
        threshold = 3 // default 0
        skipComparisons = true // default false
    }
    staticfree {
        disabled = true // default false
        threshold = 2 // default 0
    }
    allfinal {
        disabled = true // default false
        threshold = 1 // default 0
        skipInterfaceMethodParams = false // default true
        skipLambdaParams = true // default false
        skipCatchParams = true // default false
    }
    allpublic {
        disabled = true // default false
        threshold = 4 // default 0
    } 
    setterfree {
        disabled = true // default false
        threshold = 5 // default 0
    }
    nomultiplereturn {
        disabled = true // default false
        threshold = 6 // default 0
    }
    inheritancefree {
        disabled = true // default false
        threshold = 7 // default 0
    }
}

حيث xyz هو الإصدار الفعلي من Gradle Plugins

استدعاءها:

./gradlew youshallnotpass

مافن

أضف البرنامج المساعد إلى pom.xml

< plugin >
  < groupId >dev.youshallnotpass</ groupId >
  < artifactId >youshallnotpass-maven-plugin</ artifactId >
  < version >x.y.z</ version >

  <!-- then configure it, if you need: -->
  < configuration >
    < offline >true</ offline > <!-- default false -->
    < nullfree >
      < disabled >true</ disabled > <!-- default false -->
      < threshold >3</ threshold > <!-- default 0 -->
      < skipComparisons >true</ skipComparisons > <!-- default false -->
    </ nullfree >
    < staticfree >
      < disabled >true</ disabled > <!-- default false -->
      < threshold >2</ threshold > <!-- default 0 -->
    </ staticfree >
    < allfinal >
      < disabled >true</ disabled > <!-- default false -->
      < threshold >1</ threshold > <!-- default 0 -->
      < skipInterfaceMethodParams >false</ skipInterfaceMethodParams > <!-- default true -->
      < skipLambdaParams >true</ skipLambdaParams > <!-- default false -->
      < skipCatchParams >true</ skipCatchParams > <!-- default false -->
    </ allfinal >
    < allpublic >
      < disabled >true</ disabled > <!-- default false -->
      < threshold >4</ threshold > <!-- default 0 -->
    </ allpublic >
    < setterfree >
      < disabled >true</ disabled > <!-- default false -->
      < threshold >5</ threshold > <!-- default 0 -->
    </ setterfree >
    < nomultiplereturn >
      < disabled >true</ disabled > <!-- default false -->
      < threshold >6</ threshold > <!-- default 0 -->
    </ nomultiplereturn >
    < inheritancefree >
      < disabled >true</ disabled > <!-- default false -->
      < threshold >7</ threshold > <!-- default 0 -->
    </ inheritancefree >
  </ configuration >
</ plugin >

استدعاءها:

mvn youshallnotpass:youshallnotpass

حيث xyz هي النسخة الفعلية من Maven Central

عمليات التفتيش

1. ✅ nullfree (لماذا null سيئة؟) يجب ألا تستخدم الكود الأنيق الكلمات الرئيسية null

2. ✅ staticfree (لماذا static سيئة؟) يجب ألا يستخدم الكود الأنيق الكلمات الرئيسية static

3. ✅ Allfinal كل فئة ، كل حقل ، كل حجة ، يجب أن يكون كل متغير محلي final في الكود الأنيق

4. Offection [in progress] لا يجب أن يستخدم الرمز الأنيق الكلمات instanceof

5. ✅ يجب ألا يستخدم الرمز الأنيق المورث في الفئة الوراثة (عندما extends فئة واحدة أخرى) ، تم السماح فقط بتكوين وميراث نوع

6. enumfree [in progress] يجب ألا يستخدم الرمز الأنيق enum s

7. SwitchFree [in progress] لا يجب أن يستخدم التعليمات البرمجية الأنيقة كتل/تعبيرات switch

8. ✅ يجب أن يحتوي رمز Nomultiplereturn على عودة واحدة (أو لا أحد) فقط في أي طريقة

9. getterfree [in progress] يجب ألا يحتوي الكود الأنيق على أي getters

10. ✅ يجب ألا يحتوي الكود الأنيق Setterfree

11. ✅ يجب أن يستخدم الرمز الأنيق Allpublic الأساليب public فقط

12. NopublicMethodNotoverrides [in progress] يجب أن يتم تجاوز كل طريقة عامة في الكود الأنيق من واجهة

nullfree

خيارات تكوين البرنامج المساعد:

• يتيح skipComparisons استخدام null في تعبيرات منطقية:

 if ( some == null ) {
    ...
}

يمكن قمعها في الكود بواسطة @SuppressWarnings("nullfree")

staticfree

يمكن قمعها في الكود بواسطة @SuppressWarnings("staticfree")

allfinal

خيارات تكوين البرنامج المساعد:

• يتيح skipInterfaceMethodParams تقييد أو عدم معلمة طريقة الواجهة final ، افتراضيًا ، لا يوجد حاجة لتعيين final لمثل هذه الأماكن
• يسمح skipLambdaParams بالتخطي final في معلمات Lambda ، بشكل افتراضي معلمة Lambda يجب أن تكون final
• يسمح skipCatchParams بتخطي final في معلمات catch ، ويجب أن تكون معلمة catch الافتراضية final

يمكن قمعها في الكود بواسطة @SuppressWarnings("allfinal")

Allpublic

يمكن قمعها في الكود بواسطة @SuppressWarnings("allpublic")

setterfree

يمكن قمعها في الكود بواسطة @SuppressWarnings("setterfree")

nomultiplereturn

يمكن قمعها في الكود بواسطة @SuppressWarnings("nomultiplereturn")

وراثي

يمكن قمعها في الكود بواسطة @SuppressWarnings("inheritancefree")

شارات

إذا كنت تستخدم البرنامج المساعد youshallnotpass بدون وضع offline = true ، فيمكنك إرفاق شارات التفتيش بملف readme الخاص بك:

• ![nullfree status](https://youshallnotpass.dev/nullfree/<user>/<repo>)
• ![staticfree status](https://youshallnotpass.dev/staticfree/<user>/<repo>)
• ![allfinal status](https://youshallnotpass.dev/allfinal/<user>/<repo>)
• ![allpublic status](https://youshallnotpass.dev/allpublic/<user>/<repo>)
• ![setterfree status](https://youshallnotpass.dev/setterfree/<user>/<repo>)
• ![nomultiplereturn status](https://youshallnotpass.dev/nomultiplereturn/<user>/<repo>)
• ![inheritancefree status](https://youshallnotpass.dev/inheritancefree/<user>/<repo>)

عتبة التفتيش

يمكن تكوين أي تفتيش مع threshold :

في gradle

youshallnotpass {
    .. .
    staticfree {
        threshold = 19
    }
    .. .
}

في maven

< configuration >
  < staticfree >
    < threshold >19</ threshold >
  </ staticfree >
</ configuration >

تعطيل عمليات التفتيش

يمكن تعطيل أي تفتيش عن طريق الإعدادات disabled :

في gradle

youshallnotpass {
    .. .
    staticfree {
        disabled = true
    }
    .. .
}

في maven

< configuration >
  < staticfree >
    < disabled >true</ disabled >
  </ staticfree >
</ configuration >

يتم تمكين جميع عمليات التفتيش بشكل افتراضي.

استبعاد الملفات من التفتيش

هناك إعدادات exclude عالمية ، والتي يمكن استخدامها لتحديد الأنماط المستبعدة: في gradle

youshallnotpass {
    exclude = [ " glob:**/test/**/*Test.java " ]
}

في maven

< configuration >
  < exclude >glob:**/test/**/*Test.java</ exclude >
</ configuration >

هناك خيار تكوين التفتيش المحلي ، والذي له أولوية أعلى من تكوين Global Explude:

في gradle

nullfree {
    exclude = [ " glob:**/*SomeBadFile.java " ]
}

في maven

< nullfree >
  < exclude >glob:**/*SomeBadFile.java</ exclude >
</ nullfree >

رخصة

معهد ماساتشوستس للتكنولوجيا