Skip to content

Commit 49a41de

Browse files
TheSnoozerTheSnoozer
authored
Merge pull request #447 from snago/upgrade-checkstyle
Upgrade Checkstyle
2 parents c4a377d + e04af9c commit 49a41de

11 files changed

Lines changed: 92 additions & 56 deletions

File tree

.github/.checkstyle/google_checks_checkstyle_8.2.xml renamed to .github/.checkstyle/google_checks_checkstyle_8.25.xml

Lines changed: 75 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<?xml version="1.0"?>
22
<!DOCTYPE module PUBLIC
3-
"-//Puppy Crawl//DTD Check Configuration 1.3//EN"
4-
"http://checkstyle.sourceforge.net/dtds/configuration_1_3.dtd">
3+
"-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
4+
"https://checkstyle.org/dtds/configuration_1_3.dtd">
55

66
<!--
77
The following content was obtained from:
@@ -12,7 +12,7 @@
1212
- <module name="Header"> added
1313
1414
Checkstyle configuration that checks the Google coding conventions from Google Java Style
15-
that can be found at https://google.github.io/styleguide/javaguide.html.
15+
that can be found at https://google.github.io/styleguide/javaguide.html
1616
1717
Checkstyle is very configurable. Be sure to read the documentation at
1818
http://checkstyle.sf.net (or in your downloaded distribution).
@@ -42,55 +42,70 @@
4242
<property name="severity" value="warning"/>
4343

4444
<property name="fileExtensions" value="java, properties, xml"/>
45+
<!-- Excludes all 'module-info.java' files -->
46+
<!-- See https://checkstyle.org/config_filefilters.html -->
47+
<module name="BeforeExecutionExclusionFileFilter">
48+
<property name="fileNamePattern" value="module\-info\.java$"/>
49+
</module>
4550
<!-- Checks for whitespace -->
4651
<!-- See http://checkstyle.sf.net/config_whitespace.html -->
47-
<module name="FileTabCharacter">
48-
<property name="eachLine" value="true"/>
49-
</module>
52+
<module name="FileTabCharacter">
53+
<property name="eachLine" value="true"/>
54+
</module>
55+
56+
<module name="LineLength">
57+
<property name="fileExtensions" value="java"/>
58+
<property name="max" value="100"/>
59+
<property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
60+
</module>
5061

5162
<module name="TreeWalker">
5263
<module name="OuterTypeFilename"/>
5364
<module name="IllegalTokenText">
5465
<property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
55-
<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)"/>
56-
<property name="message" value="Consider using special escape sequence instead of octal value or Unicode escaped value."/>
66+
<property name="format"
67+
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)"/>
68+
<property name="message"
69+
value="Consider using special escape sequence instead of octal value or Unicode escaped value."/>
5770
</module>
5871
<module name="AvoidEscapedUnicodeCharacters">
5972
<property name="allowEscapesForControlCharacters" value="true"/>
6073
<property name="allowByTailComment" value="true"/>
6174
<property name="allowNonPrintableEscapes" value="true"/>
6275
</module>
63-
<module name="LineLength">
64-
<property name="max" value="100"/>
65-
<property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
66-
</module>
6776
<module name="AvoidStarImport"/>
6877
<module name="OneTopLevelClass"/>
6978
<module name="NoLineWrap"/>
7079
<module name="EmptyBlock">
7180
<property name="option" value="TEXT"/>
72-
<property name="tokens" value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
81+
<property name="tokens"
82+
value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
7383
</module>
7484
<module name="NeedBraces"/>
7585
<module name="LeftCurly"/>
7686
<module name="RightCurly">
7787
<property name="id" value="RightCurlySame"/>
78-
<property name="tokens" value="LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_DO"/>
88+
<property name="tokens"
89+
value="LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE,
90+
LITERAL_DO"/>
7991
</module>
8092
<module name="RightCurly">
8193
<property name="id" value="RightCurlyAlone"/>
8294
<property name="option" value="alone"/>
83-
<property name="tokens" value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, STATIC_INIT, INSTANCE_INIT"/>
95+
<property name="tokens"
96+
value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, STATIC_INIT,
97+
INSTANCE_INIT"/>
8498
</module>
8599
<module name="WhitespaceAround">
86100
<property name="allowEmptyConstructors" value="true"/>
101+
<property name="allowEmptyLambdas" value="true"/>
87102
<property name="allowEmptyMethods" value="true"/>
88103
<property name="allowEmptyTypes" value="true"/>
89104
<property name="allowEmptyLoops" value="true"/>
90105
<message key="ws.notFollowed"
91-
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)"/>
92-
<message key="ws.notPreceded"
93-
value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
106+
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)"/>
107+
<message key="ws.notPreceded"
108+
value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
94109
</module>
95110
<module name="OneStatementPerLine"/>
96111
<module name="MultipleVariableDeclarations"/>
@@ -132,58 +147,63 @@
132147
<module name="PackageName">
133148
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
134149
<message key="name.invalidPattern"
135-
value="Package name ''{0}'' must match pattern ''{1}''."/>
150+
value="Package name ''{0}'' must match pattern ''{1}''."/>
136151
</module>
137152
<module name="TypeName">
138153
<message key="name.invalidPattern"
139-
value="Type name ''{0}'' must match pattern ''{1}''."/>
154+
value="Type name ''{0}'' must match pattern ''{1}''."/>
140155
</module>
141156
<module name="MemberName">
142157
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
143158
<message key="name.invalidPattern"
144-
value="Member name ''{0}'' must match pattern ''{1}''."/>
159+
value="Member name ''{0}'' must match pattern ''{1}''."/>
145160
</module>
146161
<module name="ParameterName">
147162
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
148163
<message key="name.invalidPattern"
149-
value="Parameter name ''{0}'' must match pattern ''{1}''."/>
164+
value="Parameter name ''{0}'' must match pattern ''{1}''."/>
165+
</module>
166+
<module name="LambdaParameterName">
167+
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
168+
<message key="name.invalidPattern"
169+
value="Lambda parameter name ''{0}'' must match pattern ''{1}''."/>
150170
</module>
151171
<module name="CatchParameterName">
152172
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
153173
<message key="name.invalidPattern"
154-
value="Catch parameter name ''{0}'' must match pattern ''{1}''."/>
174+
value="Catch parameter name ''{0}'' must match pattern ''{1}''."/>
155175
</module>
156176
<module name="LocalVariableName">
157177
<property name="tokens" value="VARIABLE_DEF"/>
158178
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
159179
<message key="name.invalidPattern"
160-
value="Local variable name ''{0}'' must match pattern ''{1}''."/>
180+
value="Local variable name ''{0}'' must match pattern ''{1}''."/>
161181
</module>
162182
<module name="ClassTypeParameterName">
163183
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
164184
<message key="name.invalidPattern"
165-
value="Class type name ''{0}'' must match pattern ''{1}''."/>
185+
value="Class type name ''{0}'' must match pattern ''{1}''."/>
166186
</module>
167187
<module name="MethodTypeParameterName">
168188
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
169189
<message key="name.invalidPattern"
170-
value="Method type name ''{0}'' must match pattern ''{1}''."/>
190+
value="Method type name ''{0}'' must match pattern ''{1}''."/>
171191
</module>
172192
<module name="InterfaceTypeParameterName">
173193
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
174194
<message key="name.invalidPattern"
175-
value="Interface type name ''{0}'' must match pattern ''{1}''."/>
195+
value="Interface type name ''{0}'' must match pattern ''{1}''."/>
176196
</module>
177197
<module name="NoFinalizer"/>
178198
<module name="GenericWhitespace">
179199
<message key="ws.followed"
180-
value="GenericWhitespace ''{0}'' is followed by whitespace."/>
181-
<message key="ws.preceded"
182-
value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
183-
<message key="ws.illegalFollow"
184-
value="GenericWhitespace ''{0}'' should followed by whitespace."/>
185-
<message key="ws.notPreceded"
186-
value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
200+
value="GenericWhitespace ''{0}'' is followed by whitespace."/>
201+
<message key="ws.preceded"
202+
value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
203+
<message key="ws.illegalFollow"
204+
value="GenericWhitespace ''{0}'' should followed by whitespace."/>
205+
<message key="ws.notPreceded"
206+
value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
187207
</module>
188208
<module name="Indentation">
189209
<property name="basicOffset" value="2"/>
@@ -205,43 +225,58 @@
205225
<property name="customImportOrderRules" value="STATIC###THIRD_PARTY_PACKAGE"/>
206226
</module>
207227
<module name="MethodParamPad"/>
228+
<module name="NoWhitespaceBefore">
229+
<property name="tokens"
230+
value="COMMA, SEMI, POST_INC, POST_DEC, DOT, ELLIPSIS, METHOD_REF"/>
231+
<property name="allowLineBreaks" value="true"/>
232+
</module>
208233
<module name="ParenPad"/>
209234
<module name="OperatorWrap">
210235
<property name="option" value="NL"/>
211-
<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 "/>
236+
<property name="tokens"
237+
value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR,
238+
LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR, METHOD_REF "/>
212239
</module>
213240
<module name="AnnotationLocation">
214241
<property name="id" value="AnnotationLocationMostCases"/>
215-
<property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/>
242+
<property name="tokens"
243+
value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/>
216244
</module>
217245
<module name="AnnotationLocation">
218246
<property name="id" value="AnnotationLocationVariables"/>
219247
<property name="tokens" value="VARIABLE_DEF"/>
220248
<property name="allowSamelineMultipleAnnotations" value="true"/>
221249
</module>
222250
<module name="NonEmptyAtclauseDescription"/>
251+
<module name="InvalidJavadocPosition"/>
223252
<module name="JavadocTagContinuationIndentation"/>
224253
<module name="SummaryJavadoc">
225-
<property name="forbiddenSummaryFragments" value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
254+
<property name="forbiddenSummaryFragments"
255+
value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
226256
</module>
227257
<module name="JavadocParagraph"/>
228258
<module name="AtclauseOrder">
229259
<property name="tagOrder" value="@param, @return, @throws, @deprecated"/>
230-
<property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
260+
<property name="target"
261+
value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
231262
</module>
232263
<module name="JavadocMethod">
233264
<property name="scope" value="public"/>
234265
<property name="allowMissingParamTags" value="true"/>
235266
<property name="allowMissingThrowsTags" value="true"/>
236267
<property name="allowMissingReturnTag" value="true"/>
237-
<property name="minLineCount" value="2"/>
238268
<property name="allowedAnnotations" value="Override, Test"/>
239269
<property name="allowThrowsTagsForSubclasses" value="true"/>
240270
</module>
271+
<module name="MissingJavadocMethod">
272+
<property name="scope" value="public"/>
273+
<property name="minLineCount" value="2"/>
274+
<property name="allowedAnnotations" value="Override, Test"/>
275+
</module>
241276
<module name="MethodName">
242277
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
243278
<message key="name.invalidPattern"
244-
value="Method name ''{0}'' must match pattern ''{1}''."/>
279+
value="Method name ''{0}'' must match pattern ''{1}''."/>
245280
</module>
246281
<module name="SingleLineJavadoc">
247282
<property name="ignoreInlineTags" value="false"/>

‎.travis.yml‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,10 @@ matrix:
3636
env: CUSTOM_MVN_VERION="3.6.0"
3737
- stage: checkstyle
3838
jdk: oraclejdk9
39-
script: mvn clean verify -Pcheckstyle -Dcheckstyle.version=8.2 -Dmaven.test.skip=true -B
40-
env: CHECKSTYLE=8.2
39+
script: mvn clean verify -Pcheckstyle -Dmaven.test.skip=true -B
4140
- stage: checkstyle
4241
jdk: oraclejdk8
4342
script: mvn clean verify -Pcheckstyle -Dmaven.test.skip=true -B
44-
env: CHECKSTYLE=8.2
4543
- stage: coveralls
4644
jdk: oraclejdk8
4745
env:

‎core/src/main/java/pl/project13/core/log/FormattingTuple.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
package pl.project13.core.log;
1919

20-
/**
20+
/*
2121
* Copyright (c) 2004-2011 QOS.ch
2222
* All rights reserved.
2323
*
@@ -90,4 +90,4 @@ public Object[] getArgArray() {
9090
public Throwable getThrowable() {
9191
return throwable;
9292
}
93-
}
93+
}

‎core/src/main/java/pl/project13/core/log/LoggerBridge.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ public interface LoggerBridge {
4242
Which is MIT licensed and thus compatible with this project's license.
4343
*/
4444

45-
/**
45+
/*
4646
* Copyright (c) 2004-2011 QOS.ch
4747
* All rights reserved.
4848
*

‎core/src/main/java/pl/project13/core/log/MessageFormatter.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
package pl.project13.core.log;
1919

20-
/**
20+
/*
2121
* Copyright (c) 2004-2011 QOS.ch
2222
* All rights reserved.
2323
*
@@ -434,4 +434,4 @@ private static void doubleArrayAppend(StringBuilder sbuf, double[] a) {
434434
}
435435
sbuf.append(']');
436436
}
437-
}
437+
}

‎maven/src/main/java/pl/project13/maven/git/GitDirLocator.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ public File lookupGitDirectory(@Nonnull File manuallyConfiguredDir) {
5555
return gitDirLinkPath;
5656
}
5757

58-
/**
58+
/*
5959
* FIXME: I think we should fail here because a manual path was set and it was not found
6060
* but I'm leaving it falling back to searching for the git path because that is the current
6161
* behaviour - Unluckypixie.

‎maven/src/main/java/pl/project13/maven/git/ReplacementProperty.java‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,8 @@ public class ReplacementProperty {
7575
@Parameter
7676
private List<TransformationRule> transformationRules = new ArrayList<>();
7777

78-
public ReplacementProperty(){}
78+
public ReplacementProperty() {
79+
}
7980

8081
public ReplacementProperty(String property, String propertyOutputSuffix, String token, String value, boolean regex, List<TransformationRule> transformationRules) {
8182
this.property = property;

‎maven/src/main/java/pl/project13/maven/git/TransformationRule.java‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,8 @@ protected String perform(String input) {
7171
protected abstract String perform(String input);
7272
}
7373

74-
public TransformationRule(){}
74+
public TransformationRule() {
75+
}
7576

7677
public TransformationRule(String apply, String action) {
7778
this(ApplyEnum.valueOf(apply), ActionEnum.valueOf(action));

‎maven/src/main/java/pl/project13/maven/validation/ValidationProperty.java‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,8 @@ public class ValidationProperty {
2323
private String value;
2424
private String shouldMatchTo;
2525

26-
public ValidationProperty() {}
26+
public ValidationProperty() {
27+
}
2728

2829
ValidationProperty(String name, String value, String shouldMatchTo) {
2930
this.name = name;

‎maven/src/test/java/pl/project13/maven/git/PropertiesReplacerTest.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ public void runTransformationTestHelper(String input, String regex, Transformati
200200
transformationRules.add(new TransformationRule(applyRule, actionRule));
201201

202202
List<ReplacementProperty> replacementProperties = new ArrayList<>();
203-
replacementProperties.add(new ReplacementProperty(null, null, regex , "-", true, transformationRules));
203+
replacementProperties.add(new ReplacementProperty(null, null, regex, "-", true, transformationRules));
204204

205205
propertiesReplacer.performReplacement(actualProperties, replacementProperties);
206206

0 commit comments

Comments
 (0)