clueless-skywatcher/lentil

Lentil - A simple static code analyzer for Java, in Java

lentil's Issues

N0002: Implement check for underscored names in classes, fields and variables

This checker will check for every instance where underscores are being used. This will check

• Class names
• Variable names

Constants, i.e. final static fields of a class, and enum fields will be ignored here.

int abc_def = 5; // Violation
int abcDef = 5; // OK
class XYZ_Name // Violation
class XYZName // OK
final static int ABC_DEF = 5 // OK
enum AbcDef { FIELD_1, // OK FIELD_2 // OK }

Add README.md

Make LentilMain run in a command line

Checker: BP0001 - Check whether a Boolean-returning function is returning null

Category: Bad Practice (BP)
Issue Code: BP0001

Description: Checks whether methods in the code that return booleans are returning null instead.

Examples:

public class BooleanReturnNullExample {
    public boolean abcd(){
        System.out.println("Not okay");
        if (1 == 1){
            return true;
        } else {
            return null;
        }
    }

    public Boolean abcd2(){
        System.out.println("Not okay");
        if (1 == 2){
            return true;
        } else {
            return null;
        }
    }

    public boolean defg(){
        System.out.println("Okay");
        return true;
    }
}

This code will cause issues to be raised at lines 7 and 16.

Checker: A0001 - Check whether annotations are on different lines

Check code: A0001

Check description:

Whenever a variable, class or method is declared with an annotation, check whether the annotations not on the same line as their targets.

Example:

import javax.annotation.Nullable;

@SuppressWarnings(value = "abcd") // OK
public class AnnotationExample {
    @Deprecated public void abcd(){ // Violation
        @Nullable // OK
        String anno;
        
        @Nullable int abc; // Violation
    }

    @Deprecated // OK
    public void abcd2(@Nullable String xyz){ // Still ok since it is a param annotation
    }
}

@SuppressWarnings(value = "abcd") class ABCD {

}