Skip to content

Commit 8665264

Browse files
veyndanveyndan
committed
Add Checkstyle support
1 parent 770f989 commit 8665264

File tree

3 files changed

+246
-0
lines changed

3 files changed

+246
-0
lines changed

‎app/build.gradle

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
apply plugin: 'com.android.application'
2+
apply from: 'quality.gradle'
23

34
dependencies {
45
compile ('com.github.nicolas-raoul:Quadtree:211b6fe59ac48f') {

‎app/quality.gradle

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
apply plugin: 'checkstyle'
2+
3+
check.dependsOn 'checkstyle'
4+
5+
checkstyle {
6+
toolVersion = '7.5.1'
7+
}
8+
9+
task checkstyle(type: Checkstyle) {
10+
configFile file("${project.rootDir}/script/style/checkstyle.xml")
11+
source 'src'
12+
include '**/*.java'
13+
exclude '**/gen/**'
14+
15+
classpath = files()
16+
17+
reports {
18+
html {
19+
enabled true
20+
destination "$project.buildDir/reports/checkstyle/checkstyle.html"
21+
}
22+
}
23+
}

‎script/style/checkstyle.xml

+222
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,222 @@
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+
Modified from https://github.com/checkstyle/checkstyle/blob/master/src/main/resources/google_checks.xml.
8+
Modifications are:
9+
- doubled each value in Indentation
10+
11+
Checkstyle configuration that checks the Google coding conventions from Google Java Style
12+
that can be found at https://google.github.io/styleguide/javaguide.html.
13+
14+
Checkstyle is very configurable. Be sure to read the documentation at
15+
http://checkstyle.sf.net (or in your downloaded distribution).
16+
17+
To completely disable a check, just comment it out or delete it from the file.
18+
19+
Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov.
20+
-->
21+
22+
<module name = "Checker">
23+
<property name="charset" value="UTF-8"/>
24+
25+
<property name="severity" value="warning"/>
26+
27+
<property name="fileExtensions" value="java, properties, xml"/>
28+
<!-- Checks for whitespace -->
29+
<!-- See http://checkstyle.sf.net/config_whitespace.html -->
30+
<module name="FileTabCharacter">
31+
<property name="eachLine" value="true"/>
32+
</module>
33+
34+
<module name="TreeWalker">
35+
<module name="OuterTypeFilename"/>
36+
<module name="IllegalTokenText">
37+
<property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
38+
<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)"/>
39+
<property name="message" value="Consider using special escape sequence instead of octal value or Unicode escaped value."/>
40+
</module>
41+
<module name="AvoidEscapedUnicodeCharacters">
42+
<property name="allowEscapesForControlCharacters" value="true"/>
43+
<property name="allowByTailComment" value="true"/>
44+
<property name="allowNonPrintableEscapes" value="true"/>
45+
</module>
46+
<module name="LineLength">
47+
<property name="max" value="100"/>
48+
<property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
49+
</module>
50+
<module name="AvoidStarImport"/>
51+
<module name="OneTopLevelClass"/>
52+
<module name="NoLineWrap"/>
53+
<module name="EmptyBlock">
54+
<property name="option" value="TEXT"/>
55+
<property name="tokens" value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
56+
</module>
57+
<module name="NeedBraces"/>
58+
<module name="LeftCurly">
59+
<property name="maxLineLength" value="100"/>
60+
</module>
61+
<module name="RightCurly">
62+
<property name="id" value="RightCurlySame"/>
63+
<property name="tokens" value="LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_DO"/>
64+
</module>
65+
<module name="RightCurly">
66+
<property name="id" value="RightCurlyAlone"/>
67+
<property name="option" value="alone"/>
68+
<property name="tokens" value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, STATIC_INIT, INSTANCE_INIT"/>
69+
</module>
70+
<module name="WhitespaceAround">
71+
<property name="allowEmptyConstructors" value="true"/>
72+
<property name="allowEmptyMethods" value="true"/>
73+
<property name="allowEmptyTypes" value="true"/>
74+
<property name="allowEmptyLoops" value="true"/>
75+
<message key="ws.notFollowed"
76+
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)"/>
77+
<message key="ws.notPreceded"
78+
value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
79+
</module>
80+
<module name="OneStatementPerLine"/>
81+
<module name="MultipleVariableDeclarations"/>
82+
<module name="ArrayTypeStyle"/>
83+
<module name="MissingSwitchDefault"/>
84+
<module name="FallThrough"/>
85+
<module name="UpperEll"/>
86+
<module name="ModifierOrder"/>
87+
<module name="EmptyLineSeparator">
88+
<property name="allowNoEmptyLineBetweenFields" value="true"/>
89+
</module>
90+
<module name="SeparatorWrap">
91+
<property name="id" value="SeparatorWrapDot"/>
92+
<property name="tokens" value="DOT"/>
93+
<property name="option" value="nl"/>
94+
</module>
95+
<module name="SeparatorWrap">
96+
<property name="id" value="SeparatorWrapComma"/>
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="CatchParameterName">
120+
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
121+
<message key="name.invalidPattern"
122+
value="Catch parameter name ''{0}'' must match pattern ''{1}''."/>
123+
</module>
124+
<module name="LocalVariableName">
125+
<property name="tokens" value="VARIABLE_DEF"/>
126+
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
127+
<message key="name.invalidPattern"
128+
value="Local variable name ''{0}'' must match pattern ''{1}''."/>
129+
</module>
130+
<module name="ClassTypeParameterName">
131+
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
132+
<message key="name.invalidPattern"
133+
value="Class type name ''{0}'' must match pattern ''{1}''."/>
134+
</module>
135+
<module name="MethodTypeParameterName">
136+
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
137+
<message key="name.invalidPattern"
138+
value="Method type name ''{0}'' must match pattern ''{1}''."/>
139+
</module>
140+
<module name="InterfaceTypeParameterName">
141+
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
142+
<message key="name.invalidPattern"
143+
value="Interface type name ''{0}'' must match pattern ''{1}''."/>
144+
</module>
145+
<module name="NoFinalizer"/>
146+
<module name="GenericWhitespace">
147+
<message key="ws.followed"
148+
value="GenericWhitespace ''{0}'' is followed by whitespace."/>
149+
<message key="ws.preceded"
150+
value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
151+
<message key="ws.illegalFollow"
152+
value="GenericWhitespace ''{0}'' should followed by whitespace."/>
153+
<message key="ws.notPreceded"
154+
value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
155+
</module>
156+
<module name="Indentation">
157+
<property name="basicOffset" value="4"/>
158+
<property name="braceAdjustment" value="0"/>
159+
<property name="caseIndent" value="4"/>
160+
<property name="throwsIndent" value="8"/>
161+
<property name="lineWrappingIndentation" value="8"/>
162+
<property name="arrayInitIndent" value="4"/>
163+
</module>
164+
<module name="AbbreviationAsWordInName">
165+
<property name="ignoreFinal" value="false"/>
166+
<property name="allowedAbbreviationLength" value="1"/>
167+
</module>
168+
<module name="OverloadMethodsDeclarationOrder"/>
169+
<module name="VariableDeclarationUsageDistance"/>
170+
<module name="CustomImportOrder">
171+
<property name="sortImportsInGroupAlphabetically" value="true"/>
172+
<property name="separateLineBetweenGroups" value="true"/>
173+
<property name="customImportOrderRules" value="STATIC###THIRD_PARTY_PACKAGE"/>
174+
</module>
175+
<module name="MethodParamPad"/>
176+
<module name="ParenPad"/>
177+
<module name="OperatorWrap">
178+
<property name="option" value="NL"/>
179+
<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, METHOD_REF "/>
180+
</module>
181+
<module name="AnnotationLocation">
182+
<property name="id" value="AnnotationLocationMostCases"/>
183+
<property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/>
184+
</module>
185+
<module name="AnnotationLocation">
186+
<property name="id" value="AnnotationLocationVariables"/>
187+
<property name="tokens" value="VARIABLE_DEF"/>
188+
<property name="allowSamelineMultipleAnnotations" value="true"/>
189+
</module>
190+
<module name="NonEmptyAtclauseDescription"/>
191+
<module name="JavadocTagContinuationIndentation"/>
192+
<module name="SummaryJavadoc">
193+
<property name="forbiddenSummaryFragments" value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
194+
</module>
195+
<module name="JavadocParagraph"/>
196+
<module name="AtclauseOrder">
197+
<property name="tagOrder" value="@param, @return, @throws, @deprecated"/>
198+
<property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
199+
</module>
200+
<module name="JavadocMethod">
201+
<property name="scope" value="public"/>
202+
<property name="allowMissingParamTags" value="true"/>
203+
<property name="allowMissingThrowsTags" value="true"/>
204+
<property name="allowMissingReturnTag" value="true"/>
205+
<property name="minLineCount" value="2"/>
206+
<property name="allowedAnnotations" value="Override, Test"/>
207+
<property name="allowThrowsTagsForSubclasses" value="true"/>
208+
</module>
209+
<module name="MethodName">
210+
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
211+
<message key="name.invalidPattern"
212+
value="Method name ''{0}'' must match pattern ''{1}''."/>
213+
</module>
214+
<module name="SingleLineJavadoc">
215+
<property name="ignoreInlineTags" value="false"/>
216+
</module>
217+
<module name="EmptyCatchBlock">
218+
<property name="exceptionVariableName" value="expected"/>
219+
</module>
220+
<module name="CommentsIndentation"/>
221+
</module>
222+
</module>

0 commit comments

Comments
 (0)