Skip to content

Commit c630864

Browse files
AB-xdevAB-xdev
committed
Rework checkstyle
* Update IntelliJ Checkstyle version * Move to non obstructing folder ``.config`` * Rework checkstyle file * Remove default values if possible * Remove outdated and non working checks * Remove exclusion for ``software.xdev`` which made this checkstyle useless * Create suppression file for individual projects xdev-software/github#18
1 parent cd1c9a4 commit c630864

File tree

4 files changed

+145
-313
lines changed

4 files changed

+145
-313
lines changed

‎.config/checkstyle/checkstyle.xml

Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
3+
"http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
4+
<module name="Checker">
5+
<!-- Only check code -->
6+
<property name="fileExtensions" value="java"/>
7+
<property name="severity" value="error"/>
8+
9+
<property name="tabWidth" value="4"/>
10+
11+
<module name="SuppressionFilter">
12+
<property name="file" value=".config/checkstyle/suppressions.xml"/>
13+
</module>
14+
15+
<module name="FileLength"/>
16+
<module name="LineLength">
17+
<property name="max" value="120"/>
18+
<property name="fileExtensions" value="java"/>
19+
<!-- Ignore default + links in comments -->
20+
<property name="ignorePattern" value="(^(package|import))|(^\s*(\/\/|\*) .*https?.*$)"/>
21+
</module>
22+
<module name="NewlineAtEndOfFile"/>
23+
24+
<module name="RegexpSingleline">
25+
<!-- Ignore inside block comments (*) -->
26+
<property name="format" value="[^\s\*][\s]{1,}$"/>
27+
<property name="minimum" value="0"/>
28+
<property name="maximum" value="0"/>
29+
<property name="message" value="Line has trailing whitespaces"/>
30+
</module>
31+
32+
<!-- Generated code -->
33+
<module name="SuppressionSingleFilter">
34+
<property name="checks" value="."/>
35+
<property name="files" value="[\\/](src)?gen[\\/].*\.java$"/>
36+
</module>
37+
<!-- Test code -->
38+
<module name="SuppressionSingleFilter">
39+
<property name="checks" value="MagicNumberCheck"/>
40+
<property name="files" value="[\\/]test[\\/].*\.java$"/>
41+
</module>
42+
<module name="SuppressWarningsFilter"/>
43+
44+
<module name="TreeWalker">
45+
<!-- Checks - sorted alphabetically -->
46+
<module name="ArrayTypeStyle"/>
47+
<module name="AvoidStarImport"/>
48+
<module name="ConstantName"/>
49+
<module name="DefaultComesLast"/>
50+
<module name="EmptyBlock"/>
51+
<module name="EmptyCatchBlock"/>
52+
<module name="EmptyForInitializerPad"/>
53+
<module name="EmptyForIteratorPad"/>
54+
<module name="EmptyStatement"/>
55+
<module name="EqualsHashCode"/>
56+
<module name="ExplicitInitialization">
57+
<property name="severity" value="info"/>
58+
</module>
59+
<module name="FinalClass"/>
60+
<module name="FinalParameters"/>
61+
<module name="GenericWhitespace"/>
62+
<module name="HideUtilityClassConstructor"/>
63+
<module name="IllegalImport"/>
64+
<module name="InterfaceIsType"/>
65+
<module name="JavadocStyle">
66+
<property name="checkFirstSentence" value="false"/>
67+
</module>
68+
<module name="LeftCurly">
69+
<!-- Default minus Lambda -->
70+
<property name="tokens" value="ANNOTATION_DEF, CLASS_DEF, CTOR_DEF, ENUM_CONSTANT_DEF, ENUM_DEF, INTERFACE_DEF, LITERAL_CASE, LITERAL_CATCH, LITERAL_DEFAULT, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF, LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, METHOD_DEF, OBJBLOCK, STATIC_INIT, RECORD_DEF, COMPACT_CTOR_DEF"/>
71+
<property name="option" value="nl"/>
72+
</module>
73+
<module name="LocalFinalVariableName"/>
74+
<module name="LocalVariableName"/>
75+
<module name="MagicNumber">
76+
<property name="ignoreAnnotation" value="true"/>
77+
<property name="ignoreFieldDeclaration" value="true"/>
78+
<property name="ignoreHashCodeMethod" value="true"/>
79+
<!-- Defaults + other common constant values (e.g. time) -->
80+
<property name="ignoreNumbers" value="-1, 0, 1, 2, 3, 4, 5, 10, 12, 24, 31, 60, 100, 1000"/>
81+
</module>
82+
<module name="MemberName"/>
83+
<module name="MethodLength"/>
84+
<module name="MethodName"/>
85+
<module name="MethodParamPad"/>
86+
<module name="MissingDeprecated"/>
87+
<module name="MissingOverride"/>
88+
<module name="MissingSwitchDefault"/>
89+
<module name="ModifierOrder"/>
90+
<module name="NeedBraces"/>
91+
<module name="NoClone"/>
92+
<module name="NoFinalizer"/>
93+
<module name="NonEmptyAtclauseDescription"/>
94+
<module name="NoWhitespaceAfter"/>
95+
<module name="NoWhitespaceBefore"/>
96+
<module name="OneStatementPerLine"/>
97+
<module name="OneTopLevelClass"/>
98+
<module name="OperatorWrap"/>
99+
<module name="OuterTypeNumber"/>
100+
<module name="PackageName"/>
101+
<module name="ParameterName"/>
102+
<module name="ParenPad"/>
103+
<module name="RedundantImport"/>
104+
<module name="RequireThis"/>
105+
<module name="RightCurly">
106+
<property name="option" value="alone"/>
107+
</module>
108+
<module name="SimplifyBooleanExpression"/>
109+
<module name="StaticVariableName"/>
110+
<module name="StringLiteralEquality"/>
111+
<module name="SuppressWarningsHolder"/>
112+
<module name="TodoComment">
113+
<property name="severity" value="info"/>
114+
</module>
115+
<module name="TypecastParenPad"/>
116+
<module name="TypeName"/>
117+
<module name="UnusedImports"/>
118+
<module name="UpperEll"/>
119+
<module name="VisibilityModifier">
120+
<property name="packageAllowed" value="true"/>
121+
<property name="protectedAllowed" value="true"/>
122+
</module>
123+
<module name="WhitespaceAfter">
124+
<property name="tokens" value="COMMA,SEMI"/>
125+
</module>
126+
<module name="WhitespaceAround">
127+
<property name="tokens"
128+
value="ASSIGN,BAND,BAND_ASSIGN,BOR,BOR_ASSIGN,BSR,BSR_ASSIGN,BXOR,BXOR_ASSIGN,COLON,DIV,DIV_ASSIGN,EQUAL,GE,GT,LAND,LCURLY,LE,LOR,LT,MINUS,MINUS_ASSIGN,MOD,MOD_ASSIGN,NOT_EQUAL,PLUS,PLUS_ASSIGN,QUESTION,RCURLY,SL,SLIST,SL_ASSIGN,SR,SR_ASSIGN,STAR,STAR_ASSIGN,TYPE_EXTENSION_AND"/>
129+
</module>
130+
131+
<!-- Filter -->
132+
<module name="SuppressionCommentFilter">
133+
<property name="offCommentFormat" value="\s*CHECKSTYLE:OFF\s*[^\s]{1,}"/>
134+
<property name="onCommentFormat" value="\s*CHECKSTYLE:ON"/>
135+
</module>
136+
</module>
137+
</module>

‎.config/checkstyle/suppressions.xml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
<?xml version="1.0"?>
2+
<!DOCTYPE suppressions PUBLIC
3+
"-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN"
4+
"https://checkstyle.org/dtds/suppressions_1_2.dtd">
5+
<suppressions>
6+
</suppressions>

‎.idea/checkstyle-idea.xml

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)