Skip to content

Commit 6006384

Browse files
justinabrahmsjustinabrahms
committed
Checkstyle w/ google style from v8.29 of checkstyle
1 parent 9ea9e08 commit 6006384

File tree

2 files changed

+345
-0
lines changed

2 files changed

+345
-0
lines changed

‎checkstyle.xml

+322
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,322 @@
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"/>
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"/>
97+
</module>
98+
<module name="WhitespaceAround">
99+
<property name="allowEmptyConstructors" value="true"/>
100+
<property name="allowEmptyLambdas" value="true"/>
101+
<property name="allowEmptyMethods" value="true"/>
102+
<property name="allowEmptyTypes" value="true"/>
103+
<property name="allowEmptyLoops" value="true"/>
104+
<property name="tokens"
105+
value="ASSIGN, BAND, BAND_ASSIGN, BOR, BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR,
106+
BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN, DO_WHILE, EQUAL, GE, GT, LAMBDA, LAND,
107+
LCURLY, LE, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY,
108+
LITERAL_FOR, LITERAL_IF, LITERAL_RETURN, LITERAL_SWITCH, LITERAL_SYNCHRONIZED,
109+
LITERAL_TRY, LITERAL_WHILE, LOR, LT, MINUS, MINUS_ASSIGN, MOD, MOD_ASSIGN,
110+
NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION, RCURLY, SL, SLIST, SL_ASSIGN, SR,
111+
SR_ASSIGN, STAR, STAR_ASSIGN, LITERAL_ASSERT, TYPE_EXTENSION_AND"/>
112+
<message key="ws.notFollowed"
113+
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)"/>
114+
<message key="ws.notPreceded"
115+
value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
116+
</module>
117+
<module name="OneStatementPerLine"/>
118+
<module name="MultipleVariableDeclarations"/>
119+
<module name="ArrayTypeStyle"/>
120+
<module name="MissingSwitchDefault"/>
121+
<module name="FallThrough"/>
122+
<module name="UpperEll"/>
123+
<module name="ModifierOrder"/>
124+
<module name="EmptyLineSeparator">
125+
<property name="tokens"
126+
value="PACKAGE_DEF, IMPORT, STATIC_IMPORT, CLASS_DEF, INTERFACE_DEF, ENUM_DEF,
127+
STATIC_INIT, INSTANCE_INIT, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
128+
<property name="allowNoEmptyLineBetweenFields" value="true"/>
129+
</module>
130+
<module name="SeparatorWrap">
131+
<property name="id" value="SeparatorWrapDot"/>
132+
<property name="tokens" value="DOT"/>
133+
<property name="option" value="nl"/>
134+
</module>
135+
<module name="SeparatorWrap">
136+
<property name="id" value="SeparatorWrapComma"/>
137+
<property name="tokens" value="COMMA"/>
138+
<property name="option" value="EOL"/>
139+
</module>
140+
<module name="SeparatorWrap">
141+
<!-- ELLIPSIS is EOL until https://github.com/google/styleguide/issues/258 -->
142+
<property name="id" value="SeparatorWrapEllipsis"/>
143+
<property name="tokens" value="ELLIPSIS"/>
144+
<property name="option" value="EOL"/>
145+
</module>
146+
<module name="SeparatorWrap">
147+
<!-- ARRAY_DECLARATOR is EOL until https://github.com/google/styleguide/issues/259 -->
148+
<property name="id" value="SeparatorWrapArrayDeclarator"/>
149+
<property name="tokens" value="ARRAY_DECLARATOR"/>
150+
<property name="option" value="EOL"/>
151+
</module>
152+
<module name="SeparatorWrap">
153+
<property name="id" value="SeparatorWrapMethodRef"/>
154+
<property name="tokens" value="METHOD_REF"/>
155+
<property name="option" value="nl"/>
156+
</module>
157+
<module name="PackageName">
158+
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
159+
<message key="name.invalidPattern"
160+
value="Package name ''{0}'' must match pattern ''{1}''."/>
161+
</module>
162+
<module name="TypeName">
163+
<property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, ANNOTATION_DEF"/>
164+
<message key="name.invalidPattern"
165+
value="Type name ''{0}'' must match pattern ''{1}''."/>
166+
</module>
167+
<module name="MemberName">
168+
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
169+
<message key="name.invalidPattern"
170+
value="Member name ''{0}'' must match pattern ''{1}''."/>
171+
</module>
172+
<module name="ParameterName">
173+
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
174+
<message key="name.invalidPattern"
175+
value="Parameter name ''{0}'' must match pattern ''{1}''."/>
176+
</module>
177+
<module name="LambdaParameterName">
178+
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
179+
<message key="name.invalidPattern"
180+
value="Lambda parameter name ''{0}'' must match pattern ''{1}''."/>
181+
</module>
182+
<module name="CatchParameterName">
183+
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
184+
<message key="name.invalidPattern"
185+
value="Catch parameter name ''{0}'' must match pattern ''{1}''."/>
186+
</module>
187+
<module name="LocalVariableName">
188+
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
189+
<message key="name.invalidPattern"
190+
value="Local variable name ''{0}'' must match pattern ''{1}''."/>
191+
</module>
192+
<module name="ClassTypeParameterName">
193+
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
194+
<message key="name.invalidPattern"
195+
value="Class type name ''{0}'' must match pattern ''{1}''."/>
196+
</module>
197+
<module name="MethodTypeParameterName">
198+
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
199+
<message key="name.invalidPattern"
200+
value="Method type name ''{0}'' must match pattern ''{1}''."/>
201+
</module>
202+
<module name="InterfaceTypeParameterName">
203+
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
204+
<message key="name.invalidPattern"
205+
value="Interface type name ''{0}'' must match pattern ''{1}''."/>
206+
</module>
207+
<module name="NoFinalizer"/>
208+
<module name="GenericWhitespace">
209+
<message key="ws.followed"
210+
value="GenericWhitespace ''{0}'' is followed by whitespace."/>
211+
<message key="ws.preceded"
212+
value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
213+
<message key="ws.illegalFollow"
214+
value="GenericWhitespace ''{0}'' should followed by whitespace."/>
215+
<message key="ws.notPreceded"
216+
value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
217+
</module>
218+
<module name="Indentation">
219+
<property name="basicOffset" value="2"/>
220+
<property name="braceAdjustment" value="0"/>
221+
<property name="caseIndent" value="2"/>
222+
<property name="throwsIndent" value="4"/>
223+
<property name="lineWrappingIndentation" value="4"/>
224+
<property name="arrayInitIndent" value="2"/>
225+
</module>
226+
<module name="AbbreviationAsWordInName">
227+
<property name="ignoreFinal" value="false"/>
228+
<property name="allowedAbbreviationLength" value="1"/>
229+
<property name="tokens"
230+
value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, ANNOTATION_DEF, ANNOTATION_FIELD_DEF,
231+
PARAMETER_DEF, VARIABLE_DEF, METHOD_DEF"/>
232+
</module>
233+
<module name="OverloadMethodsDeclarationOrder"/>
234+
<module name="VariableDeclarationUsageDistance"/>
235+
<module name="CustomImportOrder">
236+
<property name="sortImportsInGroupAlphabetically" value="true"/>
237+
<property name="separateLineBetweenGroups" value="true"/>
238+
<property name="customImportOrderRules" value="STATIC###THIRD_PARTY_PACKAGE"/>
239+
<property name="tokens" value="IMPORT, STATIC_IMPORT, PACKAGE_DEF"/>
240+
</module>
241+
<module name="MethodParamPad">
242+
<property name="tokens"
243+
value="CTOR_DEF, LITERAL_NEW, METHOD_CALL, METHOD_DEF,
244+
SUPER_CTOR_CALL, ENUM_CONSTANT_DEF"/>
245+
</module>
246+
<module name="NoWhitespaceBefore">
247+
<property name="tokens"
248+
value="COMMA, SEMI, POST_INC, POST_DEC, DOT, ELLIPSIS, METHOD_REF"/>
249+
<property name="allowLineBreaks" value="true"/>
250+
</module>
251+
<module name="ParenPad">
252+
<property name="tokens"
253+
value="ANNOTATION, ANNOTATION_FIELD_DEF, CTOR_CALL, CTOR_DEF, DOT, ENUM_CONSTANT_DEF,
254+
EXPR, LITERAL_CATCH, LITERAL_DO, LITERAL_FOR, LITERAL_IF, LITERAL_NEW,
255+
LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_WHILE, METHOD_CALL,
256+
METHOD_DEF, QUESTION, RESOURCE_SPECIFICATION, SUPER_CTOR_CALL, LAMBDA"/>
257+
</module>
258+
<module name="OperatorWrap">
259+
<property name="option" value="NL"/>
260+
<property name="tokens"
261+
value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR,
262+
LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR, METHOD_REF "/>
263+
</module>
264+
<module name="AnnotationLocation">
265+
<property name="id" value="AnnotationLocationMostCases"/>
266+
<property name="tokens"
267+
value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/>
268+
</module>
269+
<module name="AnnotationLocation">
270+
<property name="id" value="AnnotationLocationVariables"/>
271+
<property name="tokens" value="VARIABLE_DEF"/>
272+
<property name="allowSamelineMultipleAnnotations" value="true"/>
273+
</module>
274+
<module name="NonEmptyAtclauseDescription"/>
275+
<module name="InvalidJavadocPosition"/>
276+
<module name="JavadocTagContinuationIndentation"/>
277+
<module name="SummaryJavadoc">
278+
<property name="forbiddenSummaryFragments"
279+
value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
280+
</module>
281+
<module name="JavadocParagraph"/>
282+
<module name="AtclauseOrder">
283+
<property name="tagOrder" value="@param, @return, @throws, @deprecated"/>
284+
<property name="target"
285+
value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
286+
</module>
287+
<module name="JavadocMethod">
288+
<property name="scope" value="public"/>
289+
<property name="allowMissingParamTags" value="true"/>
290+
<property name="allowMissingReturnTag" value="true"/>
291+
<property name="allowedAnnotations" value="Override, Test"/>
292+
<property name="tokens" value="METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF"/>
293+
</module>
294+
<module name="MissingJavadocMethod">
295+
<property name="scope" value="public"/>
296+
<property name="minLineCount" value="2"/>
297+
<property name="allowedAnnotations" value="Override, Test"/>
298+
<property name="tokens" value="METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF"/>
299+
</module>
300+
<module name="MethodName">
301+
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
302+
<message key="name.invalidPattern"
303+
value="Method name ''{0}'' must match pattern ''{1}''."/>
304+
</module>
305+
<module name="SingleLineJavadoc">
306+
<property name="ignoreInlineTags" value="false"/>
307+
</module>
308+
<module name="EmptyCatchBlock">
309+
<property name="exceptionVariableName" value="expected"/>
310+
</module>
311+
<module name="CommentsIndentation">
312+
<property name="tokens" value="SINGLE_LINE_COMMENT, BLOCK_COMMENT_BEGIN"/>
313+
</module>
314+
<!-- https://checkstyle.org/config_filters.html#SuppressionXpathFilter -->
315+
<module name="SuppressionXpathFilter">
316+
<property name="file" value="${org.checkstyle.google.suppressionxpathfilter.config}"
317+
default="checkstyle-xpath-suppressions.xml" />
318+
<property name="optional" value="true"/>
319+
</module>
320+
</module>
321+
</module>
322+

‎pom.xml

+23
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@
5454
<scope>provided</scope>
5555
</dependency>
5656

57+
5758
<dependency>
5859
<!-- used so that lombok can generate suppressions for spotbugs. It needs to find it on the relevant classpath -->
5960
<groupId>com.github.spotbugs</groupId>
@@ -319,6 +320,28 @@
319320
</executions>
320321
</plugin>
321322

323+
<plugin>
324+
<groupId>org.apache.maven.plugins</groupId>
325+
<artifactId>maven-checkstyle-plugin</artifactId>
326+
<version>3.1.2</version>
327+
<configuration>
328+
<configLocation>checkstyle.xml</configLocation>
329+
<encoding>UTF-8</encoding>
330+
<consoleOutput>true</consoleOutput>
331+
<failsOnError>true</failsOnError>
332+
<linkXRef>false</linkXRef>
333+
</configuration>
334+
<executions>
335+
<execution>
336+
<id>validate</id>
337+
<phase>validate</phase>
338+
<goals>
339+
<goal>check</goal>
340+
</goals>
341+
</execution>
342+
</executions>
343+
</plugin>
344+
322345
</plugins>
323346
</build>
324347

0 commit comments

Comments
 (0)