Skip to content

Commit 04c0810

Browse files
author
Bruce Eckel
committed
Added support for checkstyle
Not polished, but it works.
1 parent c497c38 commit 04c0810

File tree

2 files changed

+187
-0
lines changed

2 files changed

+187
-0
lines changed

‎build.gradle

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,7 @@ subprojects {
134134
apply plugin: 'me.champeau.gradle.jmh'
135135
apply plugin: 'java'
136136
apply plugin: 'org.junit.platform.gradle.plugin'
137+
apply plugin: 'checkstyle'
137138

138139
sourceCompatibility = '1.8'
139140
targetCompatibility = '1.8'
@@ -174,6 +175,14 @@ subprojects {
174175
//logManager 'org.apache.logging.log4j.jul.LogManager'
175176
}
176177

178+
// See: http://blog.jessitron.com/2012/07/using-checkstyle-in-gradle.html
179+
// https://github.com/checkstyle/checkstyle/blob/master/src/main/resources/google_checks.xml
180+
// http://checkstyle.sourceforge.net/reports/google-java-style.html
181+
checkstyle {
182+
configFile = new File(rootDir, "checkstyle.xml")
183+
toolVersion = '6.7'
184+
}
185+
177186
sourceSets {
178187
main {
179188
java {

‎checkstyle.xml

Lines changed: 178 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,178 @@
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+
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(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)"/>
35+
<property name="message" value="Avoid using corresponding octal or Unicode escape."/>
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="OneTopLevelClass"/>
47+
<module name="NoLineWrap"/>
48+
<module name="EmptyBlock">
49+
<property name="option" value="TEXT"/>
50+
<property name="tokens" value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
51+
</module>
52+
<module name="NeedBraces"/>
53+
<module name="LeftCurly">
54+
<property name="maxLineLength" value="100"/>
55+
</module>
56+
<module name="RightCurly"/>
57+
<module name="RightCurly">
58+
<property name="option" value="alone"/>
59+
<property name="tokens" value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, LITERAL_DO, STATIC_INIT, INSTANCE_INIT"/>
60+
</module>
61+
<module name="OneStatementPerLine"/>
62+
<module name="MultipleVariableDeclarations"/>
63+
<module name="ArrayTypeStyle"/>
64+
<module name="MissingSwitchDefault"/>
65+
<module name="FallThrough"/>
66+
<module name="UpperEll"/>
67+
<module name="ModifierOrder"/>
68+
<module name="SeparatorWrap">
69+
<property name="tokens" value="DOT"/>
70+
<property name="option" value="nl"/>
71+
</module>
72+
<module name="SeparatorWrap">
73+
<property name="tokens" value="COMMA"/>
74+
<property name="option" value="EOL"/>
75+
</module>
76+
<module name="PackageName">
77+
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
78+
<message key="name.invalidPattern"
79+
value="Package name ''{0}'' must match pattern ''{1}''."/>
80+
</module>
81+
<module name="TypeName">
82+
<message key="name.invalidPattern"
83+
value="Type name ''{0}'' must match pattern ''{1}''."/>
84+
</module>
85+
<module name="MemberName">
86+
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
87+
<message key="name.invalidPattern"
88+
value="Member name ''{0}'' must match pattern ''{1}''."/>
89+
</module>
90+
<module name="ParameterName">
91+
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
92+
<message key="name.invalidPattern"
93+
value="Parameter name ''{0}'' must match pattern ''{1}''."/>
94+
</module>
95+
<!-- <module name="CatchParameterName">
96+
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
97+
<message key="name.invalidPattern"
98+
value="Catch parameter name ''{0}'' must match pattern ''{1}''."/>
99+
</module> -->
100+
<module name="LocalVariableName">
101+
<property name="tokens" value="VARIABLE_DEF"/>
102+
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
103+
<property name="allowOneCharVarInForLoop" value="true"/>
104+
<message key="name.invalidPattern"
105+
value="Local variable name ''{0}'' must match pattern ''{1}''."/>
106+
</module>
107+
<module name="ClassTypeParameterName">
108+
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
109+
<message key="name.invalidPattern"
110+
value="Class type name ''{0}'' must match pattern ''{1}''."/>
111+
</module>
112+
<module name="MethodTypeParameterName">
113+
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
114+
<message key="name.invalidPattern"
115+
value="Method type name ''{0}'' must match pattern ''{1}''."/>
116+
</module>
117+
<module name="InterfaceTypeParameterName">
118+
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
119+
<message key="name.invalidPattern"
120+
value="Interface type name ''{0}'' must match pattern ''{1}''."/>
121+
</module>
122+
<module name="NoFinalizer"/>
123+
<module name="GenericWhitespace">
124+
<message key="ws.followed"
125+
value="GenericWhitespace ''{0}'' is followed by whitespace."/>
126+
<message key="ws.preceded"
127+
value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
128+
<message key="ws.illegalFollow"
129+
value="GenericWhitespace ''{0}'' should followed by whitespace."/>
130+
<message key="ws.notPreceded"
131+
value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
132+
</module>
133+
<module name="Indentation">
134+
<property name="basicOffset" value="2"/>
135+
<property name="braceAdjustment" value="0"/>
136+
<property name="caseIndent" value="2"/>
137+
<property name="throwsIndent" value="4"/>
138+
<property name="lineWrappingIndentation" value="4"/>
139+
<property name="arrayInitIndent" value="2"/>
140+
</module>
141+
<module name="AbbreviationAsWordInName">
142+
<property name="ignoreFinal" value="false"/>
143+
<property name="allowedAbbreviationLength" value="1"/>
144+
</module>
145+
<module name="OverloadMethodsDeclarationOrder"/>
146+
<module name="VariableDeclarationUsageDistance"/>
147+
<module name="CustomImportOrder">
148+
<property name="specialImportsRegExp" value="com.google"/>
149+
<property name="sortImportsInGroupAlphabetically" value="true"/>
150+
<property name="customImportOrderRules" value="STATIC###SPECIAL_IMPORTS###THIRD_PARTY_PACKAGE###STANDARD_JAVA_PACKAGE"/>
151+
</module>
152+
<module name="MethodParamPad"/>
153+
<module name="OperatorWrap">
154+
<property name="option" value="NL"/>
155+
<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 "/>
156+
</module>
157+
<module name="AnnotationLocation">
158+
<property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/>
159+
</module>
160+
<module name="AnnotationLocation">
161+
<property name="tokens" value="VARIABLE_DEF"/>
162+
<property name="allowSamelineMultipleAnnotations" value="true"/>
163+
</module>
164+
<module name="NonEmptyAtclauseDescription"/>
165+
<module name="AtclauseOrder">
166+
<property name="tagOrder" value="@param, @return, @throws, @deprecated"/>
167+
<property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
168+
</module>
169+
<module name="MethodName">
170+
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
171+
<message key="name.invalidPattern"
172+
value="Method name ''{0}'' must match pattern ''{1}''."/>
173+
</module>
174+
<module name="EmptyCatchBlock">
175+
<property name="exceptionVariableName" value="expected"/>
176+
</module>
177+
</module>
178+
</module>

0 commit comments

Comments
 (0)