Skip to content

Commit bc253d4

Browse files
Ihor-TkachukIhor-Tkachuk
committed
added checkstyle.xml
1 parent 42b7ce3 commit bc253d4

File tree

1 file changed

+251
-0
lines changed

1 file changed

+251
-0
lines changed

‎checkstyle.xml‎

Lines changed: 251 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,251 @@
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+
<!--
8+
Checkstyle configuration that checks the Google coding conventions from Google Java Style
9+
that can be found at https://google.github.io/styleguide/javaguide.html.
10+
11+
Checkstyle is very configurable. Be sure to read the documentation at
12+
http://checkstyle.sf.net (or in your downloaded distribution).
13+
14+
To completely disable a check, just comment it out or delete it from the file.
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="error"/>
23+
24+
<property name="fileExtensions" value="java, properties, xml"/>
25+
<!-- Checks for whitespace -->
26+
<!-- See http://checkstyle.sf.net/config_whitespace.html -->
27+
<module name="FileTabCharacter">
28+
<property name="eachLine" value="true"/>
29+
</module>
30+
<module name="NewlineAtEndOfFile">
31+
<property name="fileExtensions" value="java, properties, xml"/>
32+
</module>
33+
<module name="LineLength">
34+
<property name="max" value="100"/>
35+
<property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
36+
</module>
37+
<module name="TreeWalker">
38+
<module name="OuterTypeFilename"/>
39+
<module name="IllegalTokenText">
40+
<property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
41+
<property name="format"
42+
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)"/>
43+
<property name="message"
44+
value="Consider using special escape sequence instead of octal value or Unicode escaped value."/>
45+
</module>
46+
<module name="AvoidEscapedUnicodeCharacters">
47+
<property name="allowEscapesForControlCharacters" value="true"/>
48+
<property name="allowByTailComment" value="true"/>
49+
<property name="allowNonPrintableEscapes" value="true"/>
50+
</module>
51+
<module name="AvoidStarImport"/>
52+
<module name="IllegalImport"/>
53+
<module name="RedundantImport"/>
54+
<module name="UnusedImports"/>
55+
<module name="OneTopLevelClass"/>
56+
<module name="NoLineWrap"/>
57+
<module name="EmptyBlock">
58+
<property name="option" value="TEXT"/>
59+
<property name="tokens"
60+
value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
61+
</module>
62+
<module name="NeedBraces"/>
63+
<module name="LeftCurly"/>
64+
<module name="RightCurly">
65+
<property name="id" value="RightCurlySame"/>
66+
<property name="tokens"
67+
value="LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE,
68+
LITERAL_DO"/>
69+
</module>
70+
<module name="RightCurly">
71+
<property name="id" value="RightCurlyAlone"/>
72+
<property name="option" value="alone"/>
73+
<property name="tokens"
74+
value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, STATIC_INIT,
75+
INSTANCE_INIT"/>
76+
</module>
77+
<module name="WhitespaceAround">
78+
<property name="allowEmptyConstructors" value="true"/>
79+
<property name="allowEmptyLambdas" value="true"/>
80+
<property name="allowEmptyMethods" value="true"/>
81+
<property name="allowEmptyTypes" value="true"/>
82+
<property name="allowEmptyLoops" value="true"/>
83+
<message key="ws.notFollowed"
84+
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)"/>
85+
<message key="ws.notPreceded"
86+
value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
87+
</module>
88+
<module name="OneStatementPerLine"/>
89+
<module name="MultipleVariableDeclarations"/>
90+
<module name="ArrayTypeStyle"/>
91+
<module name="MissingSwitchDefault"/>
92+
<module name="FallThrough"/>
93+
<module name="VisibilityModifier">
94+
<property name="protectedAllowed" value="true"/>
95+
</module>
96+
<module name="UpperEll"/>
97+
<module name="ModifierOrder"/>
98+
<module name="EmptyLineSeparator">
99+
<property name="allowNoEmptyLineBetweenFields" value="true"/>
100+
<property name="allowMultipleEmptyLines" value="false"/>
101+
<property name="allowMultipleEmptyLinesInsideClassMembers" value="false"/>
102+
</module>
103+
<module name="SeparatorWrap">
104+
<property name="id" value="SeparatorWrapDot"/>
105+
<property name="tokens" value="DOT"/>
106+
<property name="option" value="nl"/>
107+
</module>
108+
<module name="SeparatorWrap">
109+
<property name="id" value="SeparatorWrapComma"/>
110+
<property name="tokens" value="COMMA"/>
111+
<property name="option" value="EOL"/>
112+
</module>
113+
<module name="SeparatorWrap">
114+
<!-- ELLIPSIS is EOL until https://github.com/google/styleguide/issues/258 -->
115+
<property name="id" value="SeparatorWrapEllipsis"/>
116+
<property name="tokens" value="ELLIPSIS"/>
117+
<property name="option" value="EOL"/>
118+
</module>
119+
<module name="SeparatorWrap">
120+
<!-- ARRAY_DECLARATOR is EOL until https://github.com/google/styleguide/issues/259 -->
121+
<property name="id" value="SeparatorWrapArrayDeclarator"/>
122+
<property name="tokens" value="ARRAY_DECLARATOR"/>
123+
<property name="option" value="EOL"/>
124+
</module>
125+
<module name="SeparatorWrap">
126+
<property name="id" value="SeparatorWrapMethodRef"/>
127+
<property name="tokens" value="METHOD_REF"/>
128+
<property name="option" value="nl"/>
129+
</module>
130+
<module name="PackageName">
131+
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
132+
<message key="name.invalidPattern"
133+
value="Package name ''{0}'' must match pattern ''{1}''."/>
134+
</module>
135+
<module name="TypeName">
136+
<message key="name.invalidPattern"
137+
value="Type name ''{0}'' must match pattern ''{1}''."/>
138+
</module>
139+
<module name="MemberName">
140+
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
141+
<message key="name.invalidPattern"
142+
value="Member name ''{0}'' must match pattern ''{1}''."/>
143+
</module>
144+
<module name="ParameterName">
145+
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
146+
<message key="name.invalidPattern"
147+
value="Parameter name ''{0}'' must match pattern ''{1}''."/>
148+
</module>
149+
<module name="LambdaParameterName">
150+
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
151+
<message key="name.invalidPattern"
152+
value="Lambda parameter name ''{0}'' must match pattern ''{1}''."/>
153+
</module>
154+
<module name="CatchParameterName">
155+
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
156+
<message key="name.invalidPattern"
157+
value="Catch parameter name ''{0}'' must match pattern ''{1}''."/>
158+
</module>
159+
<module name="LocalVariableName">
160+
<property name="tokens" value="VARIABLE_DEF"/>
161+
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
162+
<message key="name.invalidPattern"
163+
value="Local variable name ''{0}'' must match pattern ''{1}''."/>
164+
</module>
165+
<module name="ClassTypeParameterName">
166+
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
167+
<message key="name.invalidPattern"
168+
value="Class type name ''{0}'' must match pattern ''{1}''."/>
169+
</module>
170+
<module name="MethodTypeParameterName">
171+
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
172+
<message key="name.invalidPattern"
173+
value="Method type name ''{0}'' must match pattern ''{1}''."/>
174+
</module>
175+
<module name="InterfaceTypeParameterName">
176+
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
177+
<message key="name.invalidPattern"
178+
value="Interface type name ''{0}'' must match pattern ''{1}''."/>
179+
</module>
180+
<module name="NoFinalizer"/>
181+
<module name="GenericWhitespace">
182+
<message key="ws.followed"
183+
value="GenericWhitespace ''{0}'' is followed by whitespace."/>
184+
<message key="ws.preceded"
185+
value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
186+
<message key="ws.illegalFollow"
187+
value="GenericWhitespace ''{0}'' should followed by whitespace."/>
188+
<message key="ws.notPreceded"
189+
value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
190+
</module>
191+
<module name="Indentation">
192+
<property name="basicOffset" value="4"/>
193+
<property name="braceAdjustment" value="0"/>
194+
<property name="caseIndent" value="4"/>
195+
<property name="throwsIndent" value="8"/>
196+
<property name="lineWrappingIndentation" value="8"/>
197+
<property name="arrayInitIndent" value="4"/>
198+
</module>
199+
<module name="AbbreviationAsWordInName">
200+
<property name="ignoreFinal" value="false"/>
201+
<property name="allowedAbbreviationLength" value="1"/>
202+
</module>
203+
<module name="OverloadMethodsDeclarationOrder"/>
204+
<module name="VariableDeclarationUsageDistance"/>
205+
<module name="CustomImportOrder">
206+
<property name="sortImportsInGroupAlphabetically" value="true"/>
207+
<property name="separateLineBetweenGroups" value="true"/>
208+
<property name="customImportOrderRules" value="STATIC###THIRD_PARTY_PACKAGE"/>
209+
</module>
210+
<module name="MethodParamPad"/>
211+
<module name="NoWhitespaceBefore">
212+
<property name="tokens"
213+
value="COMMA, SEMI, POST_INC, POST_DEC, DOT, ELLIPSIS, METHOD_REF"/>
214+
<property name="allowLineBreaks" value="true"/>
215+
</module>
216+
<module name="ParenPad"/>
217+
<module name="OperatorWrap">
218+
<property name="option" value="NL"/>
219+
<property name="tokens"
220+
value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR,
221+
LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR, METHOD_REF "/>
222+
</module>
223+
<module name="AnnotationLocation">
224+
<property name="id" value="AnnotationLocationMostCases"/>
225+
<property name="tokens"
226+
value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/>
227+
</module>
228+
<module name="AnnotationLocation">
229+
<property name="id" value="AnnotationLocationVariables"/>
230+
<property name="tokens" value="VARIABLE_DEF"/>
231+
<property name="allowSamelineMultipleAnnotations" value="true"/>
232+
</module>
233+
<module name="NonEmptyAtclauseDescription"/>
234+
<module name="MethodName">
235+
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
236+
<message key="name.invalidPattern"
237+
value="Method name ''{0}'' must match pattern ''{1}''."/>
238+
</module>
239+
<module name="SingleLineJavadoc">
240+
<property name="ignoreInlineTags" value="false"/>
241+
</module>
242+
<module name="EmptyCatchBlock">
243+
<property name="exceptionVariableName" value="expected"/>
244+
</module>
245+
<module name="CommentsIndentation"/>
246+
<module name="DeclarationOrder"/>
247+
<module name="SingleSpaceSeparator">
248+
<property name="validateComments" value="true"/>
249+
</module>
250+
</module>
251+
</module>

0 commit comments

Comments
 (0)