service

Você não deve passar

O que é?

YouShallnotPass é o analisador estático do seu código elegante.

Como funciona?

Apenas veja, o que pode encontrar no código aparentemente usual:

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

As violações da análise 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)

Comece

Gradle

Adicione o plug -in à build.gradle da raiz.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
    }
}

Onde xyz é versão real de plugins gradle

Invocar:

./gradlew youshallnotpass

Maven

Adicione o plugin ao 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 >

Invocar:

mvn youshallnotpass:youshallnotpass

Onde xyz é versão real do Maven Central

Inspeções

1. ✅ Nullfree (por que null é ruim?) Código elegante não deve usar as palavras -chave null

2. ✅ StaticFree (por que static é ruim?) Código elegante não deve usar as palavras -chave static

3. ✅ Allfinal todas as aulas, todos os campos, todos os argumentos, toda variável local deve ser final no Código Elegante

4. Código elegante do ExtemewOffree [in progress] não deve usar as palavras -chave instanceof

5. ✅ Código elegante da herança não deve usar a herança da classe (quando uma classe extends por outra), apenas composição e tipo de herança foram permitidos

6. Enumfree [in progress] Código elegante não deve usar o enum s

7. SwitchFree [in progress] Código elegante não deve usar os blocos/expressões switch

8. ✅ Nomultipleretern Código elegante deve conter apenas um (ou nenhum) retornar em um método

9. GetterFree [in progress] Código elegante não deve conter nenhum getters

10. ✅ Código elegante do SetterFree não deve conter nenhum setters

11. ✅ Código elegante da AllPublic deve usar apenas métodos public

12. NopublicmethodnoToTrides [in progress] Todo método público no Código Elegante deve ser substituído de uma interface

Nullfree

Opções de configuração do plug -in:

• skipComparisons permite usar null em expressões booleanas:

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

Pode ser suprimido no código por @SuppressWarnings("nullfree")

StaticFree

Pode ser suprimido no código por @SuppressWarnings("staticfree")

AllFinal

Opções de configuração do plug -in:

• skipInterfaceMethodParams permite restringir ou não o final do método de interface, por padrão, não é necessário definir final para esses lugares
• skipLambdaParams permite pular final nos parâmetros Lambda, por padrão o parâmetro Lambda precisa ser final
• skipCatchParams permite o pular final nos parâmetros catch , por padrão, o parâmetro catch precisa ser final

Pode ser suprimido no código por @SuppressWarnings("allfinal")

AllPublic

Pode ser suprimido no código por @SuppressWarnings("allpublic")

SetterFree

Pode ser suprimido no código por @SuppressWarnings("setterfree")

Nomultipleretern

Pode ser suprimido no código por @SuppressWarnings("nomultiplereturn")

Herança livre

Pode ser suprimido no código por @SuppressWarnings("inheritancefree")

Crachás

Se você usar o plug -in do YouShallNotPass sem offline = true , poderá anexar os crachás de inspeção ao seu arquivo 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>)

Limiar de inspeção

Qualquer inspeção pode ser configurada com threshold :

Em gradle

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

Em maven

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

Incapacitante inspeções

Qualquer inspeção pode ser desativada por configurações disabled :

Em gradle

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

Em maven

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

Todas as inspeções são ativadas por padrão.

Excluindo arquivos de inspecionados

Existem configurações exclude global, que podem ser usadas para definir padrões de exclusão: em gradle

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

Em maven

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

Existe uma opção de configuração de exclusão local de inspeção, que tem maior prioridade que a configuração de exclusão global:

Em gradle

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

Em maven

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

Licença

Mit