Skip to content

Commit c99df8f

Browse files
justinleetmmiklavc
justinleet
authored and
mmiklavc
committed
METRON-746: Build Custom Checkstyle and IDE formatting settings (justinleet via mmiklavc) closes #577 
1 parent 7e03753 commit c99df8f

File tree

2 files changed

+281
-0
lines changed

2 files changed

+281
-0
lines changed

‎checkstyle.xml

Lines changed: 235 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,235 @@
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+
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(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="Consider using special escape sequence instead of octal value or Unicode escaped value."/>
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="AvoidStarImport"/>
47+
<module name="OneTopLevelClass"/>
48+
<module name="NoLineWrap"/>
49+
<module name="EmptyBlock">
50+
<property name="option" value="TEXT"/>
51+
<property name="tokens" value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
52+
</module>
53+
<module name="NeedBraces"/>
54+
<module name="LeftCurly">
55+
<property name="maxLineLength" value="100"/>
56+
</module>
57+
<module name="RightCurly">
58+
<property name="id" value="RightCurlySame"/>
59+
<property name="tokens" value="LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_DO"/>
60+
</module>
61+
<module name="RightCurly">
62+
<property name="id" value="RightCurlyAlone"/>
63+
<property name="option" value="alone"/>
64+
<property name="tokens" value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, STATIC_INIT, INSTANCE_INIT"/>
65+
</module>
66+
<module name="WhitespaceAround">
67+
<property name="allowEmptyConstructors" value="true"/>
68+
<property name="allowEmptyMethods" value="true"/>
69+
<property name="allowEmptyTypes" value="true"/>
70+
<property name="allowEmptyLoops" value="true"/>
71+
<message key="ws.notFollowed"
72+
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)"/>
73+
<message key="ws.notPreceded"
74+
value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
75+
</module>
76+
<module name="OneStatementPerLine"/>
77+
<module name="MultipleVariableDeclarations"/>
78+
<module name="ArrayTypeStyle"/>
79+
<module name="MissingSwitchDefault"/>
80+
<module name="FallThrough"/>
81+
<module name="UpperEll"/>
82+
<module name="ModifierOrder"/>
83+
<module name="EmptyLineSeparator">
84+
<property name="allowNoEmptyLineBetweenFields" value="true"/>
85+
</module>
86+
<module name="SeparatorWrap">
87+
<property name="id" value="SeparatorWrapDot"/>
88+
<property name="tokens" value="DOT"/>
89+
<property name="option" value="nl"/>
90+
</module>
91+
<module name="SeparatorWrap">
92+
<property name="id" value="SeparatorWrapComma"/>
93+
<property name="tokens" value="COMMA"/>
94+
<property name="option" value="EOL"/>
95+
</module>
96+
<module name="SeparatorWrap">
97+
<!-- ELLIPSIS is EOL until https://github.com/google/styleguide/issues/258 -->
98+
<property name="id" value="SeparatorWrapEllipsis"/>
99+
<property name="tokens" value="ELLIPSIS"/>
100+
<property name="option" value="EOL"/>
101+
</module>
102+
<module name="SeparatorWrap">
103+
<!-- ARRAY_DECLARATOR is EOL until https://github.com/google/styleguide/issues/259 -->
104+
<property name="id" value="SeparatorWrapArrayDeclarator"/>
105+
<property name="tokens" value="ARRAY_DECLARATOR"/>
106+
<property name="option" value="EOL"/>
107+
</module>
108+
<module name="SeparatorWrap">
109+
<property name="id" value="SeparatorWrapMethodRef"/>
110+
<property name="tokens" value="METHOD_REF"/>
111+
<property name="option" value="nl"/>
112+
</module>
113+
<module name="PackageName">
114+
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
115+
<message key="name.invalidPattern"
116+
value="Package name ''{0}'' must match pattern ''{1}''."/>
117+
</module>
118+
<module name="TypeName">
119+
<message key="name.invalidPattern"
120+
value="Type name ''{0}'' must match pattern ''{1}''."/>
121+
</module>
122+
<module name="MemberName">
123+
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
124+
<message key="name.invalidPattern"
125+
value="Member name ''{0}'' must match pattern ''{1}''."/>
126+
</module>
127+
<module name="ParameterName">
128+
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
129+
<message key="name.invalidPattern"
130+
value="Parameter name ''{0}'' must match pattern ''{1}''."/>
131+
</module>
132+
<module name="CatchParameterName">
133+
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
134+
<message key="name.invalidPattern"
135+
value="Catch parameter name ''{0}'' must match pattern ''{1}''."/>
136+
</module>
137+
<module name="LocalVariableName">
138+
<property name="tokens" value="VARIABLE_DEF"/>
139+
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
140+
<message key="name.invalidPattern"
141+
value="Local variable name ''{0}'' must match pattern ''{1}''."/>
142+
</module>
143+
<module name="ClassTypeParameterName">
144+
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
145+
<message key="name.invalidPattern"
146+
value="Class type name ''{0}'' must match pattern ''{1}''."/>
147+
</module>
148+
<module name="MethodTypeParameterName">
149+
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
150+
<message key="name.invalidPattern"
151+
value="Method type name ''{0}'' must match pattern ''{1}''."/>
152+
</module>
153+
<module name="InterfaceTypeParameterName">
154+
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
155+
<message key="name.invalidPattern"
156+
value="Interface type name ''{0}'' must match pattern ''{1}''."/>
157+
</module>
158+
<module name="NoFinalizer"/>
159+
<module name="GenericWhitespace">
160+
<message key="ws.followed"
161+
value="GenericWhitespace ''{0}'' is followed by whitespace."/>
162+
<message key="ws.preceded"
163+
value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
164+
<message key="ws.illegalFollow"
165+
value="GenericWhitespace ''{0}'' should followed by whitespace."/>
166+
<message key="ws.notPreceded"
167+
value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
168+
</module>
169+
<module name="Indentation">
170+
<property name="basicOffset" value="2"/>
171+
<property name="braceAdjustment" value="0"/>
172+
<property name="caseIndent" value="2"/>
173+
<property name="throwsIndent" value="4"/>
174+
<property name="lineWrappingIndentation" value="4"/>
175+
<property name="arrayInitIndent" value="2"/>
176+
</module>
177+
<module name="AbbreviationAsWordInName">
178+
<property name="ignoreFinal" value="false"/>
179+
<property name="allowedAbbreviationLength" value="1"/>
180+
</module>
181+
<module name="OverloadMethodsDeclarationOrder"/>
182+
<module name="VariableDeclarationUsageDistance"/>
183+
<module name="CustomImportOrder">
184+
<property name="sortImportsInGroupAlphabetically" value="true"/>
185+
<property name="separateLineBetweenGroups" value="true"/>
186+
<property name="customImportOrderRules" value="STATIC###THIRD_PARTY_PACKAGE"/>
187+
</module>
188+
<module name="MethodParamPad"/>
189+
<module name="ParenPad"/>
190+
<module name="OperatorWrap">
191+
<property name="option" value="NL"/>
192+
<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 "/>
193+
</module>
194+
<module name="AnnotationLocation">
195+
<property name="id" value="AnnotationLocationMostCases"/>
196+
<property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/>
197+
</module>
198+
<module name="AnnotationLocation">
199+
<property name="id" value="AnnotationLocationVariables"/>
200+
<property name="tokens" value="VARIABLE_DEF"/>
201+
<property name="allowSamelineMultipleAnnotations" value="true"/>
202+
</module>
203+
<module name="NonEmptyAtclauseDescription"/>
204+
<module name="JavadocTagContinuationIndentation"/>
205+
<module name="SummaryJavadoc">
206+
<property name="forbiddenSummaryFragments" value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
207+
</module>
208+
<module name="JavadocParagraph"/>
209+
<module name="AtclauseOrder">
210+
<property name="tagOrder" value="@param, @return, @throws, @deprecated"/>
211+
<property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
212+
</module>
213+
<module name="JavadocMethod">
214+
<property name="scope" value="public"/>
215+
<property name="allowMissingParamTags" value="true"/>
216+
<property name="allowMissingThrowsTags" value="true"/>
217+
<property name="allowMissingReturnTag" value="true"/>
218+
<property name="minLineCount" value="2"/>
219+
<property name="allowedAnnotations" value="Override, Test"/>
220+
<property name="allowThrowsTagsForSubclasses" value="true"/>
221+
</module>
222+
<module name="MethodName">
223+
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
224+
<message key="name.invalidPattern"
225+
value="Method name ''{0}'' must match pattern ''{1}''."/>
226+
</module>
227+
<module name="SingleLineJavadoc">
228+
<property name="ignoreInlineTags" value="false"/>
229+
</module>
230+
<module name="EmptyCatchBlock">
231+
<property name="exceptionVariableName" value="expected"/>
232+
</module>
233+
<module name="CommentsIndentation"/>
234+
</module>
235+
</module>

‎pom.xml

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,7 @@
112112
<global_kryo_version>3.0.3</global_kryo_version>
113113
<global_kryo_serializers_version>0.38</global_kryo_serializers_version>
114114
<global_reflections_version>0.9.10</global_reflections_version>
115+
<global_checkstyle_version>8.0</global_checkstyle_version>
115116
<argLine></argLine>
116117
</properties>
117118

@@ -202,6 +203,18 @@
202203
<tarLongFileMode>posix</tarLongFileMode>
203204
</configuration>
204205
</plugin>
206+
<plugin>
207+
<groupId>org.apache.maven.plugins</groupId>
208+
<artifactId>maven-checkstyle-plugin</artifactId>
209+
<version>2.17</version>
210+
<dependencies>
211+
<dependency>
212+
<groupId>com.puppycrawl.tools</groupId>
213+
<artifactId>checkstyle</artifactId>
214+
<version>${global_checkstyle_version}</version>
215+
</dependency>
216+
</dependencies>
217+
</plugin>
205218
</plugins>
206219
</pluginManagement>
207220
<plugins>
@@ -330,6 +343,9 @@
330343
<exclude>dist/*.svg</exclude>
331344

332345
<exclude>e2e/*.js.map</exclude>
346+
<!-- Checkstyle is LGPL. We derive ours from their base, but don't ship it, so it's fine use.
347+
Since it is derived, we shouldn't get an Apache header -->
348+
<exclude>checkstyle.xml</exclude>
333349
</excludes>
334350
</configuration>
335351
</plugin>
@@ -356,6 +372,32 @@
356372
</execution>
357373
</executions>
358374
</plugin>
375+
<plugin>
376+
<groupId>org.apache.maven.plugins</groupId>
377+
<artifactId>maven-checkstyle-plugin</artifactId>
378+
<version>2.17</version>
379+
<dependencies>
380+
<dependency>
381+
<groupId>com.puppycrawl.tools</groupId>
382+
<artifactId>checkstyle</artifactId>
383+
<version>${global_checkstyle_version}</version>
384+
</dependency>
385+
</dependencies>
386+
<configuration>
387+
<configLocation>checkstyle.xml</configLocation>
388+
<excludes>**/generated/**/*</excludes>
389+
<logViolationsToConsole>false</logViolationsToConsole>
390+
</configuration>
391+
<executions>
392+
<execution>
393+
<id>verify</id>
394+
<phase>verify</phase>
395+
<goals>
396+
<goal>check</goal>
397+
</goals>
398+
</execution>
399+
</executions>
400+
</plugin>
359401
</plugins>
360402
</build>
361403

@@ -422,6 +464,10 @@
422464
<groupId>org.apache.maven.plugins</groupId>
423465
<artifactId>maven-checkstyle-plugin</artifactId>
424466
<version>2.17</version>
467+
<configuration>
468+
<configLocation>checkstyle.xml</configLocation>
469+
<excludes>**/generated/**/*</excludes>
470+
</configuration>
425471
<reportSets>
426472
<reportSet>
427473
<reports>

0 commit comments

Comments
 (0)