service

Youghallnotpass

Apa itu?

YouShallnotpass adalah penganalisa statis untuk kode elegan Anda.

Bagaimana cara kerjanya?

Lihat saja, apa yang dapat ditemukan dalam kode yang tampaknya biasa:

 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 ;
    }
}

Pelanggaran analisis 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)

Mulai

Lulusan

Tambahkan plugin ke 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
    }
}

Dimana xyz adalah versi aktual dari plugin lulusan

Memohonnya:

./gradlew youshallnotpass

Maven

Tambahkan plugin ke 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 >

Memohonnya:

mvn youshallnotpass:youshallnotpass

Di mana xyz adalah versi aktual dari maven central

Inspeksi

1. ✅ nullfree (mengapa null itu buruk?) Kode elegan tidak boleh menggunakan kata kunci null

2. ✅ StaticFree (mengapa static itu buruk?) Kode elegan tidak boleh menggunakan kata kunci static

3. ✅ all -final setiap kelas, setiap bidang, setiap argumen, setiap variabel lokal harus final dalam kode elegan

4. Instance Offree [in progress] Kode elegan tidak boleh menggunakan kata kunci instanceof dari kata kunci

5. ✅ Kode elegan warisan yang tidak boleh menggunakan warisan kelas (ketika satu kelas extends yang lain), hanya komposisi dan jenis pewarisan yang diizinkan

6. enumfree [in progress] Kode elegan tidak boleh menggunakan enum s

7. switchfree [in progress] Kode elegan tidak boleh menggunakan blok/ekspresi switch

8. ✅ NomultiPlereturn kode elegan harus berisi hanya satu (atau tidak ada) pengembalian dalam metode apa pun

9. getterfree [in progress] Kode elegan tidak boleh mengandung getters apa pun

10. ✅ Kode elegan setterfree tidak boleh mengandung setter

11. ✅ Kode elegan AllPublic hanya harus menggunakan metode public

12. nopublicmethodnotoverrides [in progress] Setiap metode publik dalam kode elegan harus ditinggalkan dari antarmuka

Nullfree

Opsi Konfigurasi Plugin:

• skipComparisons memungkinkan penggunaan null dalam ekspresi boolean:

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

Dapat ditekan dalam kode oleh @SuppressWarnings("nullfree")

Bebas statis

Dapat ditekan dalam kode oleh @SuppressWarnings("staticfree")

Allfinal

Opsi Konfigurasi Plugin:

• skipInterfaceMethodParams memungkinkan parameter metode pembatasan atau tidak, parameter final , secara default tidak perlu mengatur final untuk tempat -tempat seperti itu
• skipLambdaParams memungkinkan skip final dalam parameter lambda, secara default parameter lambda harus final
• skipCatchParams memungkinkan skip final dalam parameter catch , secara parameter catch default harus final

Dapat ditekan dalam kode oleh @SuppressWarnings("allfinal")

Allpublic

Dapat ditekan dalam kode oleh @SuppressWarnings("allpublic")

Setterfree

Dapat ditekan dalam kode oleh @SuppressWarnings("setterfree")

NomultiPlereturn

Dapat ditekan dalam kode oleh @SuppressWarnings("nomultiplereturn")

Warisan bebas

Dapat ditekan dalam kode oleh @SuppressWarnings("inheritancefree")

Lencana

Jika Anda menggunakan plugin YouShallNotPass tanpa offline = true , maka Anda dapat melampirkan lencana inspeksi ke file ReadMe Anda:

• ![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>)

Ambang batas inspeksi

Inspeksi apa pun dapat dikonfigurasi dengan threshold :

Di gradle

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

Di maven

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

Menonaktifkan inspeksi

Inspeksi apa pun dapat dinonaktifkan dengan pengaturan disabled :

Di gradle

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

Di maven

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

Semua inspeksi diaktifkan secara default.

Tidak termasuk file dari pemeriksaan

Ada Pengaturan Global exclude , yang dapat digunakan untuk mendefinisikan Pola Kecuali: di gradle

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

Di maven

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

Ada opsi Inspeksi Lokal Kecuali Konfigurasi, yang memiliki prioritas lebih tinggi daripada konfigurasi Global Exclude:

Di gradle

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

Di maven

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

Lisensi

Mit