-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcheckstyle.xml
More file actions
120 lines (105 loc) · 3.97 KB
/
checkstyle.xml
File metadata and controls
120 lines (105 loc) · 3.97 KB
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
<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
"-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
"https://checkstyle.org/dtds/configuration_1_3.dtd">
<module name="Checker">
<property name="charset" value="UTF-8"/>
<property name="severity" value="warning"/>
<property name="fileExtensions" value="java"/>
<!-- === Filters === -->
<module name="BeforeExecutionExclusionFileFilter">
<property name="fileNamePattern" value="module\-info\.java$"/>
</module>
<module name="SuppressWarningsFilter"/>
<module name="SuppressionFilter">
<property name="file" value="checkstyle-suppressions.xml"/>
<property name="optional" value="true"/>
</module>
<!-- === Core formatting check only (Spotless handles the rest) === -->
<module name="FileTabCharacter">
<property name="eachLine" value="true"/>
</module>
<!-- Line length stays useful for code review readability -->
<module name="LineLength">
<property name="max" value="120"/>
<property name="ignorePattern"
value="^package.*|^import.*|http://|https://"/>
</module>
<module name="TreeWalker">
<!-- ✅ Keep these naming checks -->
<module name="PackageName"/>
<module name="TypeName"/>
<module name="MethodName"/>
<module name="ParameterName"/>
<module name="LocalVariableName"/>
<module name="MemberName"/>
<!-- Allow names like JParqUtil -->
<module name="AbbreviationAsWordInName">
<property name="ignoreFinal" value="true"/>
<property name="allowedAbbreviationLength" value="3"/>
</module>
<!-- ✅ Keep important structural checks -->
<module name="NeedBraces"/>
<module name="EmptyBlock">
<property name="option" value="TEXT"/>
</module>
<module name="MissingSwitchDefault"/>
<module name="FallThrough"/>
<!-- ✅ Keep logical correctness checks -->
<module name="NoFinalizer"/>
<module name="OverloadMethodsDeclarationOrder"/>
<module name="ConstructorsDeclarationGrouping"/>
<module name="VariableDeclarationUsageDistance"/>
<!-- ✅ Javadoc & documentation -->
<module name="JavadocType">
<property name="scope" value="public"/>
</module>
<module name="JavadocMethod">
<property name="accessModifiers" value="public"/>
<property name="allowMissingParamTags" value="true"/>
<property name="allowMissingReturnTag" value="true"/>
<property name="allowedAnnotations" value="Override, Test"/>
</module>
<module name="JavadocParagraph">
<property name="allowNewlineParagraph" value="true"/>
</module>
<!-- ✅ Keep annotation & modifier order -->
<module name="AnnotationLocation"/>
<module name="ModifierOrder"/>
<!-- ✅ Keep TODO and comment indentation checks -->
<module name="TodoComment"/>
<module name="CommentsIndentation"/>
<!-- ✅ Import sanity (Spotless handles order but we can double-check) -->
<module name="UnusedImports"/>
<module name="RedundantImport"/>
<!-- ❌ Remove or disable formatting checks handled by Spotless -->
<module name="WhitespaceAfter">
<property name="severity" value="ignore"/>
</module>
<module name="WhitespaceAround">
<property name="severity" value="ignore"/>
</module>
<module name="Indentation">
<property name="severity" value="ignore"/>
</module>
<module name="NoWhitespaceBeforeCaseDefaultColon">
<property name="severity" value="ignore"/>
</module>
<module name="LeftCurly">
<property name="severity" value="ignore"/>
</module>
<module name="RightCurly">
<property name="severity" value="ignore"/>
</module>
<module name="OperatorWrap">
<property name="severity" value="ignore"/>
</module>
<module name="SeparatorWrap">
<property name="severity" value="ignore"/>
</module>
</module>
<module name="SuppressionFilter">
<property name="file" value="checkstyle-test-suppressions.xml"/>
<property name="optional" value="true"/>
</module>
</module>