Skip to content

Commit a033c07

Browse files
iluwatariluwatar
committed
Merge pull request iluwatar#246 from zafarella/add-checkstyle-into-maven
Add checkstyle into maven iluwatar#224
2 parents 6176f13 + 266aca2 commit a033c07

File tree

2 files changed

+235
-2
lines changed

2 files changed

+235
-2
lines changed

‎checkstyle.xml

Lines changed: 208 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,208 @@
1+
<?xml version="1.0"?>
2+
<!DOCTYPE module PUBLIC
3+
"-//Puppy Crawl//DTD Check Configuration 1.3//EN"
4+
"http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
5+
6+
<!--
7+
8+
Source = https://github.com/checkstyle/checkstyle/tree/master/src/main/resources
9+
10+
Checkstyle configurartion that checks the Google coding conventions from:
11+
12+
- Google Java Style
13+
https://google-styleguide.googlecode.com/svn-history/r130/trunk/javaguide.html
14+
15+
Checkstyle is very configurable. Be sure to read the documentation at
16+
http://checkstyle.sf.net (or in your downloaded distribution).
17+
18+
Most Checks are configurable, be sure to consult the documentation.
19+
20+
To completely disable a check, just comment it out or delete it from the file.
21+
22+
Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov.
23+
24+
-->
25+
26+
<module name="Checker">
27+
<property name="charset" value="UTF-8"/>
28+
29+
<property name="severity" value="warning"/>
30+
31+
<!-- Checks for whitespace -->
32+
<!-- See http://checkstyle.sf.net/config_whitespace.html -->
33+
<module name="FileTabCharacter">
34+
<property name="eachLine" value="true"/>
35+
</module>
36+
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(08|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" value="Avoid using corresponding octal or Unicode escape."/>
44+
</module>
45+
<module name="AvoidEscapedUnicodeCharacters">
46+
<property name="allowEscapesForControlCharacters" value="true"/>
47+
<property name="allowByTailComment" value="true"/>
48+
<property name="allowNonPrintableEscapes" value="true"/>
49+
</module>
50+
<module name="LineLength">
51+
<property name="max" value="100"/>
52+
<property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
53+
</module>
54+
<module name="AvoidStarImport"/>
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_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
61+
</module>
62+
<module name="NeedBraces"/>
63+
<module name="LeftCurly">
64+
<property name="maxLineLength" value="100"/>
65+
</module>
66+
<module name="RightCurly"/>
67+
<module name="RightCurly">
68+
<property name="option" value="alone"/>
69+
<property name="tokens"
70+
value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, LITERAL_DO, STATIC_INIT, INSTANCE_INIT"/>
71+
</module>
72+
<module name="WhitespaceAround">
73+
<property name="allowEmptyConstructors" value="true"/>
74+
<property name="allowEmptyMethods" value="true"/>
75+
<property name="allowEmptyTypes" value="true"/>
76+
<property name="allowEmptyLoops" value="true"/>
77+
<message key="ws.notFollowed"
78+
value="WhitespaceAround: ''{0}'' is not followed by whitespace."/>
79+
<message key="ws.notPreceded"
80+
value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
81+
</module>
82+
<module name="OneStatementPerLine"/>
83+
<module name="MultipleVariableDeclarations"/>
84+
<module name="ArrayTypeStyle"/>
85+
<module name="MissingSwitchDefault"/>
86+
<module name="FallThrough"/>
87+
<module name="UpperEll"/>
88+
<module name="ModifierOrder"/>
89+
<module name="EmptyLineSeparator">
90+
<property name="allowNoEmptyLineBetweenFields" value="true"/>
91+
</module>
92+
<module name="SeparatorWrap">
93+
<property name="tokens" value="DOT"/>
94+
<property name="option" value="nl"/>
95+
</module>
96+
<module name="SeparatorWrap">
97+
<property name="tokens" value="COMMA"/>
98+
<property name="option" value="EOL"/>
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+
<property name="allowOneCharVarInForLoop" value="true"/>
123+
<message key="name.invalidPattern"
124+
value="Local variable name ''{0}'' must match pattern ''{1}''."/>
125+
</module>
126+
<module name="ClassTypeParameterName">
127+
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
128+
<message key="name.invalidPattern"
129+
value="Class type name ''{0}'' must match pattern ''{1}''."/>
130+
</module>
131+
<module name="MethodTypeParameterName">
132+
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
133+
<message key="name.invalidPattern"
134+
value="Method type name ''{0}'' must match pattern ''{1}''."/>
135+
</module>
136+
<module name="NoFinalizer"/>
137+
<module name="GenericWhitespace">
138+
<message key="ws.followed"
139+
value="GenericWhitespace ''{0}'' is followed by whitespace."/>
140+
<message key="ws.preceded"
141+
value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
142+
<message key="ws.illegalFollow"
143+
value="GenericWhitespace ''{0}'' should followed by whitespace."/>
144+
<message key="ws.notPreceded"
145+
value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
146+
</module>
147+
<module name="Indentation">
148+
<property name="basicOffset" value="2"/>
149+
<property name="braceAdjustment" value="0"/>
150+
<property name="caseIndent" value="2"/>
151+
<property name="throwsIndent" value="4"/>
152+
<property name="lineWrappingIndentation" value="4"/>
153+
<property name="arrayInitIndent" value="2"/>
154+
</module>
155+
<module name="AbbreviationAsWordInName">
156+
<property name="ignoreFinal" value="false"/>
157+
<property name="allowedAbbreviationLength" value="1"/>
158+
</module>
159+
<module name="OverloadMethodsDeclarationOrder"/>
160+
<module name="VariableDeclarationUsageDistance"/>
161+
<module name="CustomImportOrder">
162+
<property name="thirdPartyPackageRegExp" value=".*"/>
163+
<property name="specialImportsRegExp" value="com.google"/>
164+
<property name="sortImportsInGroupAlphabetically" value="true"/>
165+
<property name="customImportOrderRules"
166+
value="STATIC###SPECIAL_IMPORTS###THIRD_PARTY_PACKAGE###STANDARD_JAVA_PACKAGE"/>
167+
</module>
168+
<module name="MethodParamPad"/>
169+
<module name="OperatorWrap">
170+
<property name="option" value="NL"/>
171+
<property name="tokens"
172+
value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR, LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR "/>
173+
</module>
174+
<module name="AnnotationLocation">
175+
<property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/>
176+
</module>
177+
<module name="AnnotationLocation">
178+
<property name="tokens" value="VARIABLE_DEF"/>
179+
<property name="allowSamelineMultipleAnnotations" value="true"/>
180+
</module>
181+
<module name="NonEmptyAtclauseDescription"/>
182+
<module name="JavadocTagContinuationIndentation"/>
183+
<module name="SummaryJavadocCheck">
184+
<property name="forbiddenSummaryFragments"
185+
value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
186+
</module>
187+
<module name="JavadocParagraph"/>
188+
<module name="AtclauseOrder">
189+
<property name="tagOrder" value="@param, @return, @throws, @deprecated"/>
190+
<property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
191+
</module>
192+
<module name="JavadocMethod">
193+
<property name="scope" value="public"/>
194+
<property name="allowMissingParamTags" value="true"/>
195+
<property name="allowMissingThrowsTags" value="true"/>
196+
<property name="allowMissingReturnTag" value="true"/>
197+
<property name="minLineCount" value="2"/>
198+
<property name="allowedAnnotations" value="Override, Test"/>
199+
<property name="allowThrowsTagsForSubclasses" value="true"/>
200+
</module>
201+
<module name="MethodName">
202+
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
203+
<message key="name.invalidPattern"
204+
value="Method name ''{0}'' must match pattern ''{1}''."/>
205+
</module>
206+
<module name="SingleLineJavadoc"/>
207+
</module>
208+
</module>

‎pom.xml

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
<?xml version="1.0" encoding="UTF-8"?>
2-
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
2+
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
3+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
34
<modelVersion>4.0.0</modelVersion>
45

56
<groupId>com.iluwatar</groupId>
@@ -206,7 +207,31 @@
206207
</execution>
207208
</executions>
208209
</plugin>
210+
211+
<!--checkstyle plug-in. checking against googles styles
212+
see config at checkstyle.xml
213+
-->
214+
<plugin>
215+
<groupId>org.apache.maven.plugins</groupId>
216+
<artifactId>maven-checkstyle-plugin</artifactId>
217+
<version>2.15</version>
218+
<executions>
219+
<execution>
220+
<id>validate</id>
221+
<goals>
222+
<goal>check</goal>
223+
</goals>
224+
<phase>validate</phase>
225+
<configuration>
226+
<configLocation>checkstyle.xml</configLocation>
227+
<encoding>UTF-8</encoding>
228+
<consoleOutput>false</consoleOutput>
229+
<failsOnError>false</failsOnError>
230+
</configuration>
231+
</execution>
232+
</executions>
233+
</plugin>
209234
</plugins>
210235
</build>
211236

212-
</project>
237+
</project>

0 commit comments

Comments
 (0)