Skip to content

Commit fbccc57

Browse files
vorburgervorburger
committed
enforce initial set of Checkstyle rules (FINERACT-821)
This is, intentionally, for whitespace related rules, only. The idea is to now gradually extend it.
1 parent dd7503f commit fbccc57

2 files changed

Lines changed: 270 additions & 1 deletion

File tree

‎fineract-provider/build.gradle‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ apply plugin: 'project-report'
6262
apply plugin: 'java-library'
6363
apply plugin: 'openjpa'
6464
apply plugin: "com.github.spotbugs"
65-
65+
apply plugin: 'checkstyle'
6666
// apply plugin: 'pmd'
6767

6868
dependencyManagement {
@@ -467,6 +467,8 @@ configurations {
467467
}
468468
dependencies {
469469
driver 'org.drizzle.jdbc:drizzle-jdbc:1.4'
470+
checkstyle 'com.puppycrawl.tools:checkstyle:8.28'
471+
checkstyle 'com.github.sevntu-checkstyle:sevntu-checks:1.36.0'
470472
}
471473

472474
URLClassLoader loader = GroovyObject.class.classLoader

‎fineract-provider/config/checkstyle/checkstyle.xml‎

Lines changed: 267 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,267 @@
1+
<?xml version="1.0"?>
2+
<!--
3+
4+
Licensed to the Apache Software Foundation (ASF) under one
5+
or more contributor license agreements. See the NOTICE file
6+
distributed with this work for additional information
7+
regarding copyright ownership. The ASF licenses this file
8+
to you under the Apache License, Version 2.0 (the
9+
"License"); you may not use this file except in compliance
10+
with the License. You may obtain a copy of the License at
11+
12+
http://www.apache.org/licenses/LICENSE-2.0
13+
14+
Unless required by applicable law or agreed to in writing,
15+
software distributed under the License is distributed on an
16+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17+
KIND, either express or implied. See the License for the
18+
specific language governing permissions and limitations
19+
under the License.
20+
21+
-->
22+
<!DOCTYPE module PUBLIC
23+
"-//Puppy Crawl//DTD Check Configuration 1.3//EN"
24+
"http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
25+
<module name="Checker">
26+
<property name="charset" value="UTF-8"/>
27+
<property name="severity" value="error"/>
28+
29+
<!-- Checks for whitespace -->
30+
<!-- See http://checkstyle.sf.net/config_whitespace.html -->
31+
<module name="FileTabCharacter">
32+
<property name="eachLine" value="true"/>
33+
</module>
34+
<module name="RegexpSingleline">
35+
<property name="format" value="\s+$"/>
36+
<property name="message" value="Line has trailing spaces."/>
37+
</module>
38+
<module name="RegexpMultiline">
39+
<property name="format" value="(?s:\r\n.*)"/>
40+
<property name="message" value="File has Windows (CR+LF) instead of UNIX (LF) end of line (EOL) delimiters."/>
41+
</module>
42+
<module name="SuppressWarningsFilter"/>
43+
<!-- TODO Enable maximum line length check:
44+
<module name="LineLength">
45+
<property name="max" value="120"/>
46+
<property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
47+
<property name="fileExtensions" value="java"/>
48+
</module>
49+
-->
50+
<module name="TreeWalker">
51+
<!-- TODO Enable many more checks (go about this one by one, step by step, raise separate PRs fixing and then enforcing):
52+
<module name="EqualsHashCode"/>
53+
54+
<module name="RedundantImport"/>
55+
<module name="UnusedImports"/>
56+
<module name="AvoidStarImport"/>
57+
<module name="CustomImportOrder">
58+
<property name="thirdPartyPackageRegExp" value=".*"/>
59+
<property name="sortImportsInGroupAlphabetically" value="true"/>
60+
<property name="customImportOrderRules" value="STATIC###THIRD_PARTY_PACKAGE"/>
61+
</module>
62+
63+
<module name="HiddenField">
64+
<property name="ignoreAbstractMethods" value="true" />
65+
<property name="ignoreConstructorParameter" value="true" />
66+
<property name="ignoreSetter" value="true" />
67+
<property name="setterCanReturnItsClass" value="true" />
68+
</module>
69+
<module name="EmptyStatement"/>
70+
<module name="FinalClass"/>
71+
<module name="HideUtilityClassConstructor"/>
72+
73+
< ! - - TODO Checks for Exception Handling Anti-Patterns - - >
74+
<module name="IllegalCatch"/>
75+
<module name="IllegalThrows" />
76+
<module name="MutableException"/>
77+
<module name="com.github.sevntu.checkstyle.checks.coding.AvoidHidingCauseExceptionCheck" />
78+
79+
< ! - - Checks for API conventions and the like - - >
80+
<module name="com.github.sevntu.checkstyle.checks.coding.ForbidCertainImportsCheck">
81+
<property name="packageNameRegexp" value=".*" />
82+
<property name="forbiddenImportsRegexp" value="com.google.common.base.Charsets" />
83+
<property name="forbiddenImportsExcludesRegexp" value="" />
84+
<message key="forbid.certain.imports" value="Use ''java.nio.charset.StandardCharsets'' instead of ''{0}''" />
85+
</module>
86+
87+
<module name="RegexpSinglelineJava">
88+
<property name="format" value="System\.(out)|(err)\.print(ln)?\("/>
89+
<property name="message" value="Line contains console output."/>
90+
<property name="ignoreComments" value="false" />
91+
</module>
92+
<module name="RegexpSinglelineJava">
93+
<property name="format" value="\.printStackTrace?\("/>
94+
<property name="message" value="Line contains printStacktrace()."/>
95+
<property name="ignoreComments" value="false" />
96+
</module>
97+
<module name="SuppressWarningsHolder" />
98+
<module name="OuterTypeFilename"/>
99+
<module name="IllegalTokenText">
100+
<property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
101+
<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)"/>
102+
<property name="message" value="Avoid using corresponding octal or Unicode escape."/>
103+
</module>
104+
<module name="AvoidEscapedUnicodeCharacters">
105+
<property name="allowEscapesForControlCharacters" value="true"/>
106+
<property name="allowByTailComment" value="true"/>
107+
<property name="allowNonPrintableEscapes" value="true"/>
108+
</module>
109+
<module name="OneTopLevelClass"/>
110+
<module name="NoLineWrap"/>
111+
<module name="EmptyBlock">
112+
<property name="option" value="TEXT"/>
113+
<property name="tokens" value="LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
114+
</module>
115+
<module name="NeedBraces"/>
116+
<module name="LeftCurly" />
117+
<module name="RightCurly">
118+
<property name="option" value="alone"/>
119+
<property name="tokens" value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, STATIC_INIT, INSTANCE_INIT"/>
120+
</module>
121+
<module name="WhitespaceAround">
122+
<property name="allowEmptyConstructors" value="true"/>
123+
<property name="allowEmptyMethods" value="true"/>
124+
<property name="allowEmptyTypes" value="true"/>
125+
<property name="allowEmptyLoops" value="true"/>
126+
<message key="ws.notFollowed"
127+
value="WhitespaceAround: ''{0}'' is not followed by whitespace."/>
128+
<message key="ws.notPreceded"
129+
value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
130+
</module>
131+
<module name="ParenPad" />
132+
<module name="OneStatementPerLine"/>
133+
<module name="MultipleVariableDeclarations"/>
134+
<module name="ArrayTypeStyle"/>
135+
<module name="MissingSwitchDefault"/>
136+
<module name="FallThrough"/>
137+
<module name="UpperEll"/>
138+
<module name="ModifierOrder"/>
139+
<module name="RedundantModifier"/>
140+
<module name="EmptyLineSeparator">
141+
<property name="allowNoEmptyLineBetweenFields" value="true"/>
142+
< ! - - No PACKAGE_DEF token, as we like our license header to be glue to "package" statement, to save 1 line screen space - - >
143+
<property name="tokens" value="IMPORT, CLASS_DEF, INTERFACE_DEF, ENUM_DEF, STATIC_INIT, INSTANCE_INIT, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
144+
</module>
145+
<module name="SeparatorWrap">
146+
<property name="tokens" value="DOT"/>
147+
<property name="option" value="nl"/>
148+
</module>
149+
<module name="SeparatorWrap">
150+
<property name="tokens" value="COMMA"/>
151+
<property name="option" value="EOL"/>
152+
</module>
153+
<module name="PackageName">
154+
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9_]*)*$"/>
155+
<message key="name.invalidPattern"
156+
value="Package name ''{0}'' must match pattern ''{1}''."/>
157+
</module>
158+
<module name="TypeName">
159+
<message key="name.invalidPattern"
160+
value="Type name ''{0}'' must match pattern ''{1}''."/>
161+
</module>
162+
<module name="MemberName">
163+
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
164+
<message key="name.invalidPattern"
165+
value="Member name ''{0}'' must match pattern ''{1}''."/>
166+
</module>
167+
<module name="ParameterName">
168+
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
169+
<message key="name.invalidPattern"
170+
value="Parameter name ''{0}'' must match pattern ''{1}''."/>
171+
</module>
172+
<module name="LocalVariableName">
173+
<property name="tokens" value="VARIABLE_DEF"/>
174+
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
175+
<property name="allowOneCharVarInForLoop" value="true"/>
176+
<message key="name.invalidPattern"
177+
value="Local variable name ''{0}'' must match pattern ''{1}''."/>
178+
</module>
179+
<module name="ClassTypeParameterName">
180+
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
181+
<message key="name.invalidPattern"
182+
value="Class type name ''{0}'' must match pattern ''{1}''."/>
183+
</module>
184+
<module name="MethodName">
185+
<property name="format" value="^[a-z][a-zA-Z0-9_]*$"/>
186+
<message key="name.invalidPattern"
187+
value="Method name ''{0}'' must match pattern ''{1}''."/>
188+
</module>
189+
<module name="MethodTypeParameterName">
190+
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
191+
<message key="name.invalidPattern"
192+
value="Method type name ''{0}'' must match pattern ''{1}''."/>
193+
</module>
194+
<module name="ConstantName" />
195+
<module name="NoFinalizer"/>
196+
<module name="GenericWhitespace">
197+
<message key="ws.followed"
198+
value="GenericWhitespace ''{0}'' is followed by whitespace."/>
199+
<message key="ws.preceded"
200+
value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
201+
<message key="ws.illegalFollow"
202+
value="GenericWhitespace ''{0}'' should followed by whitespace."/>
203+
<message key="ws.notPreceded"
204+
value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
205+
</module>
206+
<module name="Indentation">
207+
<property name="basicOffset" value="4"/>
208+
<property name="braceAdjustment" value="0"/>
209+
<property name="caseIndent" value="4"/>
210+
<property name="throwsIndent" value="4"/>
211+
<property name="lineWrappingIndentation" value="4"/>
212+
<property name="arrayInitIndent" value="4"/>
213+
</module>
214+
<module name="AbbreviationAsWordInName">
215+
<property name="ignoreFinal" value="false"/>
216+
<property name="allowedAbbreviationLength" value="4"/>
217+
</module>
218+
<module name="OverloadMethodsDeclarationOrder"/>
219+
<module name="VariableDeclarationUsageDistance"/>
220+
221+
<module name="MethodParamPad"/>
222+
<module name="OperatorWrap">
223+
<property name="option" value="NL"/>
224+
<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 "/>
225+
</module>
226+
<module name="AnnotationLocation">
227+
<property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/>
228+
</module>
229+
<module name="AnnotationLocation">
230+
<property name="tokens" value="VARIABLE_DEF"/>
231+
<property name="allowSamelineMultipleAnnotations" value="true"/>
232+
</module>
233+
234+
<module name="MethodName">
235+
<property name="format" value="^[a-z][a-zA-Z0-9_]*$"/>
236+
<message key="name.invalidPattern"
237+
value="Method name ''{0}'' must match pattern ''{1}''."/>
238+
</module>
239+
240+
<! - - Enable some JavaDoc validation (requires quite a lot of manual clean up work; not a top priority for initial Checkstyle adoption - ->
241+
<module name="JavadocTagContinuationIndentation"/>
242+
<module name="SummaryJavadocCheck">
243+
<property name="forbiddenSummaryFragments" value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
244+
</module>
245+
<module name="JavadocStyle">
246+
< ! - - Do NOT 'scope' this one; any JavaDoc (public/protected/private) IFF present, should be style checked. - - >
247+
<property name="checkEmptyJavadoc" value="true" />
248+
<property name="tokens" value="ANNOTATION_DEF, ANNOTATION_FIELD_DEF, CLASS_DEF, CTOR_DEF, ENUM_CONSTANT_DEF, ENUM_DEF, INTERFACE_DEF, METHOD_DEF, VARIABLE_DEF"/>
249+
</module>
250+
<module name="SingleLineJavadoc"/>
251+
<module name="NonEmptyAtclauseDescription"/>
252+
<module name="AtclauseOrder">
253+
<property name="tagOrder" value="@param, @return, @throws, @deprecated"/>
254+
<property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
255+
</module>
256+
< ! - - TODO Enable proper JavaDoc paragraphs (requires removing /** from all license headers) - - >
257+
<module name="JavadocParagraph">
258+
<property name="allowNewlineParagraph" value="false"/>
259+
</module>
260+
-->
261+
</module>
262+
<!-- NB, PS: This entire custom Checkstyle configuration originally came from (EPL'd)
263+
https://github.com/opendaylight/odlparent/blob/master/checkstyle/src/main/resources/odl_checks.xml
264+
(for which it was first created by Michael Vorburger.ch while he worked on that community in 2016-2018).
265+
Michael in Jan 2020 copy/pasted this into Apache Fineract (where he has been actively contributing since
266+
ca. 2010 when it was still Mifos), where it was then independantly maintained by Apache contributors. -->
267+
</module>

0 commit comments

Comments
 (0)