Skip to content

Commit ef3514a

Browse files
airtairt
committed
build: add checkstyle
1 parent f84192d commit ef3514a

File tree

2 files changed

+265
-1
lines changed

2 files changed

+265
-1
lines changed

‎build.gradle‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
allprojects {
22

3-
apply plugin: 'java'
43
apply plugin: 'idea'
4+
apply plugin: 'java'
5+
apply plugin: 'checkstyle'
56

67
group = 'org.ridelab'
78
version = '0.0.1'
@@ -27,4 +28,9 @@ subprojects {
2728
testCompile 'junit:junit:4.12'
2829
}
2930

31+
checkstyle {
32+
toolVersion = '8.5'
33+
configFile = rootProject.file 'config/checkstyle/checkstyle.xml'
34+
}
35+
3036
}

‎config/checkstyle/checkstyle.xml‎

Lines changed: 258 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,258 @@
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+
8+
Differences to [Google's Checkstyle Configuration](http://checkstyle.sourceforge.net/google_style.html):
9+
10+
```
11+
SeparatorWrap:
12+
id: SeparatorWrapDot
13+
tokens: DOT
14+
option: EOL
15+
Indentation:
16+
throwsIndent: 2
17+
lineWrappingIndentation: 2
18+
```
19+
20+
---
21+
22+
Checkstyle configuration that checks the Google coding conventions from Google Java Style
23+
that can be found at https://google.github.io/styleguide/javaguide.html.
24+
25+
Checkstyle is very configurable. Be sure to read the documentation at
26+
http://checkstyle.sf.net (or in your downloaded distribution).
27+
28+
To completely disable a check, just comment it out or delete it from the file.
29+
30+
Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov.
31+
32+
-->
33+
34+
<module name="Checker">
35+
<property name="charset" value="UTF-8"/>
36+
37+
<property name="severity" value="warning"/>
38+
39+
<property name="fileExtensions" value="java, properties, xml"/>
40+
<!-- Checks for whitespace -->
41+
<!-- See http://checkstyle.sf.net/config_whitespace.html -->
42+
<module name="FileTabCharacter">
43+
<property name="eachLine" value="true"/>
44+
</module>
45+
46+
<module name="TreeWalker">
47+
<module name="OuterTypeFilename"/>
48+
<module name="IllegalTokenText">
49+
<property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
50+
<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)"/>
51+
<property name="message"
52+
value="Consider using special escape sequence instead of octal value or Unicode escaped value."/>
53+
</module>
54+
<module name="AvoidEscapedUnicodeCharacters">
55+
<property name="allowEscapesForControlCharacters" value="true"/>
56+
<property name="allowByTailComment" value="true"/>
57+
<property name="allowNonPrintableEscapes" value="true"/>
58+
</module>
59+
<module name="LineLength">
60+
<property name="max" value="100"/>
61+
<property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
62+
</module>
63+
<module name="AvoidStarImport"/>
64+
<module name="OneTopLevelClass"/>
65+
<module name="NoLineWrap"/>
66+
<module name="EmptyBlock">
67+
<property name="option" value="TEXT"/>
68+
<property name="tokens" value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
69+
</module>
70+
<module name="NeedBraces"/>
71+
<module name="LeftCurly"/>
72+
<module name="RightCurly">
73+
<property name="id" value="RightCurlySame"/>
74+
<property name="tokens"
75+
value="LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_DO"/>
76+
</module>
77+
<module name="RightCurly">
78+
<property name="id" value="RightCurlyAlone"/>
79+
<property name="option" value="alone"/>
80+
<property name="tokens"
81+
value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, STATIC_INIT, INSTANCE_INIT"/>
82+
</module>
83+
<module name="WhitespaceAround">
84+
<property name="allowEmptyConstructors" value="true"/>
85+
<property name="allowEmptyMethods" value="true"/>
86+
<property name="allowEmptyTypes" value="true"/>
87+
<property name="allowEmptyLoops" value="true"/>
88+
<message key="ws.notFollowed"
89+
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)"/>
90+
<message key="ws.notPreceded"
91+
value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
92+
</module>
93+
<module name="OneStatementPerLine"/>
94+
<module name="MultipleVariableDeclarations"/>
95+
<module name="ArrayTypeStyle"/>
96+
<module name="MissingSwitchDefault"/>
97+
<module name="FallThrough"/>
98+
<module name="UpperEll"/>
99+
<module name="ModifierOrder"/>
100+
<module name="EmptyLineSeparator">
101+
<property name="allowNoEmptyLineBetweenFields" value="true"/>
102+
</module>
103+
<module name="SeparatorWrap">
104+
<property name="id" value="SeparatorWrapDot"/>
105+
<property name="tokens" value="DOT"/>
106+
<property name="option" value="EOL"/>
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="CatchParameterName">
150+
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
151+
<message key="name.invalidPattern"
152+
value="Catch parameter name ''{0}'' must match pattern ''{1}''."/>
153+
</module>
154+
<module name="LocalVariableName">
155+
<property name="tokens" value="VARIABLE_DEF"/>
156+
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
157+
<message key="name.invalidPattern"
158+
value="Local variable name ''{0}'' must match pattern ''{1}''."/>
159+
</module>
160+
<module name="ClassTypeParameterName">
161+
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
162+
<message key="name.invalidPattern"
163+
value="Class type name ''{0}'' must match pattern ''{1}''."/>
164+
</module>
165+
<module name="MethodTypeParameterName">
166+
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
167+
<message key="name.invalidPattern"
168+
value="Method type name ''{0}'' must match pattern ''{1}''."/>
169+
</module>
170+
<module name="InterfaceTypeParameterName">
171+
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
172+
<message key="name.invalidPattern"
173+
value="Interface type name ''{0}'' must match pattern ''{1}''."/>
174+
</module>
175+
<module name="NoFinalizer"/>
176+
<module name="GenericWhitespace">
177+
<message key="ws.followed"
178+
value="GenericWhitespace ''{0}'' is followed by whitespace."/>
179+
<message key="ws.preceded"
180+
value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
181+
<message key="ws.illegalFollow"
182+
value="GenericWhitespace ''{0}'' should followed by whitespace."/>
183+
<message key="ws.notPreceded"
184+
value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
185+
</module>
186+
<module name="Indentation">
187+
<property name="basicOffset" value="2"/>
188+
<property name="braceAdjustment" value="0"/>
189+
<property name="caseIndent" value="2"/>
190+
<property name="throwsIndent" value="2"/>
191+
<property name="lineWrappingIndentation" value="2"/>
192+
<property name="arrayInitIndent" value="2"/>
193+
</module>
194+
<module name="AbbreviationAsWordInName">
195+
<property name="ignoreFinal" value="false"/>
196+
<property name="allowedAbbreviationLength" value="1"/>
197+
</module>
198+
<module name="OverloadMethodsDeclarationOrder"/>
199+
<module name="VariableDeclarationUsageDistance"/>
200+
<module name="CustomImportOrder">
201+
<property name="sortImportsInGroupAlphabetically" value="true"/>
202+
<property name="separateLineBetweenGroups" value="true"/>
203+
<property name="customImportOrderRules" value="STATIC###THIRD_PARTY_PACKAGE"/>
204+
</module>
205+
<module name="MethodParamPad"/>
206+
<module name="NoWhitespaceBefore">
207+
<property name="tokens" value="COMMA, SEMI, POST_INC, POST_DEC, DOT, ELLIPSIS, METHOD_REF"/>
208+
<property name="allowLineBreaks" value="true"/>
209+
</module>
210+
<module name="ParenPad"/>
211+
<module name="OperatorWrap">
212+
<property name="option" value="NL"/>
213+
<property name="tokens"
214+
value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR, LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR, METHOD_REF "/>
215+
</module>
216+
<module name="AnnotationLocation">
217+
<property name="id" value="AnnotationLocationMostCases"/>
218+
<property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/>
219+
</module>
220+
<module name="AnnotationLocation">
221+
<property name="id" value="AnnotationLocationVariables"/>
222+
<property name="tokens" value="VARIABLE_DEF"/>
223+
<property name="allowSamelineMultipleAnnotations" value="true"/>
224+
</module>
225+
<module name="NonEmptyAtclauseDescription"/>
226+
<module name="JavadocTagContinuationIndentation"/>
227+
<module name="SummaryJavadoc">
228+
<property name="forbiddenSummaryFragments"
229+
value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
230+
</module>
231+
<module name="JavadocParagraph"/>
232+
<module name="AtclauseOrder">
233+
<property name="tagOrder" value="@param, @return, @throws, @deprecated"/>
234+
<property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
235+
</module>
236+
<module name="JavadocMethod">
237+
<property name="scope" value="public"/>
238+
<property name="allowMissingParamTags" value="true"/>
239+
<property name="allowMissingThrowsTags" value="true"/>
240+
<property name="allowMissingReturnTag" value="true"/>
241+
<property name="minLineCount" value="2"/>
242+
<property name="allowedAnnotations" value="Override, Test"/>
243+
<property name="allowThrowsTagsForSubclasses" value="true"/>
244+
</module>
245+
<module name="MethodName">
246+
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
247+
<message key="name.invalidPattern"
248+
value="Method name ''{0}'' must match pattern ''{1}''."/>
249+
</module>
250+
<module name="SingleLineJavadoc">
251+
<property name="ignoreInlineTags" value="false"/>
252+
</module>
253+
<module name="EmptyCatchBlock">
254+
<property name="exceptionVariableName" value="expected"/>
255+
</module>
256+
<module name="CommentsIndentation"/>
257+
</module>
258+
</module>

0 commit comments

Comments
 (0)