FoodPal/checkstyle.xml at main · 100xANDREIx100/FoodPal · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
        "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
        "https://checkstyle.org/dtds/configuration_1_3.dtd">

<!--
   Specific code style file created for the CESP course (CSE1105) at Delft University of Technology
   Authors: Andrei Radu, Anando Hirschau, Szymon Strzalek, Eliott Duparc, Arthur Bakker, Jakub Pieczonka
-->


<module name="Checker">

    <property name="fileExtensions" value="java"/>
    <module name="BeforeExecutionExclusionFileFilter">
        <property name="fileNamePattern" value=".*Test\.java$"/>
    </module>

    <module name="TreeWalker">
        <module name="MissingJavadocMethod">
            <property name="severity" value="error"/>
            <property name="allowMissingPropertyJavadoc" value="true" />
            <property name="scope" value="private"/>
            <property name="tokens" value="METHOD_DEF, CTOR_DEF, COMPACT_CTOR_DEF"/>
        </module>
        <module name="JavadocMethod">
            <property name="severity" value="warning"/>
            <property name="accessModifiers" value="private"/>
            <property name="allowedAnnotations" value="Override" />
            <property name="allowMissingParamTags" value="false"/>
            <property name="allowMissingReturnTag" value="false"/>
        </module>
        <module name="JavadocStyle">
            <property name="checkEmptyJavadoc" value="true" />
            <property name="checkFirstSentence" value="false" />
        </module>
        <module name="NonEmptyAtclauseDescription" >
            <property name="javadocTokens" value="PARAM_LITERAL,THROWS_LITERAL,RETURN_LITERAL"/>
        </module>
        <module name="MethodLength">
            <property name="severity" value="warning"/>
            <property name="tokens" value="METHOD_DEF, CTOR_DEF, COMPACT_CTOR_DEF"/>
            <property name="max" value="75"/>
        </module>
        <module name="MethodLength">
            <property name="severity" value="error"/>
            <property name="tokens" value="METHOD_DEF, CTOR_DEF, COMPACT_CTOR_DEF"/>
            <property name="max" value="100"/>
        </module>
        <module name="VisibilityModifier">
            <property name="severity" value="warning"/>
            <property name="protectedAllowed" value="true"/>
        </module>

        <module name="OuterTypeFilename">
            <property name="severity" value="warning"/>
        </module>
        <module name="ParameterNumber">
            <property name="severity" value="error"/>
            <property name="tokens" value="METHOD_DEF, CTOR_DEF"/>
            <property name="max" value="10"/>
        </module>
        <module name="ParameterNumber">
            <property name="severity" value="warning"/>
            <property name="tokens" value="METHOD_DEF, CTOR_DEF"/>
            <property name="max" value="7"/>
        </module>
        <module name="CyclomaticComplexity">
            <property name="severity" value="error"/>
            <property name="switchBlockAsSingleDecisionPoint" value="true"/>
            <property name="max" value="12"/>
            <property name="tokens" value="LITERAL_WHILE, LITERAL_DO, LITERAL_FOR, LITERAL_IF, LITERAL_SWITCH, LITERAL_CASE, QUESTION"/>
        </module>
        <module name="CyclomaticComplexity">
            <property name="severity" value="warning"/>
            <property name="switchBlockAsSingleDecisionPoint" value="true"/>
            <property name="max" value="8"/>
            <property name="tokens" value="LITERAL_WHILE, LITERAL_DO, LITERAL_FOR, LITERAL_IF, LITERAL_SWITCH, LITERAL_CASE, QUESTION"/>
        </module>

        <module name="Indentation">
            <property name="severity" value="warning"/>
        </module>
        <module name="UnusedImports">
            <property name="severity" value="warning"/>
        </module>

        <module name="MemberName">
            <property name="severity" value="warning"/>
        </module>
        <module name="MethodName">
            <property name="severity" value="warning"/>
        </module>
        <module name="ParameterName">
            <property name="severity" value="warning"/>
        </module>
        <module name="LocalVariableName">
            <property name="severity" value="warning"/>
        </module>
        <module name="StaticVariableName">
            <property name="severity" value="warning"/>
        </module>
        <module name="LambdaParameterName">
            <property name="severity" value="warning"/>
        </module>
        <module name="TypeName">
            <property name="severity" value="warning"/>
        </module>
        <module name="SuppressWarnings"/>
        <module name="ClassTypeParameterName">
            <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*$)"/>
            <message key="name.invalidPattern"
                     value="Class type name ''{0}'' must match pattern ''{1}''."/>
        </module>
    </module>
    <module name="LineLength">
        <property name="severity" value="error"/>
        <property name="fileExtensions" value="java"/>
        <property name="max" value="200"/>
        <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
    </module>
    <module name="LineLength">
        <property name="severity" value="warning"/>
        <property name="fileExtensions" value="java"/>
        <property name="max" value="100"/>
        <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
    </module>
</module>