Skip to content

Commit 75677df

Browse files
KorbikKorbik
committed
Add Checkstyle
1 parent e406056 commit 75677df

File tree

2 files changed

+384
-0
lines changed

2 files changed

+384
-0
lines changed

‎checkstyle.xml

+364
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,364 @@
1+
<?xml version="1.0"?>
2+
<!DOCTYPE module PUBLIC
3+
"-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
4+
"https://checkstyle.org/dtds/configuration_1_3.dtd">
5+
6+
<!--
7+
Checkstyle configuration that checks the Google coding conventions from Google Java Style
8+
that can be found at https://google.github.io/styleguide/javaguide.html
9+
10+
Checkstyle is very configurable. Be sure to read the documentation at
11+
http://checkstyle.org (or in your downloaded distribution).
12+
13+
To completely disable a check, just comment it out or delete it from the file.
14+
To suppress certain violations please review suppression filters.
15+
16+
Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov.
17+
-->
18+
19+
<module name = "Checker">
20+
<property name="charset" value="UTF-8"/>
21+
22+
<property name="severity" value="warning"/>
23+
24+
<property name="fileExtensions" value="java, properties, xml"/>
25+
<!-- Excludes all 'module-info.java' files -->
26+
<!-- See https://checkstyle.org/config_filefilters.html -->
27+
<module name="BeforeExecutionExclusionFileFilter">
28+
<property name="fileNamePattern" value="module\-info\.java$"/>
29+
</module>
30+
<!-- https://checkstyle.org/config_filters.html#SuppressionFilter -->
31+
<module name="SuppressionFilter">
32+
<property name="file" value="${org.checkstyle.google.suppressionfilter.config}"
33+
default="checkstyle-suppressions.xml" />
34+
<property name="optional" value="true"/>
35+
</module>
36+
37+
<!-- Checks for whitespace -->
38+
<!-- See http://checkstyle.org/config_whitespace.html -->
39+
<module name="FileTabCharacter">
40+
<property name="eachLine" value="true"/>
41+
</module>
42+
43+
<module name="LineLength">
44+
<property name="fileExtensions" value="java"/>
45+
<property name="max" value="100"/>
46+
<property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
47+
</module>
48+
49+
<module name="TreeWalker">
50+
<module name="OuterTypeFilename"/>
51+
<module name="IllegalTokenText">
52+
<property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
53+
<property name="format"
54+
value="\\u00(09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)"/>
55+
<property name="message"
56+
value="Consider using special escape sequence instead of octal value or Unicode escaped value."/>
57+
</module>
58+
<module name="AvoidEscapedUnicodeCharacters">
59+
<property name="allowEscapesForControlCharacters" value="true"/>
60+
<property name="allowByTailComment" value="true"/>
61+
<property name="allowNonPrintableEscapes" value="true"/>
62+
</module>
63+
<module name="AvoidStarImport"/>
64+
<module name="OneTopLevelClass"/>
65+
<module name="NoLineWrap">
66+
<property name="tokens" value="PACKAGE_DEF, IMPORT, STATIC_IMPORT"/>
67+
</module>
68+
<module name="EmptyBlock">
69+
<property name="option" value="TEXT"/>
70+
<property name="tokens"
71+
value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
72+
</module>
73+
<module name="NeedBraces">
74+
<property name="tokens"
75+
value="LITERAL_DO, LITERAL_ELSE, LITERAL_FOR, LITERAL_IF, LITERAL_WHILE"/>
76+
</module>
77+
<module name="LeftCurly">
78+
<property name="tokens"
79+
value="ANNOTATION_DEF, CLASS_DEF, CTOR_DEF, ENUM_CONSTANT_DEF, ENUM_DEF,
80+
INTERFACE_DEF, LAMBDA, LITERAL_CASE, LITERAL_CATCH, LITERAL_DEFAULT,
81+
LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF,
82+
LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, METHOD_DEF,
83+
OBJBLOCK, STATIC_INIT, RECORD_DEF, COMPACT_CTOR_DEF"/>
84+
</module>
85+
<module name="RightCurly">
86+
<property name="id" value="RightCurlySame"/>
87+
<property name="tokens"
88+
value="LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE,
89+
LITERAL_DO"/>
90+
</module>
91+
<module name="RightCurly">
92+
<property name="id" value="RightCurlyAlone"/>
93+
<property name="option" value="alone"/>
94+
<property name="tokens"
95+
value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, STATIC_INIT,
96+
INSTANCE_INIT, ANNOTATION_DEF, ENUM_DEF, INTERFACE_DEF, RECORD_DEF,
97+
COMPACT_CTOR_DEF"/>
98+
</module>
99+
<module name="SuppressionXpathSingleFilter">
100+
<!-- suppresion is required till https://github.com/checkstyle/checkstyle/issues/7541 -->
101+
<property name="id" value="RightCurlyAlone"/>
102+
<property name="query" value="//RCURLY[parent::SLIST[count(./*)=1]
103+
or preceding-sibling::*[last()][self::LCURLY]]"/>
104+
</module>
105+
<module name="WhitespaceAfter">
106+
<property name="tokens"
107+
value="COMMA, SEMI, TYPECAST, LITERAL_IF, LITERAL_ELSE,
108+
LITERAL_WHILE, LITERAL_DO, LITERAL_FOR, DO_WHILE"/>
109+
</module>
110+
<module name="WhitespaceAround">
111+
<property name="allowEmptyConstructors" value="true"/>
112+
<property name="allowEmptyLambdas" value="true"/>
113+
<property name="allowEmptyMethods" value="true"/>
114+
<property name="allowEmptyTypes" value="true"/>
115+
<property name="allowEmptyLoops" value="true"/>
116+
<property name="ignoreEnhancedForColon" value="false"/>
117+
<property name="tokens"
118+
value="ASSIGN, BAND, BAND_ASSIGN, BOR, BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR,
119+
BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN, DO_WHILE, EQUAL, GE, GT, LAMBDA, LAND,
120+
LCURLY, LE, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY,
121+
LITERAL_FOR, LITERAL_IF, LITERAL_RETURN, LITERAL_SWITCH, LITERAL_SYNCHRONIZED,
122+
LITERAL_TRY, LITERAL_WHILE, LOR, LT, MINUS, MINUS_ASSIGN, MOD, MOD_ASSIGN,
123+
NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION, RCURLY, SL, SLIST, SL_ASSIGN, SR,
124+
SR_ASSIGN, STAR, STAR_ASSIGN, LITERAL_ASSERT, TYPE_EXTENSION_AND"/>
125+
<message key="ws.notFollowed"
126+
value="WhitespaceAround: ''{0}'' is not followed by whitespace. Empty blocks may only be represented as '{}' when not part of a multi-block statement (4.1.3)"/>
127+
<message key="ws.notPreceded"
128+
value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
129+
</module>
130+
<module name="OneStatementPerLine"/>
131+
<module name="MultipleVariableDeclarations"/>
132+
<module name="ArrayTypeStyle"/>
133+
<module name="MissingSwitchDefault"/>
134+
<module name="FallThrough"/>
135+
<module name="UpperEll"/>
136+
<module name="ModifierOrder"/>
137+
<module name="EmptyLineSeparator">
138+
<property name="tokens"
139+
value="PACKAGE_DEF, IMPORT, STATIC_IMPORT, CLASS_DEF, INTERFACE_DEF, ENUM_DEF,
140+
STATIC_INIT, INSTANCE_INIT, METHOD_DEF, CTOR_DEF, VARIABLE_DEF, RECORD_DEF,
141+
COMPACT_CTOR_DEF"/>
142+
<property name="allowNoEmptyLineBetweenFields" value="true"/>
143+
</module>
144+
<module name="SeparatorWrap">
145+
<property name="id" value="SeparatorWrapDot"/>
146+
<property name="tokens" value="DOT"/>
147+
<property name="option" value="nl"/>
148+
</module>
149+
<module name="SeparatorWrap">
150+
<property name="id" value="SeparatorWrapComma"/>
151+
<property name="tokens" value="COMMA"/>
152+
<property name="option" value="EOL"/>
153+
</module>
154+
<module name="SeparatorWrap">
155+
<!-- ELLIPSIS is EOL until https://github.com/google/styleguide/issues/259 -->
156+
<property name="id" value="SeparatorWrapEllipsis"/>
157+
<property name="tokens" value="ELLIPSIS"/>
158+
<property name="option" value="EOL"/>
159+
</module>
160+
<module name="SeparatorWrap">
161+
<!-- ARRAY_DECLARATOR is EOL until https://github.com/google/styleguide/issues/258 -->
162+
<property name="id" value="SeparatorWrapArrayDeclarator"/>
163+
<property name="tokens" value="ARRAY_DECLARATOR"/>
164+
<property name="option" value="EOL"/>
165+
</module>
166+
<module name="SeparatorWrap">
167+
<property name="id" value="SeparatorWrapMethodRef"/>
168+
<property name="tokens" value="METHOD_REF"/>
169+
<property name="option" value="nl"/>
170+
</module>
171+
<module name="PackageName">
172+
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
173+
<message key="name.invalidPattern"
174+
value="Package name ''{0}'' must match pattern ''{1}''."/>
175+
</module>
176+
<module name="TypeName">
177+
<property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF,
178+
ANNOTATION_DEF, RECORD_DEF"/>
179+
<message key="name.invalidPattern"
180+
value="Type name ''{0}'' must match pattern ''{1}''."/>
181+
</module>
182+
<module name="MemberName">
183+
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
184+
<message key="name.invalidPattern"
185+
value="Member name ''{0}'' must match pattern ''{1}''."/>
186+
</module>
187+
<module name="ParameterName">
188+
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
189+
<message key="name.invalidPattern"
190+
value="Parameter name ''{0}'' must match pattern ''{1}''."/>
191+
</module>
192+
<module name="LambdaParameterName">
193+
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
194+
<message key="name.invalidPattern"
195+
value="Lambda parameter name ''{0}'' must match pattern ''{1}''."/>
196+
</module>
197+
<module name="CatchParameterName">
198+
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
199+
<message key="name.invalidPattern"
200+
value="Catch parameter name ''{0}'' must match pattern ''{1}''."/>
201+
</module>
202+
<module name="LocalVariableName">
203+
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
204+
<message key="name.invalidPattern"
205+
value="Local variable name ''{0}'' must match pattern ''{1}''."/>
206+
</module>
207+
<module name="PatternVariableName">
208+
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
209+
<message key="name.invalidPattern"
210+
value="Pattern variable name ''{0}'' must match pattern ''{1}''."/>
211+
</module>
212+
<module name="ClassTypeParameterName">
213+
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
214+
<message key="name.invalidPattern"
215+
value="Class type name ''{0}'' must match pattern ''{1}''."/>
216+
</module>
217+
<module name="RecordComponentName">
218+
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
219+
<message key="name.invalidPattern"
220+
value="Record component name ''{0}'' must match pattern ''{1}''."/>
221+
</module>
222+
<module name="RecordTypeParameterName">
223+
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
224+
<message key="name.invalidPattern"
225+
value="Record type name ''{0}'' must match pattern ''{1}''."/>
226+
</module>
227+
<module name="MethodTypeParameterName">
228+
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
229+
<message key="name.invalidPattern"
230+
value="Method type name ''{0}'' must match pattern ''{1}''."/>
231+
</module>
232+
<module name="InterfaceTypeParameterName">
233+
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
234+
<message key="name.invalidPattern"
235+
value="Interface type name ''{0}'' must match pattern ''{1}''."/>
236+
</module>
237+
<module name="NoFinalizer"/>
238+
<module name="GenericWhitespace">
239+
<message key="ws.followed"
240+
value="GenericWhitespace ''{0}'' is followed by whitespace."/>
241+
<message key="ws.preceded"
242+
value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
243+
<message key="ws.illegalFollow"
244+
value="GenericWhitespace ''{0}'' should followed by whitespace."/>
245+
<message key="ws.notPreceded"
246+
value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
247+
</module>
248+
<module name="Indentation">
249+
<property name="basicOffset" value="2"/>
250+
<property name="braceAdjustment" value="2"/>
251+
<property name="caseIndent" value="2"/>
252+
<property name="throwsIndent" value="4"/>
253+
<property name="lineWrappingIndentation" value="4"/>
254+
<property name="arrayInitIndent" value="2"/>
255+
</module>
256+
<module name="AbbreviationAsWordInName">
257+
<property name="ignoreFinal" value="false"/>
258+
<property name="allowedAbbreviationLength" value="0"/>
259+
<property name="tokens"
260+
value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, ANNOTATION_DEF, ANNOTATION_FIELD_DEF,
261+
PARAMETER_DEF, VARIABLE_DEF, METHOD_DEF, PATTERN_VARIABLE_DEF, RECORD_DEF,
262+
RECORD_COMPONENT_DEF"/>
263+
</module>
264+
<module name="NoWhitespaceBeforeCaseDefaultColon"/>
265+
<module name="OverloadMethodsDeclarationOrder"/>
266+
<module name="VariableDeclarationUsageDistance"/>
267+
<module name="CustomImportOrder">
268+
<property name="sortImportsInGroupAlphabetically" value="true"/>
269+
<property name="separateLineBetweenGroups" value="true"/>
270+
<property name="customImportOrderRules" value="STATIC###THIRD_PARTY_PACKAGE"/>
271+
<property name="tokens" value="IMPORT, STATIC_IMPORT, PACKAGE_DEF"/>
272+
</module>
273+
<module name="MethodParamPad">
274+
<property name="tokens"
275+
value="CTOR_DEF, LITERAL_NEW, METHOD_CALL, METHOD_DEF,
276+
SUPER_CTOR_CALL, ENUM_CONSTANT_DEF, RECORD_DEF"/>
277+
</module>
278+
<module name="NoWhitespaceBefore">
279+
<property name="tokens"
280+
value="COMMA, SEMI, POST_INC, POST_DEC, DOT,
281+
LABELED_STAT, METHOD_REF"/>
282+
<property name="allowLineBreaks" value="true"/>
283+
</module>
284+
<module name="ParenPad">
285+
<property name="tokens"
286+
value="ANNOTATION, ANNOTATION_FIELD_DEF, CTOR_CALL, CTOR_DEF, DOT, ENUM_CONSTANT_DEF,
287+
EXPR, LITERAL_CATCH, LITERAL_DO, LITERAL_FOR, LITERAL_IF, LITERAL_NEW,
288+
LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_WHILE, METHOD_CALL,
289+
METHOD_DEF, QUESTION, RESOURCE_SPECIFICATION, SUPER_CTOR_CALL, LAMBDA,
290+
RECORD_DEF"/>
291+
</module>
292+
<module name="OperatorWrap">
293+
<property name="option" value="NL"/>
294+
<property name="tokens"
295+
value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR,
296+
LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR, METHOD_REF,
297+
TYPE_EXTENSION_AND "/>
298+
</module>
299+
<module name="AnnotationLocation">
300+
<property name="id" value="AnnotationLocationMostCases"/>
301+
<property name="tokens"
302+
value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF,
303+
RECORD_DEF, COMPACT_CTOR_DEF"/>
304+
</module>
305+
<module name="AnnotationLocation">
306+
<property name="id" value="AnnotationLocationVariables"/>
307+
<property name="tokens" value="VARIABLE_DEF"/>
308+
<property name="allowSamelineMultipleAnnotations" value="true"/>
309+
</module>
310+
<module name="NonEmptyAtclauseDescription"/>
311+
<module name="InvalidJavadocPosition"/>
312+
<module name="JavadocTagContinuationIndentation"/>
313+
<module name="SummaryJavadoc">
314+
<property name="forbiddenSummaryFragments"
315+
value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
316+
</module>
317+
<module name="JavadocParagraph"/>
318+
<module name="RequireEmptyLineBeforeBlockTagGroup"/>
319+
<module name="AtclauseOrder">
320+
<property name="tagOrder" value="@param, @return, @throws, @deprecated"/>
321+
<property name="target"
322+
value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
323+
</module>
324+
<module name="JavadocMethod">
325+
<property name="accessModifiers" value="public"/>
326+
<property name="allowMissingParamTags" value="true"/>
327+
<property name="allowMissingReturnTag" value="true"/>
328+
<property name="allowedAnnotations" value="Override, Test"/>
329+
<property name="tokens" value="METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF, COMPACT_CTOR_DEF"/>
330+
</module>
331+
<module name="MissingJavadocMethod">
332+
<property name="scope" value="public"/>
333+
<property name="minLineCount" value="2"/>
334+
<property name="allowedAnnotations" value="Override, Test"/>
335+
<property name="tokens" value="METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF,
336+
COMPACT_CTOR_DEF"/>
337+
</module>
338+
<module name="MissingJavadocType">
339+
<property name="scope" value="protected"/>
340+
<property name="tokens"
341+
value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF,
342+
RECORD_DEF, ANNOTATION_DEF"/>
343+
<property name="excludeScope" value="nothing"/>
344+
</module>
345+
<module name="MethodName">
346+
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
347+
<message key="name.invalidPattern"
348+
value="Method name ''{0}'' must match pattern ''{1}''."/>
349+
</module>
350+
<module name="SingleLineJavadoc"/>
351+
<module name="EmptyCatchBlock">
352+
<property name="exceptionVariableName" value="expected"/>
353+
</module>
354+
<module name="CommentsIndentation">
355+
<property name="tokens" value="SINGLE_LINE_COMMENT, BLOCK_COMMENT_BEGIN"/>
356+
</module>
357+
<!-- https://checkstyle.org/config_filters.html#SuppressionXpathFilter -->
358+
<module name="SuppressionXpathFilter">
359+
<property name="file" value="${org.checkstyle.google.suppressionxpathfilter.config}"
360+
default="checkstyle-xpath-suppressions.xml" />
361+
<property name="optional" value="true"/>
362+
</module>
363+
</module>
364+
</module>

0 commit comments

Comments
 (0)