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)

Начните

Градл

Добавить плагин в корневую 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

Вызвать это:

./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. exactionOffree [in progress] Элегантный код не должен использовать instanceof ключевых слов

5. ✅ Наследственное, без элегантного кода, не должен использовать наследование класса (когда один класс extends еще один), разрешено только наследство состава и типа

6. enumfree [in progress] элегантный код не должен использовать enum

7. SwitchFree [in progress] Элегантный код не должен использовать блоки/выражения switch

8. ✅ nomultiplereturn Элегантный код должен содержать только один (или никто) возвращать в любом методе

9. getterFree [in progress] Элегантный код не должен содержать никаких геттеров

10. ✅ SetterFree Элегантный код не должен содержать никаких сеттеров

11. ✅ Allpublic Elegant Code должен использовать только public методы

12. nopublicmethodnotoverrides [in progress] Каждый публичный метод в элегантном коде должен быть переведен из интерфейса

Nullfree

Параметры конфигурации плагина:

• skipComparisons позволяет использовать null в логических выражениях:

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

Может быть подавлен в коде @SuppressWarnings("nullfree")

Staticfree

Может быть подавлен в коде @SuppressWarnings("staticfree")

Allfinal

Параметры конфигурации плагина:

• skipInterfaceMethodParams позволяет ограничивать или нет параметры метода интерфейса final s, по умолчанию нет необходимости установить final для таких мест
• skipLambdaParams позволяет Skip final в параметрах Lambda, по умолчанию параметр Lambda должен быть final
• skipCatchParams позволяет Skip 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 >

Существует проверка локальная опция конфигурации, которая имеет более высокий приоритет, чем глобальная конфигурация исключения:

В gradle

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

В maven

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

Лицензия

Грань