Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commita033c07

Browse files
committed
Merge pull requestiluwatar#246 from zafarella/add-checkstyle-into-maven
Add checkstyle into maveniluwatar#224
2 parents6176f13 +266aca2 commita033c07

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+
<!DOCTYPEmodule 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+
<modulename="Checker">
27+
<propertyname="charset"value="UTF-8"/>
28+
29+
<propertyname="severity"value="warning"/>
30+
31+
<!-- Checks for whitespace-->
32+
<!-- See http://checkstyle.sf.net/config_whitespace.html-->
33+
<modulename="FileTabCharacter">
34+
<propertyname="eachLine"value="true"/>
35+
</module>
36+
37+
<modulename="TreeWalker">
38+
<modulename="OuterTypeFilename"/>
39+
<modulename="IllegalTokenText">
40+
<propertyname="tokens"value="STRING_LITERAL, CHAR_LITERAL"/>
41+
<propertyname="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+
<propertyname="message"value="Avoid using corresponding octal or Unicode escape."/>
44+
</module>
45+
<modulename="AvoidEscapedUnicodeCharacters">
46+
<propertyname="allowEscapesForControlCharacters"value="true"/>
47+
<propertyname="allowByTailComment"value="true"/>
48+
<propertyname="allowNonPrintableEscapes"value="true"/>
49+
</module>
50+
<modulename="LineLength">
51+
<propertyname="max"value="100"/>
52+
<propertyname="ignorePattern"value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
53+
</module>
54+
<modulename="AvoidStarImport"/>
55+
<modulename="OneTopLevelClass"/>
56+
<modulename="NoLineWrap"/>
57+
<modulename="EmptyBlock">
58+
<propertyname="option"value="TEXT"/>
59+
<propertyname="tokens"
60+
value="LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
61+
</module>
62+
<modulename="NeedBraces"/>
63+
<modulename="LeftCurly">
64+
<propertyname="maxLineLength"value="100"/>
65+
</module>
66+
<modulename="RightCurly"/>
67+
<modulename="RightCurly">
68+
<propertyname="option"value="alone"/>
69+
<propertyname="tokens"
70+
value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, LITERAL_DO, STATIC_INIT, INSTANCE_INIT"/>
71+
</module>
72+
<modulename="WhitespaceAround">
73+
<propertyname="allowEmptyConstructors"value="true"/>
74+
<propertyname="allowEmptyMethods"value="true"/>
75+
<propertyname="allowEmptyTypes"value="true"/>
76+
<propertyname="allowEmptyLoops"value="true"/>
77+
<messagekey="ws.notFollowed"
78+
value="WhitespaceAround: ''{0}'' is not followed by whitespace."/>
79+
<messagekey="ws.notPreceded"
80+
value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
81+
</module>
82+
<modulename="OneStatementPerLine"/>
83+
<modulename="MultipleVariableDeclarations"/>
84+
<modulename="ArrayTypeStyle"/>
85+
<modulename="MissingSwitchDefault"/>
86+
<modulename="FallThrough"/>
87+
<modulename="UpperEll"/>
88+
<modulename="ModifierOrder"/>
89+
<modulename="EmptyLineSeparator">
90+
<propertyname="allowNoEmptyLineBetweenFields"value="true"/>
91+
</module>
92+
<modulename="SeparatorWrap">
93+
<propertyname="tokens"value="DOT"/>
94+
<propertyname="option"value="nl"/>
95+
</module>
96+
<modulename="SeparatorWrap">
97+
<propertyname="tokens"value="COMMA"/>
98+
<propertyname="option"value="EOL"/>
99+
</module>
100+
<modulename="PackageName">
101+
<propertyname="format"value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
102+
<messagekey="name.invalidPattern"
103+
value="Package name ''{0}'' must match pattern ''{1}''."/>
104+
</module>
105+
<modulename="TypeName">
106+
<messagekey="name.invalidPattern"
107+
value="Type name ''{0}'' must match pattern ''{1}''."/>
108+
</module>
109+
<modulename="MemberName">
110+
<propertyname="format"value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
111+
<messagekey="name.invalidPattern"
112+
value="Member name ''{0}'' must match pattern ''{1}''."/>
113+
</module>
114+
<modulename="ParameterName">
115+
<propertyname="format"value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
116+
<messagekey="name.invalidPattern"
117+
value="Parameter name ''{0}'' must match pattern ''{1}''."/>
118+
</module>
119+
<modulename="LocalVariableName">
120+
<propertyname="tokens"value="VARIABLE_DEF"/>
121+
<propertyname="format"value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
122+
<propertyname="allowOneCharVarInForLoop"value="true"/>
123+
<messagekey="name.invalidPattern"
124+
value="Local variable name ''{0}'' must match pattern ''{1}''."/>
125+
</module>
126+
<modulename="ClassTypeParameterName">
127+
<propertyname="format"value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
128+
<messagekey="name.invalidPattern"
129+
value="Class type name ''{0}'' must match pattern ''{1}''."/>
130+
</module>
131+
<modulename="MethodTypeParameterName">
132+
<propertyname="format"value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
133+
<messagekey="name.invalidPattern"
134+
value="Method type name ''{0}'' must match pattern ''{1}''."/>
135+
</module>
136+
<modulename="NoFinalizer"/>
137+
<modulename="GenericWhitespace">
138+
<messagekey="ws.followed"
139+
value="GenericWhitespace ''{0}'' is followed by whitespace."/>
140+
<messagekey="ws.preceded"
141+
value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
142+
<messagekey="ws.illegalFollow"
143+
value="GenericWhitespace ''{0}'' should followed by whitespace."/>
144+
<messagekey="ws.notPreceded"
145+
value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
146+
</module>
147+
<modulename="Indentation">
148+
<propertyname="basicOffset"value="2"/>
149+
<propertyname="braceAdjustment"value="0"/>
150+
<propertyname="caseIndent"value="2"/>
151+
<propertyname="throwsIndent"value="4"/>
152+
<propertyname="lineWrappingIndentation"value="4"/>
153+
<propertyname="arrayInitIndent"value="2"/>
154+
</module>
155+
<modulename="AbbreviationAsWordInName">
156+
<propertyname="ignoreFinal"value="false"/>
157+
<propertyname="allowedAbbreviationLength"value="1"/>
158+
</module>
159+
<modulename="OverloadMethodsDeclarationOrder"/>
160+
<modulename="VariableDeclarationUsageDistance"/>
161+
<modulename="CustomImportOrder">
162+
<propertyname="thirdPartyPackageRegExp"value=".*"/>
163+
<propertyname="specialImportsRegExp"value="com.google"/>
164+
<propertyname="sortImportsInGroupAlphabetically"value="true"/>
165+
<propertyname="customImportOrderRules"
166+
value="STATIC###SPECIAL_IMPORTS###THIRD_PARTY_PACKAGE###STANDARD_JAVA_PACKAGE"/>
167+
</module>
168+
<modulename="MethodParamPad"/>
169+
<modulename="OperatorWrap">
170+
<propertyname="option"value="NL"/>
171+
<propertyname="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+
<modulename="AnnotationLocation">
175+
<propertyname="tokens"value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/>
176+
</module>
177+
<modulename="AnnotationLocation">
178+
<propertyname="tokens"value="VARIABLE_DEF"/>
179+
<propertyname="allowSamelineMultipleAnnotations"value="true"/>
180+
</module>
181+
<modulename="NonEmptyAtclauseDescription"/>
182+
<modulename="JavadocTagContinuationIndentation"/>
183+
<modulename="SummaryJavadocCheck">
184+
<propertyname="forbiddenSummaryFragments"
185+
value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
186+
</module>
187+
<modulename="JavadocParagraph"/>
188+
<modulename="AtclauseOrder">
189+
<propertyname="tagOrder"value="@param, @return, @throws, @deprecated"/>
190+
<propertyname="target"value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
191+
</module>
192+
<modulename="JavadocMethod">
193+
<propertyname="scope"value="public"/>
194+
<propertyname="allowMissingParamTags"value="true"/>
195+
<propertyname="allowMissingThrowsTags"value="true"/>
196+
<propertyname="allowMissingReturnTag"value="true"/>
197+
<propertyname="minLineCount"value="2"/>
198+
<propertyname="allowedAnnotations"value="Override, Test"/>
199+
<propertyname="allowThrowsTagsForSubclasses"value="true"/>
200+
</module>
201+
<modulename="MethodName">
202+
<propertyname="format"value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
203+
<messagekey="name.invalidPattern"
204+
value="Method name ''{0}'' must match pattern ''{1}''."/>
205+
</module>
206+
<modulename="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-
<projectxmlns="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+
<projectxmlns: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)

[8]ページ先頭

©2009-2025 Movatter.jp