Skip to content

Commit b3f50e2

Browse files
binarywangbinarywang
committed
add maven-checkstyle-plugin
1 parent fd4b8e1 commit b3f50e2

2 files changed

Lines changed: 237 additions & 0 deletions

File tree

‎pom.xml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -349,6 +349,26 @@
349349
<encoding>UTF-8</encoding>
350350
</configuration>
351351
</plugin>
352+
353+
<plugin>
354+
<groupId>org.apache.maven.plugins</groupId>
355+
<artifactId>maven-checkstyle-plugin</artifactId>
356+
<version>2.17</version>
357+
<configuration>
358+
<configLocation>quality-checks/google_checks.xml</configLocation>
359+
<includeTestSourceDirectory>true</includeTestSourceDirectory>
360+
<consoleOutput>true</consoleOutput>
361+
<failsOnError>true</failsOnError>
362+
</configuration>
363+
<executions>
364+
<execution>
365+
<phase>verify</phase>
366+
<goals>
367+
<goal>check</goal>
368+
</goals>
369+
</execution>
370+
</executions>
371+
</plugin>
352372
</plugins>
353373
</build>
354374

‎quality-checks/google_checks.xml‎

Lines changed: 217 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,217 @@
1+
<?xml version="1.0"?>
2+
<!DOCTYPE module PUBLIC
3+
"-//Puppy Crawl//DTD Check Configuration 1.3//EN"
4+
"http://checkstyle.sourceforge.net/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.sf.net (or in your downloaded distribution).
12+
13+
To completely disable a check, just comment it out or delete it from the file.
14+
15+
Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov.
16+
-->
17+
18+
<module name = "Checker">
19+
<property name="charset" value="UTF-8"/>
20+
21+
<property name="severity" value="warning"/>
22+
23+
<property name="fileExtensions" value="java, properties, xml"/>
24+
<!-- Checks for whitespace -->
25+
<!-- See http://checkstyle.sf.net/config_whitespace.html -->
26+
<module name="FileTabCharacter">
27+
<property name="eachLine" value="true"/>
28+
</module>
29+
30+
<module name="TreeWalker">
31+
<module name="OuterTypeFilename"/>
32+
<module name="IllegalTokenText">
33+
<property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
34+
<property name="format" 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)"/>
35+
<property name="message" value="Consider using special escape sequence instead of octal value or Unicode escaped value."/>
36+
</module>
37+
<module name="AvoidEscapedUnicodeCharacters">
38+
<property name="allowEscapesForControlCharacters" value="true"/>
39+
<property name="allowByTailComment" value="true"/>
40+
<property name="allowNonPrintableEscapes" value="true"/>
41+
</module>
42+
<module name="LineLength">
43+
<property name="max" value="100"/>
44+
<property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
45+
</module>
46+
<module name="AvoidStarImport"/>
47+
<module name="OneTopLevelClass"/>
48+
<module name="NoLineWrap"/>
49+
<module name="EmptyBlock">
50+
<property name="option" value="TEXT"/>
51+
<property name="tokens" value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
52+
</module>
53+
<module name="NeedBraces"/>
54+
<module name="LeftCurly">
55+
<property name="maxLineLength" value="100"/>
56+
</module>
57+
<module name="RightCurly">
58+
<property name="id" value="RightCurlySame"/>
59+
<property name="tokens" value="LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_DO"/>
60+
</module>
61+
<module name="RightCurly">
62+
<property name="id" value="RightCurlyAlone"/>
63+
<property name="option" value="alone"/>
64+
<property name="tokens" value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, STATIC_INIT, INSTANCE_INIT"/>
65+
</module>
66+
<module name="WhitespaceAround">
67+
<property name="allowEmptyConstructors" value="true"/>
68+
<property name="allowEmptyMethods" value="true"/>
69+
<property name="allowEmptyTypes" value="true"/>
70+
<property name="allowEmptyLoops" value="true"/>
71+
<message key="ws.notFollowed"
72+
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)"/>
73+
<message key="ws.notPreceded"
74+
value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
75+
</module>
76+
<module name="OneStatementPerLine"/>
77+
<module name="MultipleVariableDeclarations"/>
78+
<module name="ArrayTypeStyle"/>
79+
<module name="MissingSwitchDefault"/>
80+
<module name="FallThrough"/>
81+
<module name="UpperEll"/>
82+
<module name="ModifierOrder"/>
83+
<module name="EmptyLineSeparator">
84+
<property name="allowNoEmptyLineBetweenFields" value="true"/>
85+
</module>
86+
<module name="SeparatorWrap">
87+
<property name="id" value="SeparatorWrapDot"/>
88+
<property name="tokens" value="DOT"/>
89+
<property name="option" value="nl"/>
90+
</module>
91+
<module name="SeparatorWrap">
92+
<property name="id" value="SeparatorWrapComma"/>
93+
<property name="tokens" value="COMMA"/>
94+
<property name="option" value="EOL"/>
95+
</module>
96+
<module name="SeparatorWrap">
97+
<property name="id" value="SeparatorWrapMethodRef"/>
98+
<property name="option" value="nl"/>
99+
</module>
100+
<module name="PackageName">
101+
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
102+
<message key="name.invalidPattern"
103+
value="Package name ''{0}'' must match pattern ''{1}''."/>
104+
</module>
105+
<module name="TypeName">
106+
<message key="name.invalidPattern"
107+
value="Type name ''{0}'' must match pattern ''{1}''."/>
108+
</module>
109+
<module name="MemberName">
110+
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
111+
<message key="name.invalidPattern"
112+
value="Member name ''{0}'' must match pattern ''{1}''."/>
113+
</module>
114+
<module name="ParameterName">
115+
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
116+
<message key="name.invalidPattern"
117+
value="Parameter name ''{0}'' must match pattern ''{1}''."/>
118+
</module>
119+
<module name="LocalVariableName">
120+
<property name="tokens" value="VARIABLE_DEF"/>
121+
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
122+
<message key="name.invalidPattern"
123+
value="Local variable name ''{0}'' must match pattern ''{1}''."/>
124+
</module>
125+
<module name="ClassTypeParameterName">
126+
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
127+
<message key="name.invalidPattern"
128+
value="Class type name ''{0}'' must match pattern ''{1}''."/>
129+
</module>
130+
<module name="MethodTypeParameterName">
131+
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
132+
<message key="name.invalidPattern"
133+
value="Method type name ''{0}'' must match pattern ''{1}''."/>
134+
</module>
135+
<module name="InterfaceTypeParameterName">
136+
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
137+
<message key="name.invalidPattern"
138+
value="Interface type name ''{0}'' must match pattern ''{1}''."/>
139+
</module>
140+
<module name="NoFinalizer"/>
141+
<module name="GenericWhitespace">
142+
<message key="ws.followed"
143+
value="GenericWhitespace ''{0}'' is followed by whitespace."/>
144+
<message key="ws.preceded"
145+
value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
146+
<message key="ws.illegalFollow"
147+
value="GenericWhitespace ''{0}'' should followed by whitespace."/>
148+
<message key="ws.notPreceded"
149+
value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
150+
</module>
151+
<module name="Indentation">
152+
<property name="basicOffset" value="2"/>
153+
<property name="braceAdjustment" value="0"/>
154+
<property name="caseIndent" value="2"/>
155+
<property name="throwsIndent" value="4"/>
156+
<property name="lineWrappingIndentation" value="4"/>
157+
<property name="arrayInitIndent" value="2"/>
158+
</module>
159+
<module name="AbbreviationAsWordInName">
160+
<property name="ignoreFinal" value="false"/>
161+
<property name="allowedAbbreviationLength" value="1"/>
162+
</module>
163+
<module name="OverloadMethodsDeclarationOrder"/>
164+
<module name="VariableDeclarationUsageDistance"/>
165+
<module name="CustomImportOrder">
166+
<property name="sortImportsInGroupAlphabetically" value="true"/>
167+
<property name="separateLineBetweenGroups" value="true"/>
168+
<property name="customImportOrderRules" value="STATIC###THIRD_PARTY_PACKAGE"/>
169+
</module>
170+
<module name="MethodParamPad"/>
171+
<module name="ParenPad"/>
172+
<module name="OperatorWrap">
173+
<property name="option" value="NL"/>
174+
<property name="tokens" value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR, LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR "/>
175+
</module>
176+
<module name="AnnotationLocation">
177+
<property name="id" value="AnnotationLocationMostCases"/>
178+
<property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/>
179+
</module>
180+
<module name="AnnotationLocation">
181+
<property name="id" value="AnnotationLocationVariables"/>
182+
<property name="tokens" value="VARIABLE_DEF"/>
183+
<property name="allowSamelineMultipleAnnotations" value="true"/>
184+
</module>
185+
<module name="NonEmptyAtclauseDescription"/>
186+
<module name="JavadocTagContinuationIndentation"/>
187+
<module name="SummaryJavadoc">
188+
<property name="forbiddenSummaryFragments" value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
189+
</module>
190+
<module name="JavadocParagraph"/>
191+
<module name="AtclauseOrder">
192+
<property name="tagOrder" value="@param, @return, @throws, @deprecated"/>
193+
<property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
194+
</module>
195+
<module name="JavadocMethod">
196+
<property name="scope" value="public"/>
197+
<property name="allowMissingParamTags" value="true"/>
198+
<property name="allowMissingThrowsTags" value="true"/>
199+
<property name="allowMissingReturnTag" value="true"/>
200+
<property name="minLineCount" value="2"/>
201+
<property name="allowedAnnotations" value="Override, Test"/>
202+
<property name="allowThrowsTagsForSubclasses" value="true"/>
203+
</module>
204+
<module name="MethodName">
205+
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
206+
<message key="name.invalidPattern"
207+
value="Method name ''{0}'' must match pattern ''{1}''."/>
208+
</module>
209+
<module name="SingleLineJavadoc">
210+
<property name="ignoreInlineTags" value="false"/>
211+
</module>
212+
<module name="EmptyCatchBlock">
213+
<property name="exceptionVariableName" value="expected"/>
214+
</module>
215+
<module name="CommentsIndentation"/>
216+
</module>
217+
</module>

0 commit comments

Comments
 (0)